Struct gstreamer_editing_services::Track
source · #[repr(transparent)]pub struct Track { /* private fields */ }Expand description
A Track acts an output source for a Timeline. Each one
essentially provides an additional gst::Pad for the timeline, with
restriction-caps capabilities. Internally, a track
wraps an nlecomposition filtered by a capsfilter.
A track will contain a number of TrackElement-s, and its role is
to select and activate these elements according to their timings when
the timeline in played. For example, a track would activate a
Source when its start is reached by outputting
its data for its duration. Similarly, a
Operation would be activated by applying its effect to the source
data, starting from its start time and lasting for
its duration.
For most users, it will usually be sufficient to add newly created
tracks to a timeline, but never directly add an element to a track.
Whenever a Clip is added to a timeline, the clip adds its
elements to the timeline’s tracks and assumes responsibility for
updating them.
Properties
caps
The capabilities used to choose the output of the Track’s
elements. Internally, this is used to select output streams when
several may be available, by determining whether its gst::Pad is
compatible (see NleObject:caps for nlecomposition). As such,
this is used as a weaker indication of the desired output type of the
track, before the restriction-caps is applied.
Therefore, this should be set to a generic superset of the
restriction-caps, such as “video/x-raw(ANY)”. In addition,
it should match with the track’s track-type.
Note that when you set this property, the GstCapsFeatures of all its
gst::Structure-s will be automatically set to GST_CAPS_FEATURES_ANY.
Once a track has been added to a Timeline, you should not change
this.
Default value: GST_CAPS_ANY.
Readable | Writeable | Construct Only
duration
Current duration of the track
Default value: O
Readable
id
The nlecomposition:id of the underlying nlecomposition.
Readable | Writeable
mixing
Whether the track should support the mixing of Layer data, such
as composing the video data of each layer (when part of the video
data is transparent, the next layer will become visible) or adding
together the audio data. As such, for audio and video tracks, you’ll
likely want to keep this set to true.
Readable | Writeable | Construct
restriction-caps
The capabilities that specifies the final output format of the
Track. For example, for a video track, it would specify the
height, width, framerate and other properties of the stream.
You may change this property after the track has been added to a
Timeline, but it must remain compatible with the track’s
caps.
Default value: GST_CAPS_ANY.
Readable | Writeable
track-type
The track type of the track. This controls the type of
TrackElement-s that can be added to the track. This should
match with the track’s caps.
Once a track has been added to a Timeline, you should not change
this.
Readable | Writeable | Construct Only
Bin
async-handling
If set to true, the bin will handle asynchronous state changes.
This should be used only if the bin subclass is modifying the state
of its children on its own.
Readable | Writeable
message-forward
Forward all children messages, even those that would normally be filtered by the bin. This can be interesting when one wants to be notified of the EOS state of individual elements, for example.
The messages are converted to an ELEMENT message with the bin as the
source. The structure of the message is named GstBinForwarded and contains
a field named message that contains the original forwarded GstMessage.
Readable | Writeable
Object
name
Readable | Writeable | Construct
parent
The parent of the object. Please note, that when changing the ‘parent’
property, we don’t emit notify and deep-notify
signals due to locking issues. In some cases one can use
element-added or element-removed signals on the parent to
achieve a similar effect.
Readable | Writeable
Signals
commited
This signal will be emitted once the changes initiated by
GESTrackExt::commit() have been executed in the backend. In particular,
this will be emitted whenever the underlying nlecomposition has been
committed (see nlecomposition::commited).
track-element-added
Will be emitted after a track element is added to the track.
track-element-removed
Will be emitted after a track element is removed from the track.
Bin
deep-element-added
Will be emitted after the element was added to sub_bin.
deep-element-removed
Will be emitted after the element was removed from sub_bin.
do-latency
Will be emitted when the bin needs to perform latency calculations. This
signal is only emitted for toplevel bins or when async-handling is
enabled.
Only one signal handler is invoked. If no signals are connected, the default handler is invoked, which will query and distribute the lowest possible latency to all sinks.
Connect to this signal if the default latency calculations are not sufficient, like when you need different latencies for different sinks in the same pipeline.
element-added
Will be emitted after the element was added to the bin.
element-removed
Will be emitted after the element was removed from the bin.
Element
no-more-pads
This signals that the element will not generate more dynamic pads. Note that this signal will usually be emitted from the context of the streaming thread.
pad-added
a new gst::Pad has been added to the element. Note that this signal will
usually be emitted from the context of the streaming thread. Also keep in
mind that if you add new elements to the pipeline in the signal handler
you will need to set them to the desired target state with
[ElementExtManual::set_state()][crate::gst::prelude::ElementExtManual::set_state()] or [ElementExtManual::sync_state_with_parent()][crate::gst::prelude::ElementExtManual::sync_state_with_parent()].
pad-removed
a gst::Pad has been removed from the element
Object
deep-notify
The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin.
Detailed
ChildProxy
child-added
Will be emitted after the object was added to the child_proxy.
child-removed
Will be emitted after the object was removed from the child_proxy.
MetaContainer
notify-meta
This is emitted for a meta container whenever the metadata under one
of its fields changes, is set for the first time, or is removed. In
the latter case, value will be None.
Detailed
Implements
GESTrackExt, [trait@gst::prelude::BinExt], gst::prelude::ElementExt, gst::prelude::GstObjectExt, glib::ObjectExt, gst::prelude::ChildProxyExt, MetaContainerExt
Implementations§
source§impl Track
impl Track
pub const NONE: Option<&'static Track> = None
sourcepub fn new(type_: TrackType, caps: Caps) -> Track
pub fn new(type_: TrackType, caps: Caps) -> Track
Creates a new track with the given track-type and caps.
If type_ is TrackType::VIDEO, and caps is a subset of
“video/x-raw(ANY)”, then a VideoTrack is created. This will
automatically choose a gap creation method suitable for video data. You
will likely want to set restriction-caps separately. You may
prefer to use the VideoTrack::new() method instead.
If type_ is TrackType::AUDIO, and caps is a subset of
“audio/x-raw(ANY)”, then a AudioTrack is created. This will
automatically choose a gap creation method suitable for audio data, and
will set the restriction-caps to the default for
AudioTrack. You may prefer to use the AudioTrack::new() method
instead.
Otherwise, a plain Track is returned. You will likely want to set
the restriction-caps and call
ges_track_set_create_element_for_gap_func() on the returned track.
type_
The track-type for the track
caps
The caps for the track
Returns
A new track.
Trait Implementations§
source§impl HasParamSpec for Track
impl HasParamSpec for Track
source§impl Ord for Track
impl Ord for Track
source§impl<OT: ObjectType> PartialEq<OT> for Track
impl<OT: ObjectType> PartialEq<OT> for Track
source§impl<OT: ObjectType> PartialOrd<OT> for Track
impl<OT: ObjectType> PartialOrd<OT> for Track
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self and other) and is used by the <=
operator. Read moresource§impl StaticType for Track
impl StaticType for Track
source§fn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of
Self.impl Eq for Track
impl IsA<Bin> for Track
impl IsA<ChildProxy> for Track
impl IsA<Element> for Track
impl IsA<MetaContainer> for Track
impl IsA<Object> for Track
impl IsA<Track> for AudioTrack
impl IsA<Track> for VideoTrack
Auto Trait Implementations§
impl RefUnwindSafe for Track
impl !Send for Track
impl !Sync for Track
impl Unpin for Track
impl UnwindSafe for Track
Blanket Implementations§
source§impl<T> Cast for Twhere
T: ObjectType,
impl<T> Cast for Twhere
T: ObjectType,
source§fn upcast<T>(self) -> Twhere
T: ObjectType,
Self: IsA<T>,
fn upcast<T>(self) -> Twhere
T: ObjectType,
Self: IsA<T>,
Upcasts an object to a superclass or interface
T. Read moresource§fn upcast_ref<T>(&self) -> &Twhere
T: ObjectType,
Self: IsA<T>,
fn upcast_ref<T>(&self) -> &Twhere
T: ObjectType,
Self: IsA<T>,
Upcasts an object to a reference of its superclass or interface
T. Read moresource§fn downcast<T>(self) -> Result<T, Self>where
T: ObjectType,
Self: CanDowncast<T>,
fn downcast<T>(self) -> Result<T, Self>where
T: ObjectType,
Self: CanDowncast<T>,
Tries to downcast to a subclass or interface implementor
T. Read moresource§fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: CanDowncast<T>,
fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: CanDowncast<T>,
Tries to downcast to a reference of its subclass or interface implementor
T. Read moresource§fn dynamic_cast<T>(self) -> Result<T, Self>where
T: ObjectType,
fn dynamic_cast<T>(self) -> Result<T, Self>where
T: ObjectType,
Tries to cast to an object of type
T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read moresource§fn dynamic_cast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
fn dynamic_cast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Tries to cast to reference to an object of type
T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read moresource§unsafe fn unsafe_cast<T>(self) -> Twhere
T: ObjectType,
unsafe fn unsafe_cast<T>(self) -> Twhere
T: ObjectType,
Casts to
T unconditionally. Read moresource§unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,
unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,
Casts to
&T unconditionally. Read moresource§impl<O> ChildProxyExt for Owhere
O: IsA<ChildProxy>,
impl<O> ChildProxyExt for Owhere
O: IsA<ChildProxy>,
source§fn child_added(&self, child: &impl IsA<Object>, name: &str)
fn child_added(&self, child: &impl IsA<Object>, name: &str)
Emits the
child-added signal. Read moresource§fn child_removed(&self, child: &impl IsA<Object>, name: &str)
fn child_removed(&self, child: &impl IsA<Object>, name: &str)
Emits the
child-removed signal. Read moresource§fn child_by_index(&self, index: u32) -> Option<Object>
fn child_by_index(&self, index: u32) -> Option<Object>
Fetches a child by its number. Read more
source§fn child_by_name(&self, name: &str) -> Option<Object>
fn child_by_name(&self, name: &str) -> Option<Object>
Looks up a child element by the given name. Read more
source§fn child_by_name_recurse(&self, name: &str) -> Option<Object>
fn child_by_name_recurse(&self, name: &str) -> Option<Object>
Available on crate feature
v1_22 only.Looks up a child element by the given full-path name. Read more
source§fn children_count(&self) -> u32
fn children_count(&self) -> u32
Gets the number of child objects this parent contains. Read more
source§fn connect_child_added<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Object, &str) + Send + Sync + 'static,
fn connect_child_added<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Object, &str) + Send + Sync + 'static,
source§impl<O> ChildProxyExtManual for Owhere
O: IsA<ChildProxy>,
impl<O> ChildProxyExtManual for Owhere
O: IsA<ChildProxy>,
source§fn child_property<V>(&self, name: &str) -> Vwhere
V: for<'b> FromValue<'b> + 'static,
fn child_property<V>(&self, name: &str) -> Vwhere
V: for<'b> FromValue<'b> + 'static,
Gets a single property using the GstChildProxy mechanism.
You are responsible for freeing it by calling [
glib::Value::unset()][crate::glib::Value::unset()] Read morefn child_property_value(&self, name: &str) -> Value
source§fn set_child_property(&self, name: &str, value: impl Into<Value>)
fn set_child_property(&self, name: &str, value: impl Into<Value>)
Sets a single property using the GstChildProxy mechanism. Read more
fn set_child_property_from_value(&self, name: &str, value: &Value)
source§impl<O> ElementExt for Owhere
O: IsA<Element>,
impl<O> ElementExt for Owhere
O: IsA<Element>,
source§fn abort_state(&self)
fn abort_state(&self)
Abort the state change of the element. This function is used
by elements that do asynchronous state changes and find out
something is wrong. Read more
source§fn add_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
fn add_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
Adds a pad (link point) to
self. pad’s parent will be set to self;
see GstObjectExt::set_parent() for refcounting information. Read moresource§fn change_state(
&self,
transition: StateChange
) -> Result<StateChangeSuccess, StateChangeError>
fn change_state(
&self,
transition: StateChange
) -> Result<StateChangeSuccess, StateChangeError>
source§fn continue_state(
&self,
ret: impl Into<StateChangeReturn>
) -> Result<StateChangeSuccess, StateChangeError>
fn continue_state(
&self,
ret: impl Into<StateChangeReturn>
) -> Result<StateChangeSuccess, StateChangeError>
Commit the state change of the element and proceed to the next
pending state if any. This function is used
by elements that do asynchronous state changes.
The core will normally call this method automatically when an
element returned
StateChangeReturn::Success from the state change function. Read morefn create_all_pads(&self)
fn foreach_pad<P>(&self, func: P) -> boolwhere
P: FnMut(&Element, &Pad) -> bool,
fn foreach_sink_pad<P>(&self, func: P) -> boolwhere
P: FnMut(&Element, &Pad) -> bool,
fn foreach_src_pad<P>(&self, func: P) -> boolwhere
P: FnMut(&Element, &Pad) -> 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>
fn compatible_pad_template(
&self,
compattempl: &PadTemplate
) -> Option<PadTemplate>
fn context(&self, context_type: &str) -> Option<Context>
fn contexts(&self) -> Vec<Context, Global> ⓘ
fn factory(&self) -> Option<ElementFactory>
fn start_time(&self) -> Option<ClockTime>
fn state(
&self,
timeout: impl Into<Option<ClockTime>>
) -> (Result<StateChangeSuccess, StateChangeError>, State, State)
fn static_pad(&self, name: &str) -> Option<Pad>
fn is_locked_state(&self) -> bool
fn lost_state(&self)
fn no_more_pads(&self)
fn post_message(&self, message: Message) -> Result<(), BoolError>
fn provide_clock(&self) -> Option<Clock>
fn release_request_pad(&self, pad: &impl IsA<Pad>)
fn remove_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
fn request_pad(
&self,
templ: &PadTemplate,
name: Option<&str>,
caps: Option<&Caps>
) -> Option<Pad>
fn set_base_time(&self, time: ClockTime)
fn set_bus(&self, bus: Option<&Bus>)
fn set_clock(&self, clock: Option<&impl IsA<Clock>>) -> Result<(), BoolError>
fn set_context(&self, context: &Context)
fn set_locked_state(&self, locked_state: bool) -> bool
fn set_start_time(&self, time: impl Into<Option<ClockTime>>)
fn set_state(&self, state: State) -> Result<StateChangeSuccess, StateChangeError>
fn sync_state_with_parent(&self) -> Result<(), BoolError>
fn unlink(&self, dest: &impl IsA<Element>)
fn unlink_pads(
&self,
srcpadname: &str,
dest: &impl IsA<Element>,
destpadname: &str
)
fn connect_no_more_pads<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O) + Send + Sync + 'static,
fn connect_pad_added<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Pad) + Send + Sync + 'static,
fn connect_pad_removed<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Pad) + Send + Sync + 'static,
source§impl<O> ElementExtManual for Owhere
O: IsA<Element>,
impl<O> ElementExtManual for Owhere
O: IsA<Element>,
fn element_class(&self) -> &Class<Element>
fn current_state(&self) -> State
fn pending_state(&self) -> State
source§fn query(&self, query: &mut QueryRef) -> bool
fn query(&self, query: &mut QueryRef) -> bool
Performs a query on the given element. Read more
source§fn send_event(&self, event: impl Into<Event>) -> bool
fn send_event(&self, event: impl Into<Event>) -> bool
Sends an event to an element. If the element doesn’t implement an
event handler, the event will be pushed on a random linked sink pad for
downstream events or a random linked source pad for upstream events. Read more
fn metadata<'a>(&self, key: &str) -> Option<&'a str>
fn pad_template(&self, name: &str) -> Option<PadTemplate>
fn pad_template_list(&self) -> List<PadTemplate>
fn set_element_flags(&self, flags: ElementFlags)
fn unset_element_flags(&self, flags: ElementFlags)
fn element_flags(&self) -> ElementFlags
fn message_full<T>(
&self,
type_: ElementMessageType,
code: T,
message: Option<&str>,
debug: Option<&str>,
file: &str,
function: &str,
line: u32
)where
T: MessageErrorDomain,
fn message_full_with_details<T>(
&self,
type_: ElementMessageType,
code: T,
message: Option<&str>,
debug: Option<&str>,
file: &str,
function: &str,
line: u32,
structure: Structure
)where
T: MessageErrorDomain,
fn post_error_message(&self, msg: ErrorMessage)
fn iterate_pads(&self) -> Iterator<Pad>
fn iterate_sink_pads(&self) -> Iterator<Pad>
fn iterate_src_pads(&self) -> Iterator<Pad>
fn pads(&self) -> Vec<Pad, Global> ⓘ
fn sink_pads(&self) -> Vec<Pad, Global> ⓘ
fn src_pads(&self) -> Vec<Pad, Global> ⓘ
fn num_pads(&self) -> u16
fn num_sink_pads(&self) -> u16
fn num_src_pads(&self) -> u16
fn add_property_deep_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool
) -> NotifyWatchId
fn add_property_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool
) -> NotifyWatchId
fn remove_property_notify_watch(&self, watch_id: NotifyWatchId)
fn query_convert<U>(&self, src_val: impl FormattedValue) -> Option<U>where
U: SpecificFormattedValueFullRange,
fn query_convert_generic(
&self,
src_val: impl FormattedValue,
dest_format: Format
) -> Option<GenericFormattedValue>
fn query_duration<T>(&self) -> Option<T>where
T: SpecificFormattedValueIntrinsic,
fn query_duration_generic(&self, format: Format) -> Option<GenericFormattedValue>
fn query_position<T>(&self) -> Option<T>where
T: SpecificFormattedValueIntrinsic,
fn query_position_generic(&self, format: Format) -> Option<GenericFormattedValue>
fn seek<V>(
&self,
rate: f64,
flags: SeekFlags,
start_type: SeekType,
start: V,
stop_type: SeekType,
stop: impl CompatibleFormattedValue<V>
) -> Result<(), BoolError>where
V: FormattedValue,
fn seek_simple(
&self,
seek_flags: SeekFlags,
seek_pos: impl FormattedValue
) -> Result<(), BoolError>
fn call_async<F>(&self, func: F)where
F: FnOnce(&O) + Send + 'static,
fn call_async_future<F, T>(
&self,
func: F
) -> Pin<Box<dyn Future<Output = T> + Send + 'static, Global>>where
F: FnOnce(&O) -> T + Send + 'static,
T: Send + 'static,
fn current_running_time(&self) -> Option<ClockTime>
fn current_clock_time(&self) -> Option<ClockTime>
fn request_pad_simple(&self, name: &str) -> Option<Pad>
fn link(&self, dest: &impl IsA<Element>) -> Result<(), BoolError>
fn link_filtered(
&self,
dest: &impl IsA<Element>,
filter: &Caps
) -> Result<(), BoolError>
fn link_pads(
&self,
srcpadname: Option<&str>,
dest: &impl IsA<Element>,
destpadname: Option<&str>
) -> Result<(), BoolError>
fn link_pads_filtered(
&self,
srcpadname: Option<&str>,
dest: &impl IsA<Element>,
destpadname: Option<&str>,
filter: &Caps
) -> Result<(), BoolError>
fn link_pads_full(
&self,
srcpadname: Option<&str>,
dest: &impl IsA<Element>,
destpadname: Option<&str>,
flags: PadLinkCheck
) -> Result<(), BoolError>
source§impl<O> GObjectExtManualGst for Owhere
O: IsA<Object>,
impl<O> GObjectExtManualGst for Owhere
O: IsA<Object>,
fn set_property_from_str(&self, name: &str, value: &str)
source§impl<O> GstBinExt for Owhere
O: IsA<Bin>,
impl<O> GstBinExt for Owhere
O: IsA<Bin>,
source§fn add(&self, element: &impl IsA<Element>) -> Result<(), BoolError>
fn add(&self, element: &impl IsA<Element>) -> Result<(), BoolError>
Adds the given element to the bin. Sets the element’s parent, and thus
takes ownership of the element. An element can only be added to one bin. Read more
source§fn find_unlinked_pad(&self, direction: PadDirection) -> Option<Pad>
fn find_unlinked_pad(&self, direction: PadDirection) -> Option<Pad>
Recursively looks for elements with an unlinked pad of the given
direction within the specified bin and returns an unlinked pad
if one is found, or
None otherwise. If a pad is found, the caller
owns a reference to it and should use gst_object_unref() on the
pad when it is not needed any longer. Read moresource§fn by_interface(&self, iface: Type) -> Option<Element>
fn by_interface(&self, iface: Type) -> Option<Element>
Looks for an element inside the bin that implements the given
interface. If such an element is found, it returns the element.
You can cast this element to the given interface afterwards. If you want
all elements that implement the interface, use
GstBinExtManual::iterate_all_by_interface(). This function recurses into child bins. Read moresource§fn by_name(&self, name: &str) -> Option<Element>
fn by_name(&self, name: &str) -> Option<Element>
Gets the element with the given name from a bin. This
function recurses into child bins. Read more
source§fn by_name_recurse_up(&self, name: &str) -> Option<Element>
fn by_name_recurse_up(&self, name: &str) -> Option<Element>
Gets the element with the given name from this bin. If the
element is not found, a recursion is performed on the parent bin. Read more
source§fn suppressed_flags(&self) -> ElementFlags
fn suppressed_flags(&self) -> ElementFlags
Returns Read more
source§fn recalculate_latency(&self) -> Result<(), BoolError>
fn recalculate_latency(&self) -> Result<(), BoolError>
Queries
self for the current latency and reconfigures this latency on all the
elements using a LATENCY event. Read moresource§fn remove(&self, element: &impl IsA<Element>) -> Result<(), BoolError>
fn remove(&self, element: &impl IsA<Element>) -> Result<(), BoolError>
Removes the element from the bin, unparenting it as well.
Unparenting the element means that the element will be dereferenced,
so if the bin holds the only reference to the element, the element
will be freed in the process of removing it from the bin. If you
want the element to still exist after removing, you need to call
gst_object_ref() before removing it from the bin. Read moresource§fn set_suppressed_flags(&self, flags: ElementFlags)
fn set_suppressed_flags(&self, flags: ElementFlags)
Suppresses the given flags on the bin.
ElementFlags of a
child element are propagated when it is added to the bin.
When suppressed flags are set, those specified flags will
not be propagated to the bin. Read moresource§fn sync_children_states(&self) -> Result<(), BoolError>
fn sync_children_states(&self) -> Result<(), BoolError>
Synchronizes the state of every child of
self with the state
of self. See also ElementExt::sync_state_with_parent(). Read moresource§fn is_async_handling(&self) -> bool
fn is_async_handling(&self) -> bool
If set to
true, the bin will handle asynchronous state changes.
This should be used only if the bin subclass is modifying the state
of its children on its own.source§fn set_async_handling(&self, async_handling: bool)
fn set_async_handling(&self, async_handling: bool)
If set to
true, the bin will handle asynchronous state changes.
This should be used only if the bin subclass is modifying the state
of its children on its own.source§fn is_message_forward(&self) -> bool
fn is_message_forward(&self) -> bool
Forward all children messages, even those that would normally be filtered by
the bin. This can be interesting when one wants to be notified of the EOS
state of individual elements, for example. Read more
source§fn set_message_forward(&self, message_forward: bool)
fn set_message_forward(&self, message_forward: bool)
Forward all children messages, even those that would normally be filtered by
the bin. This can be interesting when one wants to be notified of the EOS
state of individual elements, for example. Read more
source§fn connect_deep_element_added<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Bin, &Element) + Send + Sync + 'static,
fn connect_deep_element_added<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Bin, &Element) + Send + Sync + 'static,
Will be emitted after the element was added to
sub_bin. Read moresource§fn connect_deep_element_removed<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Bin, &Element) + Send + Sync + 'static,
fn connect_deep_element_removed<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Bin, &Element) + Send + Sync + 'static,
Will be emitted after the element was removed from
sub_bin. Read moresource§fn connect_element_added<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Element) + Send + Sync + 'static,
fn connect_element_added<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Element) + Send + Sync + 'static,
Will be emitted after the element was added to the bin. Read more
source§fn connect_element_removed<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Element) + Send + Sync + 'static,
fn connect_element_removed<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Element) + Send + Sync + 'static,
Will be emitted after the element was removed from the bin. Read more
fn connect_async_handling_notify<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O) + Send + Sync + 'static,
fn connect_message_forward_notify<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O) + Send + Sync + 'static,
source§impl<O> GstBinExtManual for Owhere
O: IsA<Bin>,
impl<O> GstBinExtManual for Owhere
O: IsA<Bin>,
fn add_many<E>(&self, elements: &[&E]) -> Result<(), BoolError>where
E: IsA<Element>,
fn remove_many<E>(&self, elements: &[&E]) -> Result<(), BoolError>where
E: IsA<Element>,
fn connect_do_latency<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O) -> Result<(), LoggableError> + Send + Sync + 'static,
source§fn iterate_all_by_element_factory_name(
&self,
factory_name: &str
) -> Iterator<Element>
fn iterate_all_by_element_factory_name(
&self,
factory_name: &str
) -> Iterator<Element>
Available on crate feature
v1_18 only.fn iterate_all_by_interface(&self, iface: Type) -> Iterator<Element>
fn iterate_elements(&self) -> Iterator<Element>
fn iterate_recurse(&self) -> Iterator<Element>
fn iterate_sinks(&self) -> Iterator<Element>
fn iterate_sorted(&self) -> Iterator<Element>
fn iterate_sources(&self) -> Iterator<Element>
fn children(&self) -> Vec<Element, Global> ⓘ
fn debug_to_dot_data(&self, details: DebugGraphDetails) -> GString
fn debug_to_dot_file(
&self,
details: DebugGraphDetails,
file_name: impl AsRef<Path>
)
fn debug_to_dot_file_with_ts(
&self,
details: DebugGraphDetails,
file_name: impl AsRef<Path>
)
fn set_bin_flags(&self, flags: BinFlags)
fn unset_bin_flags(&self, flags: BinFlags)
fn bin_flags(&self) -> BinFlags
source§impl<O> GstObjectExt for Owhere
O: IsA<Object>,
impl<O> GstObjectExt for Owhere
O: IsA<Object>,
source§fn add_control_binding(
&self,
binding: &impl IsA<ControlBinding>
) -> Result<(), BoolError>
fn add_control_binding(
&self,
binding: &impl IsA<ControlBinding>
) -> Result<(), BoolError>
Attach the
ControlBinding to the object. If there already was a
ControlBinding for this property it will be replaced. Read moresource§fn default_error(&self, error: &Error, debug: Option<&str>)
fn default_error(&self, error: &Error, debug: Option<&str>)
A default error function that uses
g_printerr() to display the error message
and the optional debug string.. Read moresource§fn control_binding(&self, property_name: &str) -> Option<ControlBinding>
fn control_binding(&self, property_name: &str) -> Option<ControlBinding>
Gets the corresponding
ControlBinding for the property. This should be
unreferenced again after use. Read moresource§fn control_rate(&self) -> Option<ClockTime>
fn control_rate(&self) -> Option<ClockTime>
Obtain the control-rate for this
self. Audio processing Element
objects will use this rate to sub-divide their processing loop and call
sync_values() in between. The length of the processing segment
should be up to control-rate nanoseconds. Read moresource§fn parent(&self) -> Option<Object>
fn parent(&self) -> Option<Object>
Returns the parent of
self. This function increases the refcount
of the parent object so you should gst_object_unref() it after usage. Read moresource§fn path_string(&self) -> GString
fn path_string(&self) -> GString
Generates a string describing the path of
self in
the object hierarchy. Only useful (or used) for debugging. Read moresource§fn value(
&self,
property_name: &str,
timestamp: impl Into<Option<ClockTime>>
) -> Option<Value>
fn value(
&self,
property_name: &str,
timestamp: impl Into<Option<ClockTime>>
) -> Option<Value>
Gets the value for the given controlled property at the requested time. Read more
fn has_active_control_bindings(&self) -> bool
fn has_ancestor(&self, ancestor: &impl IsA<Object>) -> bool
fn has_as_ancestor(&self, ancestor: &impl IsA<Object>) -> bool
fn has_as_parent(&self, parent: &impl IsA<Object>) -> bool
fn remove_control_binding(&self, binding: &impl IsA<ControlBinding>) -> bool
fn set_control_binding_disabled(&self, property_name: &str, disabled: bool)
fn set_control_bindings_disabled(&self, disabled: bool)
fn set_control_rate(&self, control_rate: impl Into<Option<ClockTime>>)
fn set_parent(&self, parent: &impl IsA<Object>) -> Result<(), BoolError>
fn suggest_next_sync(&self) -> Option<ClockTime>
fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>
fn unparent(&self)
fn connect_parent_notify<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O) + Send + Sync + 'static,
source§impl<O> GstObjectExtManual for Owhere
O: IsA<Object>,
impl<O> GstObjectExtManual for Owhere
O: IsA<Object>,
fn connect_deep_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &Object, &ParamSpec) + Send + Sync + 'static,
fn set_object_flags(&self, flags: ObjectFlags)
fn unset_object_flags(&self, flags: ObjectFlags)
fn object_flags(&self) -> ObjectFlags
fn g_value_array(
&self,
property_name: &str,
timestamp: ClockTime,
interval: ClockTime,
values: &mut [Value]
) -> Result<(), BoolError>
fn object_lock(&self) -> ObjectLockGuard<'_, O>
source§impl<T> IntoClosureReturnValue for Twhere
T: Into<Value>,
impl<T> IntoClosureReturnValue for Twhere
T: Into<Value>,
fn into_closure_return_value(self) -> Option<Value>
source§impl<U> IsSubclassableExt for Uwhere
U: IsClass + ParentClassIs,
impl<U> IsSubclassableExt for Uwhere
U: IsClass + ParentClassIs,
fn parent_class_init<T>(class: &mut Class<U>)where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,
fn parent_instance_init<T>(instance: &mut InitializingObject<T>)where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,
source§impl<T> ObjectExt for Twhere
T: ObjectType,
impl<T> ObjectExt for Twhere
T: ObjectType,
source§fn is<U>(&self) -> boolwhere
U: StaticType,
fn is<U>(&self) -> boolwhere
U: StaticType,
Returns
true if the object is an instance of (can be cast to) T.source§fn object_class(&self) -> &Class<Object>
fn object_class(&self) -> &Class<Object>
Returns the
ObjectClass of the object. Read moresource§fn class_of<U>(&self) -> Option<&Class<U>>where
U: IsClass,
fn class_of<U>(&self) -> Option<&Class<U>>where
U: IsClass,
Returns the class of the object in the given type
T. Read moresource§fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
U: IsInterface,
fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
U: IsInterface,
Returns the interface
T of the object. Read moresource§fn set_property_from_value(&self, property_name: &str, value: &Value)
fn set_property_from_value(&self, property_name: &str, value: &Value)
source§fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])
fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])
Sets multiple properties of the object at once. Read more
source§fn set_properties_from_value(&self, property_values: &[(&str, Value)])
fn set_properties_from_value(&self, property_values: &[(&str, Value)])
Sets multiple properties of the object at once. Read more
source§fn property<V>(&self, property_name: &str) -> Vwhere
V: for<'b> FromValue<'b> + 'static,
fn property<V>(&self, property_name: &str) -> Vwhere
V: for<'b> FromValue<'b> + 'static,
Gets the property
property_name of the object and cast it to the type V. Read moresource§fn property_value(&self, property_name: &str) -> Value
fn property_value(&self, property_name: &str) -> Value
Gets the property
property_name of the object. Read moresource§fn property_type(&self, property_name: &str) -> Option<Type>
fn property_type(&self, property_name: &str) -> Option<Type>
Get the type of the property
property_name of this object. Read moresource§fn find_property(&self, property_name: &str) -> Option<ParamSpec>
fn find_property(&self, property_name: &str) -> Option<ParamSpec>
Get the
ParamSpec of the property property_name of this object.source§fn list_properties(&self) -> PtrSlice<ParamSpec>
fn list_properties(&self) -> PtrSlice<ParamSpec>
Return all
ParamSpec of the properties of this object.source§fn freeze_notify(&self) -> PropertyNotificationFreezeGuard
fn freeze_notify(&self) -> PropertyNotificationFreezeGuard
Freeze all property notifications until the return guard object is dropped. Read more
source§unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
QD: 'static,
unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
QD: 'static,
Set arbitrary data on this object with the given
key. Read moresource§unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
QD: 'static,
unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
QD: 'static,
Return previously set arbitrary data of this object with the given
key. Read moresource§unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
QD: 'static,
unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
QD: 'static,
Retrieve previously set arbitrary data of this object with the given
key. Read moresource§unsafe fn set_data<QD>(&self, key: &str, value: QD)where
QD: 'static,
unsafe fn set_data<QD>(&self, key: &str, value: QD)where
QD: 'static,
Set arbitrary data on this object with the given
key. Read moresource§unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where
QD: 'static,
unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where
QD: 'static,
Return previously set arbitrary data of this object with the given
key. Read moresource§unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where
QD: 'static,
unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where
QD: 'static,
Retrieve previously set arbitrary data of this object with the given
key. Read moresource§fn block_signal(&self, handler_id: &SignalHandlerId)
fn block_signal(&self, handler_id: &SignalHandlerId)
Block a given signal handler. Read more
source§fn unblock_signal(&self, handler_id: &SignalHandlerId)
fn unblock_signal(&self, handler_id: &SignalHandlerId)
Unblock a given signal handler.
source§fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)
fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)
Stop emission of the currently emitted signal.
source§fn stop_signal_emission_by_name(&self, signal_name: &str)
fn stop_signal_emission_by_name(&self, signal_name: &str)
Stop emission of the currently emitted signal by the (possibly detailed) signal name.
source§fn connect<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
fn connect<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
Connect to the signal
signal_name on this object. Read moresource§fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
Connect to the signal
signal_id on this object. Read moresource§fn connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value> + 'static,
fn connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value> + 'static,
Connect to the signal
signal_name on this object. Read moresource§fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value> + 'static,
fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value> + 'static,
Connect to the signal
signal_id on this object. Read moresource§unsafe fn connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value>,
unsafe fn connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value>,
Connect to the signal
signal_name on this object. Read moresource§unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value>,
unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value>,
Connect to the signal
signal_id on this object. Read moresource§fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId
fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId
Connect a closure to the signal
signal_name on this object. Read moresource§fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId
fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId
Connect a closure to the signal
signal_id on this object. Read moresource§fn watch_closure(&self, closure: &impl AsRef<Closure>)
fn watch_closure(&self, closure: &impl AsRef<Closure>)
Limits the lifetime of
closure to the lifetime of the object. When
the object’s reference count drops to zero, the closure will be
invalidated. An invalidated closure will ignore any calls to
invoke_with_values, or
invoke when using Rust closures.source§fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
Emit signal by signal id. Read more
source§fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>
fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>
Same as
Self::emit but takes Value for the arguments.source§fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
Emit signal by its name. Read more
source§fn emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value]
) -> Option<Value>
fn emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value]
) -> Option<Value>
Emit signal by its name. Read more
source§fn emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue]
) -> Rwhere
R: TryFromClosureReturnValue,
fn emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue]
) -> Rwhere
R: TryFromClosureReturnValue,
Emit signal by its name with details. Read more
source§fn emit_by_name_with_details_and_values(
&self,
signal_name: &str,
details: Quark,
args: &[Value]
) -> Option<Value>
fn emit_by_name_with_details_and_values(
&self,
signal_name: &str,
details: Quark,
args: &[Value]
) -> Option<Value>
Emit signal by its name with details. Read more
source§fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Rwhere
R: TryFromClosureReturnValue,
fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Rwhere
R: TryFromClosureReturnValue,
Emit signal by signal id with details. Read more
source§fn emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value]
) -> Option<Value>
fn emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value]
) -> Option<Value>
Emit signal by signal id with details. Read more
source§fn disconnect(&self, handler_id: SignalHandlerId)
fn disconnect(&self, handler_id: SignalHandlerId)
Disconnect a previously connected signal handler.
source§fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: Fn(&T, &ParamSpec) + Send + Sync + 'static,
fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: Fn(&T, &ParamSpec) + Send + Sync + 'static,
Connect to the
notify signal of the object. Read moresource§fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: Fn(&T, &ParamSpec) + 'static,
fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: Fn(&T, &ParamSpec) + 'static,
Connect to the
notify signal of the object. Read moresource§unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerIdwhere
F: Fn(&T, &ParamSpec),
unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerIdwhere
F: Fn(&T, &ParamSpec),
Connect to the
notify signal of the object. Read moresource§fn notify(&self, property_name: &str)
fn notify(&self, property_name: &str)
Notify that the given property has changed its value. Read more
source§fn notify_by_pspec(&self, pspec: &ParamSpec)
fn notify_by_pspec(&self, pspec: &ParamSpec)
Notify that the given property has changed its value. Read more
source§fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>where
F: FnOnce() + Send + 'static,
fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>where
F: FnOnce() + Send + 'static,
Add a callback to be notified when the Object is disposed.
source§fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>where
F: FnOnce() + 'static,
fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>where
F: FnOnce() + 'static,
Add a callback to be notified when the Object is disposed. Read more
source§fn bind_property<'f, 't, O, 'a>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str
) -> BindingBuilder<'a, 'f, 't>where
O: ObjectType,
fn bind_property<'f, 't, O, 'a>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str
) -> BindingBuilder<'a, 'f, 't>where
O: ObjectType,
source§unsafe fn run_dispose(&self)
unsafe fn run_dispose(&self)
Runs the dispose mechanism of the object. Read more
source§impl<T> PropertyGet for Twhere
T: HasParamSpec,
impl<T> PropertyGet for Twhere
T: HasParamSpec,
source§impl<T> StaticTypeExt for Twhere
T: StaticType,
impl<T> StaticTypeExt for Twhere
T: StaticType,
source§fn ensure_type()
fn ensure_type()
Ensures that the type has been registered with the type system.