Struct ElementProperties

pub struct ElementProperties(/* private fields */);

Wrapper around gst::Structure for element-properties property of EncodingProfile.

Examples

ElementProperties::builder_general()
    .field("threads", 16)
    .build();

ElementProperties::builder_map()
    .item(
        ElementPropertiesMapItem::builder("vp8enc")
            .field("max-quantizer", 17)
            .field("buffer-size", 20000)
            .field("threads", 16)
            .build(),
    )
    .build();

Implementations

impl ElementProperties

pub fn builder_general() -> ElementPropertiesGeneralBuilder

Creates an ElementProperties builder that build into something similar to the following:

[element-properties, boolean-prop=true, string-prop=“hi”]

pub fn builder_map() -> ElementPropertiesMapBuilder

Creates an ElementProperties builder that build into something similar to the following:

element-properties-map, map = { [openh264enc, gop-size=32, ], [x264enc, key-int-max=32, tune=zerolatency], }

pub fn is_general(&self) -> bool

Returns true if self is built with ElementPropertiesGeneralBuilder.

pub fn is_map(&self) -> bool

Returns true if self is built with ElementPropertiesMapBuilder.

pub fn map(&self) -> Option<Vec<ElementPropertiesMapItem>>

Returns the inner vec of ElementPropertiesMapItem if self is_map() or None if self is_general().

pub fn into_inner(self) -> Structure

Methods from Deref<Target = StructureRef>

pub fn as_ptr(&self) -> *const GstStructure

pub fn as_mut_ptr(&self) -> *mut GstStructure

pub fn get<'a, T>( &'a self, name: impl IntoGStr, ) -> Result<T, GetError<<<T as FromValue<'a>>::Checker as ValueTypeChecker>::Error>>

where T: FromValue<'a>,

pub fn get_by_id<'a, T>( &'a self, name: impl AsRef<IdStr>, ) -> Result<T, GetError<<<T as FromValue<'a>>::Checker as ValueTypeChecker>::Error>>

where T: FromValue<'a>,

pub fn get_optional<'a, T>( &'a self, name: impl IntoGStr, ) -> Result<Option<T>, GetError<<<T as FromValue<'a>>::Checker as ValueTypeChecker>::Error>>

where T: FromValue<'a>,

pub fn get_optional_by_id<'a, T>( &'a self, name: impl AsRef<IdStr>, ) -> Result<Option<T>, GetError<<<T as FromValue<'a>>::Checker as ValueTypeChecker>::Error>>

where T: FromValue<'a>,

pub fn value( &self, name: impl IntoGStr, ) -> Result<&SendValue, GetError<Infallible>>

pub fn value_by_id( &self, name: impl AsRef<IdStr>, ) -> Result<&SendValue, GetError<Infallible>>

pub fn get_by_quark<'a, T>( &'a self, name: Quark, ) -> Result<T, GetError<<<T as FromValue<'a>>::Checker as ValueTypeChecker>::Error>>

where T: FromValue<'a>,

👎Deprecated: use get_by_id() instead

pub fn get_optional_by_quark<'a, T>( &'a self, name: Quark, ) -> Result<Option<T>, GetError<<<T as FromValue<'a>>::Checker as ValueTypeChecker>::Error>>

where T: FromValue<'a>,

👎Deprecated: use get_optional_by_id() instead

pub fn value_by_quark( &self, name: Quark, ) -> Result<&SendValue, GetError<Infallible>>

👎Deprecated: use value_by_id() instead

pub fn name(&self) -> &GStr

pub fn name_id(&self) -> &IdStr

pub fn name_quark(&self) -> Quark

👎Deprecated: use name() instead, or name_id() with feature v1_26

pub fn has_name(&self, name: &str) -> bool

pub fn has_field(&self, field: impl IntoGStr) -> bool

pub fn has_field_by_id(&self, field: impl AsRef<IdStr>) -> bool

pub fn has_field_with_type(&self, field: impl IntoGStr, type_: Type) -> bool

pub fn has_field_with_type_by_id( &self, field: impl AsRef<IdStr>, type_: Type, ) -> bool

pub fn has_field_by_quark(&self, field: Quark) -> bool

👎Deprecated: use has_field_by_id()

pub fn has_field_with_type_by_quark(&self, field: Quark, type_: Type) -> bool

👎Deprecated: use has_field_with_type_by_id()

pub fn fields(&self) -> FieldIterator<'_>

pub fn iter(&self) -> Iter<'_>

pub fn field_ids(&self) -> FieldIdIterator<'_>

pub fn id_iter(&self) -> IdIter<'_>

pub fn nth_field_name(&self, idx: usize) -> Option<&GStr>

pub fn nth_field_by_id(&self, idx: usize) -> Option<&IdStr>

pub fn n_fields(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn can_intersect(&self, other: &StructureRef) -> bool

pub fn intersect(&self, other: &StructureRef) -> Option<Structure>

pub fn is_subset(&self, superset: &StructureRef) -> bool

pub fn serialize(&self, flags: SerializeFlags) -> GString

pub fn serialize_strict( &self, flags: SerializeFlags, ) -> Result<GString, BoolError>

pub fn foreach<F>(&self, func: F) -> bool

where F: FnMut(Quark, &Value) -> ControlFlow<()>,

👎Deprecated: Use iter() instead, or id_iter() with feature v1_26

Trait Implementations

impl Clone for ElementProperties

fn clone(&self) -> ElementProperties

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ElementProperties

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ElementProperties

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ElementProperties

type Target = StructureRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<ElementProperties> for Structure

fn from(e: ElementProperties) -> Self

Converts to this type from the input type.

impl PartialEq for ElementProperties

fn eq(&self, other: &ElementProperties) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ElementProperties

impl StructuralPartialEq for ElementProperties