Struct gstreamer::TagSetter

source ·

pub struct TagSetter { /* private fields */ }

Expand description

Element interface that allows setting of media metadata.

Elements that support changing a stream’s metadata will implement this interface. Examples of such elements are ‘vorbisenc’, ‘theoraenc’ and ‘id3v2mux’.

If you just want to retrieve metadata in your application then all you need to do is watch for tag messages on your pipeline’s bus. This interface is only for setting metadata, not for extracting it. To set tags from the application, find tagsetter elements and set tags using e.g. TagSetterExt::merge_tags() or gst_tag_setter_add_tags(). Also consider setting the TagMergeMode that is used for tag events that arrive at the tagsetter element (default mode is to keep existing tags). The application should do that before the element goes to State::Paused.

Elements implementing the TagSetter interface often have to merge any tags received from upstream and the tags set by the application via the interface. This can be done like this:

⚠️ The following code is in C ⚠️

GstTagMergeMode merge_mode;
const GstTagList *application_tags;
const GstTagList *event_tags;
GstTagSetter *tagsetter;
GstTagList *result;

tagsetter = GST_TAG_SETTER (element);

merge_mode = gst_tag_setter_get_tag_merge_mode (tagsetter);
application_tags = gst_tag_setter_get_tag_list (tagsetter);
event_tags = (const GstTagList *) element->event_tags;

GST_LOG_OBJECT (tagsetter, "merging tags, merge mode = %d", merge_mode);
GST_LOG_OBJECT (tagsetter, "event tags: %" GST_PTR_FORMAT, event_tags);
GST_LOG_OBJECT (tagsetter, "set   tags: %" GST_PTR_FORMAT, application_tags);

result = gst_tag_list_merge (application_tags, event_tags, merge_mode);

GST_LOG_OBJECT (tagsetter, "final tags: %" GST_PTR_FORMAT, result);

§Implements

TagSetterExt, ElementExt, GstObjectExt, [trait@glib::ObjectExt], TagSetterExtManual, ElementExtManual

GLib type: GObject with reference counted clone semantics.

Struct gstreamer::TagSetterCopy item path

§Implements

Implementations§

impl TagSetter

pub const NONE: Option<&'static TagSetter> = None

Trait Implementations§

impl Clone for TagSetter

fn clone(&self) -> Self

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

impl Debug for TagSetter

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

impl HasParamSpec for TagSetter

type ParamSpec = ParamSpecObject

type SetValue = TagSetter

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, TagSetter>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TagSetter

fn hash<H>(&self, state: &mut H)where H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl<T: TagSetterImpl> IsImplementable<T> for TagSetter

fn interface_init(_iface: &mut Interface<Self>)

fn instance_init(_instance: &mut InitializingObject<T>)

impl Ord for TagSetter

fn cmp(&self, other: &Self) -> Ordering

fn max(self, other: Self) -> Selfwhere Self: Sized,

fn min(self, other: Self) -> Selfwhere Self: Sized,

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

impl<OT: ObjectType> PartialEq<OT> for TagSetter

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

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

impl<OT: ObjectType> PartialOrd<OT> for TagSetter

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

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

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

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

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

impl StaticType for TagSetter

fn static_type() -> Type

impl Eq for TagSetter

impl IsA<Element> for TagSetter

impl IsA<Object> for TagSetter

impl Send for TagSetter

impl Sync for TagSetter

Auto Trait Implementations§

impl Freeze for TagSetter

impl RefUnwindSafe for TagSetter

impl Unpin for TagSetter

impl UnwindSafe for TagSetter

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Cast for Twhere T: ObjectType,

fn upcast<T>(self) -> Twhere T: ObjectType, Self: IsA<T>,

fn upcast_ref<T>(&self) -> &Twhere T: ObjectType, Self: IsA<T>,

fn downcast<T>(self) -> Result<T, Self>where T: ObjectType, Self: MayDowncastTo<T>,

fn downcast_ref<T>(&self) -> Option<&T>where T: ObjectType, Self: MayDowncastTo<T>,

fn dynamic_cast<T>(self) -> Result<T, Self>where T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T>where T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> Twhere T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere T: ObjectType,

impl<T> CloneToUninit for Twhere T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

impl<O> ElementExt for Owhere O: IsA<Element>,

fn abort_state(&self)

fn add_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>

fn change_state( &self, transition: StateChange, ) -> Result<StateChangeSuccess, StateChangeError>

fn continue_state( &self, ret: impl Into<StateChangeReturn>, ) -> Result<StateChangeSuccess, StateChangeError>

fn create_all_pads(&self)

fn decorate_stream_id(&self, stream_id: &str) -> GString

fn foreach_pad<P: FnMut(&Element, &Pad) -> bool>(&self, func: P) -> bool

fn foreach_sink_pad<P: FnMut(&Element, &Pad) -> bool>(&self, func: P) -> bool

fn foreach_src_pad<P: FnMut(&Element, &Pad) -> bool>(&self, func: P) -> bool

fn base_time(&self) -> Option<ClockTime>

fn bus(&self) -> Option<Bus>

fn clock(&self) -> Option<Clock>

fn compatible_pad( &self, pad: &impl IsA<Pad>, caps: Option<&Caps>, ) -> Option<Pad>

Struct gstreamer::TagSetter

fn hash<H>(&self, state: &mut H)
where H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

fn max(self, other: Self) -> Self
where Self: Sized,

fn min(self, other: Self) -> Self
where Self: Sized,

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> Cast for T
where T: ObjectType,

fn upcast<T>(self) -> T
where T: ObjectType, Self: IsA<T>,

fn upcast_ref<T>(&self) -> &T
where T: ObjectType, Self: IsA<T>,

fn downcast<T>(self) -> Result<T, Self>
where T: ObjectType, Self: MayDowncastTo<T>,

fn downcast_ref<T>(&self) -> Option<&T>
where T: ObjectType, Self: MayDowncastTo<T>,

fn dynamic_cast<T>(self) -> Result<T, Self>
where T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T>
where T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> T
where T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &T
where T: ObjectType,

impl<T> CloneToUninit for T
where T: Clone,

impl<O> ElementExt for O
where O: IsA<Element>,

impl<O> ElementExtManual for O
where O: IsA<Element>,