Struct gstreamer::caps::Caps

source ·

pub struct Caps { /* private fields */ }

Implementations§

source §

pub fn builder_full_with_features( features: CapsFeatures ) -> BuilderFull<SomeFeatures>

source

pub fn builder_full_with_any_features() -> BuilderFull<AnyFeatures>

source

pub fn new_empty() -> Self

Creates a new Caps that is empty. That is, the returned Caps contains no media formats. The Caps is guaranteed to be writable.

§Returns

the new Caps

source

pub fn new_any() -> Self

Creates a new Caps that indicates that it is compatible with any media format.

§Returns

the new Caps

source

pub fn new_empty_simple(name: impl IntoGStr) -> Self

Creates a new Caps that contains one Structure with name media_type.

§`media_type`

the media type of the structure

§Returns

the new Caps

source

pub fn fixate(&mut self)

Modifies the given self into a representation with only fixed values. First the caps will be truncated and then the first structure will be fixated with gst_structure_fixate().

This function takes ownership of self and will call gst_caps_make_writable() on it so you must not use self afterwards unless you keep an additional reference to it with gst_caps_ref().

Note that it is not guaranteed that the returned caps have exactly one structure. If self are empty caps then the returned caps will be the empty too and contain no structure at all.

Calling this function with ANY caps is not allowed.

§Returns

the fixated caps

source

pub fn merge(&mut self, other: Self)

Appends the structures contained in caps2 to self if they are not yet expressed by self. The structures in caps2 are not copied – they are transferred to a writable copy of self, and then caps2 is freed. If either caps is ANY, the resulting caps will be ANY.

§`caps2`

the Caps to merge in

§Returns

the merged caps.

source

pub fn merge_structure(&mut self, structure: Structure)

Appends structure to self if it is not already expressed by self.

§`structure`

the Structure to merge

§Returns

the merged caps.

source

pub fn merge_structure_full( &mut self, structure: Structure, features: Option<CapsFeatures> )

Appends structure with features to self if its not already expressed by self.

§`structure`

the Structure to merge

§`features`

the CapsFeatures to merge

§Returns

the merged caps.

source

pub fn normalize(&mut self)

Returns a Caps that represents the same set of formats as self, but contains no lists. Each list is expanded into separate Structure.

This function takes ownership of self and will call gst_caps_make_writable() on it so you must not use self afterwards unless you keep an additional reference to it with gst_caps_ref().

§Returns

the normalized Caps

source

pub fn simplify(&mut self)

Converts the given self into a representation that represents the same set of formats, but in a simpler form. Component structures that are identical are merged. Component structures that have values that can be merged are also merged.

This function takes ownership of self and will call gst_caps_make_writable() on it if necessary, so you must not use self afterwards unless you keep an additional reference to it with gst_caps_ref().

This method does not preserve the original order of self.

§Returns

The simplified caps.

source

pub fn truncate(&mut self)

Discards all but the first structure from self. Useful when fixating.

This function takes ownership of self and will call gst_caps_make_writable() on it if necessary, so you must not use self afterwards unless you keep an additional reference to it with gst_caps_ref().

Note that it is not guaranteed that the returned caps have exactly one structure. If self is any or empty caps then the returned caps will be the same and contain no structure at all.