Struct gstreamer_editing_services::Track
source · 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, [trait@glib::ObjectExt], gst::prelude::ChildProxyExt, MetaContainerExt
GLib type: GObject with reference counted clone semantics.
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§fn cmp(&self, other: &Self) -> Ordering
fn cmp(&self, other: &Self) -> Ordering
Comparison for two GObjects.
Compares the memory addresses of the provided objects.
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
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
source§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 Freeze for Track
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
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: MayDowncastTo<T>,
fn downcast<T>(self) -> Result<T, Self>where
T: ObjectType,
Self: MayDowncastTo<T>,
Tries to downcast to a subclass or interface implementor
T. Read moresource§fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: MayDowncastTo<T>,
fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: MayDowncastTo<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 upcast will do many checks at compile-time already. downcast will
perform the same checks at runtime as dynamic_cast, but will also ensure some amount of
compile-time safety. 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>
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) -> SignalHandlerId
fn connect_child_added<F>(&self, f: F) -> SignalHandlerId
source§fn connect_child_removed<F>(&self, f: F) -> SignalHandlerId
fn connect_child_removed<F>(&self, f: F) -> SignalHandlerId
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<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit)source§impl<O> ElementExt for O
impl<O> ElementExt for O
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 moresource§fn create_all_pads(&self)
fn create_all_pads(&self)
Creates a pad for each pad template that is always available.
This function is only useful during object initialization of
subclasses of
Element.source§fn decorate_stream_id(&self, stream_id: &str) -> GString
fn decorate_stream_id(&self, stream_id: &str) -> GString
source§fn foreach_pad<P>(&self, func: P) -> bool
fn foreach_pad<P>(&self, func: P) -> bool
Call
func with user_data for each of self’s pads. func will be called
exactly once for each pad that exists at the time of this call, unless
one of the calls to func returns false in which case we will stop
iterating pads and return early. If new pads are added or pads are removed
while pads are being iterated, this will not be taken into account until
next time this function is used. Read moresource§fn foreach_sink_pad<P>(&self, func: P) -> bool
fn foreach_sink_pad<P>(&self, func: P) -> bool
Call
func with user_data for each of self’s sink pads. func will be
called exactly once for each sink pad that exists at the time of this call,
unless one of the calls to func returns false in which case we will stop
iterating pads and return early. If new sink pads are added or sink pads
are removed while the sink pads are being iterated, this will not be taken
into account until next time this function is used. Read moresource§fn foreach_src_pad<P>(&self, func: P) -> bool
fn foreach_src_pad<P>(&self, func: P) -> bool
Call
func with user_data for each of self’s source pads. func will be
called exactly once for each source pad that exists at the time of this call,
unless one of the calls to func returns false in which case we will stop
iterating pads and return early. If new source pads are added or source pads
are removed while the source pads are being iterated, this will not be taken
into account until next time this function is used. Read moresource§fn base_time(&self) -> Option<ClockTime>
fn base_time(&self) -> Option<ClockTime>
Returns the base time of the element. The base time is the
absolute time of the clock when this element was last put to
PLAYING. Subtracting the base time from the clock time gives
the running time of the element. Read more
source§fn clock(&self) -> Option<Clock>
fn clock(&self) -> Option<Clock>
Gets the currently configured clock of the element. This is the clock as was
last set with
set_clock(). Read moresource§fn compatible_pad(
&self,
pad: &impl IsA<Pad>,
caps: Option<&Caps>,
) -> Option<Pad>
fn compatible_pad( &self, pad: &impl IsA<Pad>, caps: Option<&Caps>, ) -> Option<Pad>
Looks for an unlinked pad to which the given pad can link. It is not
guaranteed that linking the pads will work, though it should work in most
cases. Read more
source§fn compatible_pad_template(
&self,
compattempl: &PadTemplate,
) -> Option<PadTemplate>
fn compatible_pad_template( &self, compattempl: &PadTemplate, ) -> Option<PadTemplate>
Retrieves a pad template from
self that is compatible with compattempl.
Pads from compatible templates can be linked together. Read moresource§fn context(&self, context_type: &str) -> Option<Context>
fn context(&self, context_type: &str) -> Option<Context>
Gets the context with
context_type set on the element or NULL. Read moresource§fn factory(&self) -> Option<ElementFactory>
fn factory(&self) -> Option<ElementFactory>
Retrieves the factory that was used to create this element. Read more
source§fn start_time(&self) -> Option<ClockTime>
fn start_time(&self) -> Option<ClockTime>
Returns the start time of the element. The start time is the
running time of the clock when this element was last put to PAUSED. Read more
source§fn state(
&self,
timeout: impl Into<Option<ClockTime>>,
) -> (Result<StateChangeSuccess, StateChangeError>, State, State)
fn state( &self, timeout: impl Into<Option<ClockTime>>, ) -> (Result<StateChangeSuccess, StateChangeError>, State, State)
Gets the state of the element. Read more
source§fn static_pad(&self, name: &str) -> Option<Pad>
fn static_pad(&self, name: &str) -> Option<Pad>
Retrieves a pad from
self by name. This version only retrieves
already-existing (i.e. ‘static’) pads. Read moresource§fn is_locked_state(&self) -> bool
fn is_locked_state(&self) -> bool
Checks if the state of an element is locked.
If the state of an element is locked, state changes of the parent don’t
affect the element.
This way you can leave currently unused elements inside bins. Just lock their
state before changing the state from
State::Null. Read moresource§fn lost_state(&self)
fn lost_state(&self)
Brings the element to the lost state. The current state of the
element is copied to the pending state so that any call to
state() will return StateChangeReturn::Async. Read moresource§fn no_more_pads(&self)
fn no_more_pads(&self)
Use this function to signal that the element does not expect any more pads
to show up in the current pipeline. This function should be called whenever
pads have been added by the element itself. Elements with
PadPresence::Sometimes
pad templates use this in combination with autopluggers to figure out that
the element is done initializing its pads. Read moresource§fn provide_clock(&self) -> Option<Clock>
fn provide_clock(&self) -> Option<Clock>
Get the clock provided by the given element. Read more
source§fn release_request_pad(&self, pad: &impl IsA<Pad>)
fn release_request_pad(&self, pad: &impl IsA<Pad>)
Makes the element free the previously requested pad as obtained
with
request_pad(). Read moresource§fn remove_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
fn remove_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
Removes
pad from self. pad will be destroyed if it has not been
referenced elsewhere using GstObjectExt::unparent(). Read moresource§fn request_pad(
&self,
templ: &PadTemplate,
name: Option<&str>,
caps: Option<&Caps>,
) -> Option<Pad>
fn request_pad( &self, templ: &PadTemplate, name: Option<&str>, caps: Option<&Caps>, ) -> Option<Pad>
Retrieves a request pad from the element according to the provided template.
Pad templates can be looked up using
ElementFactory::static_pad_templates(). Read moresource§fn set_base_time(&self, time: ClockTime)
fn set_base_time(&self, time: ClockTime)
Set the base time of an element. See
base_time(). Read moresource§fn set_bus(&self, bus: Option<&Bus>)
fn set_bus(&self, bus: Option<&Bus>)
Sets the bus of the element. Increases the refcount on the bus.
For internal use only, unless you’re testing elements. Read more
source§fn set_clock(&self, clock: Option<&impl IsA<Clock>>) -> Result<(), BoolError>
fn set_clock(&self, clock: Option<&impl IsA<Clock>>) -> Result<(), BoolError>
Sets the clock for the element. This function increases the
refcount on the clock. Any previously set clock on the object
is unreffed. Read more
source§fn set_context(&self, context: &Context)
fn set_context(&self, context: &Context)
Sets the context of the element. Increases the refcount of the context. Read more
source§fn set_locked_state(&self, locked_state: bool) -> bool
fn set_locked_state(&self, locked_state: bool) -> bool
Locks the state of an element, so state changes of the parent don’t affect
this element anymore. Read more
source§fn set_start_time(&self, time: impl Into<Option<ClockTime>>)
fn set_start_time(&self, time: impl Into<Option<ClockTime>>)
Set the start time of an element. The start time of the element is the
running time of the element when it last went to the PAUSED state. In READY
or after a flushing seek, it is set to 0. Read more
source§fn set_state(
&self,
state: State,
) -> Result<StateChangeSuccess, StateChangeError>
fn set_state( &self, state: State, ) -> Result<StateChangeSuccess, StateChangeError>
Sets the state of the element. This function will try to set the
requested state by going through all the intermediary states and calling
the class’s state change function for each. Read more
source§fn unlink(&self, dest: &impl IsA<Element>)
fn unlink(&self, dest: &impl IsA<Element>)
Unlinks all source pads of the source element with all sink pads
of the sink element to which they are linked. Read more
source§fn unlink_pads(
&self,
srcpadname: &str,
dest: &impl IsA<Element>,
destpadname: &str,
)
fn unlink_pads( &self, srcpadname: &str, dest: &impl IsA<Element>, destpadname: &str, )
Unlinks the two named pads of the source and destination elements. Read more
source§fn connect_no_more_pads<F>(&self, f: F) -> SignalHandlerId
fn connect_no_more_pads<F>(&self, f: F) -> SignalHandlerId
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.
source§fn connect_pad_added<F>(&self, f: F) -> SignalHandlerId
fn connect_pad_added<F>(&self, f: F) -> SignalHandlerId
a new
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
set_state() or sync_state_with_parent(). Read moresource§fn connect_pad_removed<F>(&self, f: F) -> SignalHandlerId
fn connect_pad_removed<F>(&self, f: F) -> SignalHandlerId
source§impl<O> ElementExtManual for O
impl<O> ElementExtManual for O
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
source§fn pad_template(&self, name: &str) -> Option<PadTemplate>
fn pad_template(&self, name: &str) -> Option<PadTemplate>
Retrieves a padtemplate from
self with the given name. Read moresource§fn pad_template_list(&self) -> List<PadTemplate>
fn pad_template_list(&self) -> List<PadTemplate>
Retrieves a list of the pad templates associated with
self. The
list must not be modified by the calling code. Read moresource§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<T>(
&self,
type_: ElementMessageType,
code: T,
message: Option<&str>,
debug: Option<&str>,
file: &str,
function: &str,
line: u32,
)where
T: MessageErrorDomain,
Post an error, warning or info message on the bus from inside an element. Read more
fn set_element_flags(&self, flags: ElementFlags)
fn unset_element_flags(&self, flags: ElementFlags)
fn element_flags(&self) -> ElementFlags
source§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 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,
Post an error, warning or info message on the bus from inside an element. Read more
fn post_error_message(&self, msg: ErrorMessage)
source§fn iterate_pads(&self) -> Iterator<Pad>
fn iterate_pads(&self) -> Iterator<Pad>
Retrieves an iterator of
self’s pads. The iterator should
be freed after usage. Also more specialized iterators exists such as
iterate_src_pads() or iterate_sink_pads(). Read moresource§fn iterate_sink_pads(&self) -> Iterator<Pad>
fn iterate_sink_pads(&self) -> Iterator<Pad>
Retrieves an iterator of
self’s sink pads. Read moresource§fn iterate_src_pads(&self) -> Iterator<Pad>
fn iterate_src_pads(&self) -> Iterator<Pad>
Retrieves an iterator of
self’s source pads. Read morefn pads(&self) -> Vec<Pad>
fn sink_pads(&self) -> Vec<Pad>
fn src_pads(&self) -> Vec<Pad>
fn num_pads(&self) -> u16
fn num_sink_pads(&self) -> u16
fn num_src_pads(&self) -> u16
source§fn add_property_deep_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool,
) -> NotifyWatchId
fn add_property_deep_notify_watch( &self, property_name: Option<&str>, include_value: bool, ) -> NotifyWatchId
property_name Read moresource§fn add_property_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
property_name Read moresource§fn remove_property_notify_watch(&self, watch_id: NotifyWatchId)
fn remove_property_notify_watch(&self, watch_id: NotifyWatchId)
watch_id Read moresource§fn query_convert<U>(&self, src_val: impl FormattedValue) -> Option<U>where
U: SpecificFormattedValueFullRange,
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>
source§fn query_duration<T>(&self) -> Option<T>where
T: SpecificFormattedValueIntrinsic,
fn query_duration<T>(&self) -> Option<T>where
T: SpecificFormattedValueIntrinsic,
Queries an element (usually top-level pipeline or playbin element) for the
total stream duration in nanoseconds. This query will only work once the
pipeline is prerolled (i.e. reached PAUSED or PLAYING state). The application
will receive an ASYNC_DONE message on the pipeline bus when that is the case. Read more
fn query_duration_generic( &self, format: Format, ) -> Option<GenericFormattedValue>
source§fn query_position<T>(&self) -> Option<T>where
T: SpecificFormattedValueIntrinsic,
fn query_position<T>(&self) -> Option<T>where
T: SpecificFormattedValueIntrinsic,
Queries an element (usually top-level pipeline or playbin element) for the
stream position in nanoseconds. This will be a value between 0 and the
stream duration (if the stream duration is known). This query will usually
only work once the pipeline is prerolled (i.e. reached PAUSED or PLAYING
state). The application will receive an ASYNC_DONE message on the pipeline
bus when that is the case. Read more
fn query_position_generic( &self, format: Format, ) -> Option<GenericFormattedValue>
source§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<V>(
&self,
rate: f64,
flags: SeekFlags,
start_type: SeekType,
start: V,
stop_type: SeekType,
stop: impl CompatibleFormattedValue<V>,
) -> Result<(), BoolError>where
V: FormattedValue,
Sends a seek event to an element. See
gst_event_new_seek() for the details of
the parameters. The seek event is sent to the element using
send_event(). Read moresource§fn seek_simple(
&self,
seek_flags: SeekFlags,
seek_pos: impl FormattedValue,
) -> Result<(), BoolError>
fn seek_simple( &self, seek_flags: SeekFlags, seek_pos: impl FormattedValue, ) -> Result<(), BoolError>
Simple API to perform a seek on the given element, meaning it just seeks
to the given position relative to the start of the stream. For more complex
operations like segment seeks (e.g. for looping) or changing the playback
rate or seeking relative to the last configured playback segment you should
use
seek(). Read moresource§fn call_async<F>(&self, func: F)
fn call_async<F>(&self, func: F)
Calls
func from another thread and passes user_data to it. This is to be
used for cases when a state change has to be performed from a streaming
thread, directly via ElementExt::set_state() or indirectly e.g. via SEEK
events. Read morefn call_async_future<F, T>( &self, func: F, ) -> Pin<Box<dyn Future<Output = T> + Send>>
source§fn current_running_time(&self) -> Option<ClockTime>
fn current_running_time(&self) -> Option<ClockTime>
Returns the running time of the element. The running time is the
element’s clock time minus its base time. Will return GST_CLOCK_TIME_NONE
if the element has no clock, or if its base time has not been set. Read more
source§fn current_clock_time(&self) -> Option<ClockTime>
fn current_clock_time(&self) -> Option<ClockTime>
Returns the current clock time of the element, as in, the time of the
element’s clock, or GST_CLOCK_TIME_NONE if there is no clock. Read more
source§fn request_pad_simple(&self, name: &str) -> Option<Pad>
fn request_pad_simple(&self, name: &str) -> Option<Pad>
The name of this function is confusing to people learning GStreamer.
request_pad_simple() aims at making it more explicit it is
a simplified ElementExt::request_pad(). Read moresource§fn link(&self, dest: &impl IsA<Element>) -> Result<(), BoolError>
fn link(&self, dest: &impl IsA<Element>) -> Result<(), BoolError>
Links
self to dest. The link must be from source to
destination; the other direction will not be tried. The function looks for
existing pads that aren’t linked yet. It will request new pads if necessary.
Such pads need to be released manually when unlinking.
If multiple links are possible, only one is established. Read moresource§fn link_filtered(
&self,
dest: &impl IsA<Element>,
filter: &Caps,
) -> Result<(), BoolError>
fn link_filtered( &self, dest: &impl IsA<Element>, filter: &Caps, ) -> Result<(), BoolError>
Links
self to dest using the given caps as filtercaps.
The link must be from source to
destination; the other direction will not be tried. The function looks for
existing pads that aren’t linked yet. It will request new pads if necessary.
If multiple links are possible, only one is established. Read moresource§fn link_pads(
&self,
srcpadname: Option<&str>,
dest: &impl IsA<Element>,
destpadname: Option<&str>,
) -> Result<(), BoolError>
fn link_pads( &self, srcpadname: Option<&str>, dest: &impl IsA<Element>, destpadname: Option<&str>, ) -> Result<(), BoolError>
Links the two named pads of the source and destination elements.
Side effect is that if one of the pads has no parent, it becomes a
child of the parent of the other element. If they have different
parents, the link fails. Read more
source§fn link_pads_filtered(
&self,
srcpadname: Option<&str>,
dest: &impl IsA<Element>,
destpadname: Option<&str>,
filter: &Caps,
) -> Result<(), BoolError>
fn link_pads_filtered( &self, srcpadname: Option<&str>, dest: &impl IsA<Element>, destpadname: Option<&str>, filter: &Caps, ) -> Result<(), BoolError>
Links the two named pads of the source and destination elements. Side effect
is that if one of the pads has no parent, it becomes a child of the parent of
the other element. If they have different parents, the link fails. If
caps
is not None, makes sure that the caps of the link is a subset of caps. Read moresource§fn link_pads_full(
&self,
srcpadname: Option<&str>,
dest: &impl IsA<Element>,
destpadname: Option<&str>,
flags: PadLinkCheck,
) -> Result<(), BoolError>
fn link_pads_full( &self, srcpadname: Option<&str>, dest: &impl IsA<Element>, destpadname: Option<&str>, flags: PadLinkCheck, ) -> Result<(), BoolError>
Links the two named pads of the source and destination elements.
Side effect is that if one of the pads has no parent, it becomes a
child of the parent of the other element. If they have different
parents, the link fails. Read more
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>
unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>
unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>
unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>
unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>
unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>
unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>
unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>
unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>
unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>
unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>
unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>
unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>
source§impl<O> GESTrackExt for O
impl<O> GESTrackExt for O
source§fn add_element(&self, object: &impl IsA<TrackElement>) -> Result<(), BoolError>
fn add_element(&self, object: &impl IsA<TrackElement>) -> Result<(), BoolError>
See
add_element(), which also gives an error. Read moresource§fn add_element_full(&self, object: &impl IsA<TrackElement>) -> Result<(), Error>
fn add_element_full(&self, object: &impl IsA<TrackElement>) -> Result<(), Error>
Adds the given track element to the track, which takes ownership of the
element. Read more
source§fn commit(&self) -> bool
fn commit(&self) -> bool
Commits all the pending changes for the elements contained in the
track. Read more
source§fn elements(&self) -> Vec<TrackElement>
fn elements(&self) -> Vec<TrackElement>
source§fn restriction_caps(&self) -> Option<Caps>
fn restriction_caps(&self) -> Option<Caps>
Gets the
restriction-caps of the track. Read moresource§fn remove_element(
&self,
object: &impl IsA<TrackElement>,
) -> Result<(), BoolError>
fn remove_element( &self, object: &impl IsA<TrackElement>, ) -> Result<(), BoolError>
See
remove_element_full(), which also returns an error. Read moresource§fn remove_element_full(
&self,
object: &impl IsA<TrackElement>,
) -> Result<(), Error>
fn remove_element_full( &self, object: &impl IsA<TrackElement>, ) -> Result<(), Error>
Removes the given track element from the track, which revokes
ownership of the element. Read more
source§fn set_restriction_caps(&self, caps: &Caps)
fn set_restriction_caps(&self, caps: &Caps)
Sets the
restriction-caps for the track. Read moresource§fn set_timeline(&self, timeline: &impl IsA<Timeline>)
fn set_timeline(&self, timeline: &impl IsA<Timeline>)
Informs the track that it belongs to the given timeline. Calling this
does not actually add the track to the timeline. For that, you should
use
TimelineExt::add_track(), which will also take care of informing
the track that it belongs to the timeline. As such, there is no need
for you to call this method.source§fn update_restriction_caps(&self, caps: &Caps)
fn update_restriction_caps(&self, caps: &Caps)
Updates the
restriction-caps of the track using the fields
found in the given caps. Each of the gst::Structure-s in caps is
compared against the existing structure with the same index in the
current restriction-caps. If there is no corresponding
existing structure at that index, then the new structure is simply
copied to that index. Otherwise, any fields in the new structure are
copied into the existing structure. This will replace existing values,
and may introduce new ones, but any fields ‘missing’ in the new
structure are left unchanged in the existing structure. Read moresource§fn track_type(&self) -> TrackType
fn track_type(&self) -> TrackType
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. Read moresource§fn connect_commited<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
fn connect_commited<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
This signal will be emitted once the changes initiated by
commit() have been executed in the backend. In particular,
this will be emitted whenever the underlying nlecomposition has been
committed (see nlecomposition::commited).source§fn connect_track_element_added<F: Fn(&Self, &TrackElement) + 'static>(
&self,
f: F,
) -> SignalHandlerId
fn connect_track_element_added<F: Fn(&Self, &TrackElement) + 'static>( &self, f: F, ) -> SignalHandlerId
Will be emitted after a track element is added to the track. Read more
source§fn connect_track_element_removed<F: Fn(&Self, &TrackElement) + 'static>(
&self,
f: F,
) -> SignalHandlerId
fn connect_track_element_removed<F: Fn(&Self, &TrackElement) + 'static>( &self, f: F, ) -> SignalHandlerId
Will be emitted after a track element is removed from the track. Read more
fn connect_duration_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId
fn connect_id_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
fn connect_mixing_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
fn connect_restriction_caps_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId
source§impl<O> GObjectExtManualGst for O
impl<O> GObjectExtManualGst for O
fn set_property_from_str(&self, name: &str, value: &str)
source§impl<O> GstBinExt for O
impl<O> GstBinExt for O
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) -> SignalHandlerId
fn connect_deep_element_added<F>(&self, f: F) -> SignalHandlerId
Will be emitted after the element was added to
sub_bin. Read moresource§fn connect_deep_element_removed<F>(&self, f: F) -> SignalHandlerId
fn connect_deep_element_removed<F>(&self, f: F) -> SignalHandlerId
Will be emitted after the element was removed from
sub_bin. Read moresource§fn connect_element_added<F>(&self, f: F) -> SignalHandlerId
fn connect_element_added<F>(&self, f: F) -> SignalHandlerId
Will be emitted after the element was added to the bin. Read more
source§fn connect_element_removed<F>(&self, f: F) -> SignalHandlerId
fn connect_element_removed<F>(&self, f: F) -> SignalHandlerId
Will be emitted after the element was removed from the bin. Read more
fn connect_async_handling_notify<F>(&self, f: F) -> SignalHandlerId
fn connect_message_forward_notify<F>(&self, f: F) -> SignalHandlerId
source§impl<O> GstBinExtManual for O
impl<O> GstBinExtManual for O
fn add_many( &self, elements: impl IntoIterator<Item = impl AsRef<Element>>, ) -> Result<(), BoolError>
fn remove_many( &self, elements: impl IntoIterator<Item = impl AsRef<Element>>, ) -> Result<(), BoolError>
fn connect_do_latency<F>(&self, f: F) -> SignalHandlerId
fn iterate_all_by_element_factory_name( &self, factory_name: &str, ) -> Iterator<Element>
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>
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 O
impl<O> GstObjectExt for O
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
source§fn has_active_control_bindings(&self) -> bool
fn has_active_control_bindings(&self) -> bool
Check if the
self has active controlled properties. Read moresource§fn remove_control_binding(&self, binding: &impl IsA<ControlBinding>) -> bool
fn remove_control_binding(&self, binding: &impl IsA<ControlBinding>) -> bool
Removes the corresponding
ControlBinding. If it was the
last ref of the binding, it will be disposed. Read moresource§fn set_control_binding_disabled(&self, property_name: &str, disabled: bool)
fn set_control_binding_disabled(&self, property_name: &str, disabled: bool)
This function is used to disable the control bindings on a property for
some time, i.e.
sync_values() will do nothing for the
property. Read moresource§fn set_control_bindings_disabled(&self, disabled: bool)
fn set_control_bindings_disabled(&self, disabled: bool)
This function is used to disable all controlled properties of the
self for
some time, i.e. sync_values() will do nothing. Read moresource§fn set_control_rate(&self, control_rate: impl Into<Option<ClockTime>>)
fn set_control_rate(&self, control_rate: impl Into<Option<ClockTime>>)
Change 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 set_parent(&self, parent: &impl IsA<Object>) -> Result<(), BoolError>
fn set_parent(&self, parent: &impl IsA<Object>) -> Result<(), BoolError>
Sets the parent of
self to parent. The object’s reference count will
be incremented, and any floating reference will be removed (see gst_object_ref_sink()). Read moresource§fn suggest_next_sync(&self) -> Option<ClockTime>
fn suggest_next_sync(&self) -> Option<ClockTime>
Returns a suggestion for timestamps where buffers should be split
to get best controller results. Read more
source§fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>
fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>
Sets the properties of the object, according to the
GstControlSources that
(maybe) handle them and for the given timestamp. Read moresource§fn unparent(&self)
fn unparent(&self)
Clear the parent of
self, removing the associated reference.
This function decreases the refcount of self. Read morefn connect_parent_notify<F>(&self, f: F) -> SignalHandlerId
source§impl<O> GstObjectExtManual for O
impl<O> GstObjectExtManual for O
fn connect_deep_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
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<'_, Self>
source§impl<T> IntoClosureReturnValue for T
impl<T> IntoClosureReturnValue for T
fn into_closure_return_value(self) -> Option<Value>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moresource§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>)
fn parent_instance_init<T>(instance: &mut InitializingObject<T>)
source§impl<O> MetaContainerExt for Owhere
O: IsA<MetaContainer>,
impl<O> MetaContainerExt for Owhere
O: IsA<MetaContainer>,
source§fn add_metas_from_string(&self, str: &str) -> bool
fn add_metas_from_string(&self, str: &str) -> bool
Deserializes the given string, and adds and sets the found fields and
their values on the container. The string should be the return of
metas_to_string(). Read moresource§fn check_meta_registered(&self, meta_item: &str) -> Option<(MetaFlag, Type)>
fn check_meta_registered(&self, meta_item: &str) -> Option<(MetaFlag, Type)>
Checks whether the specified field has been registered as static, and
gets the registered type and flags of the field, as used in
register_meta() and
register_static_meta(). Read moresource§fn foreach<P: FnMut(&MetaContainer, &str, &Value)>(&self, func: P)
fn foreach<P: FnMut(&MetaContainer, &str, &Value)>(&self, func: P)
Calls the given function on each of the meta container’s set metadata
fields. Read more
source§fn boolean(&self, meta_item: &str) -> Option<bool>
fn boolean(&self, meta_item: &str) -> Option<bool>
Gets the current boolean value of the specified field of the meta
container. If the field does not have a set value, or it is of the
wrong type, the method will fail. Read more
source§fn date(&self, meta_item: &str) -> Option<Date>
fn date(&self, meta_item: &str) -> Option<Date>
Gets the current date value of the specified field of the meta
container. If the field does not have a set value, or it is of the
wrong type, the method will fail. Read more
source§fn date_time(&self, meta_item: &str) -> Option<DateTime>
fn date_time(&self, meta_item: &str) -> Option<DateTime>
Gets the current date time value of the specified field of the meta
container. If the field does not have a set value, or it is of the
wrong type, the method will fail. Read more
source§fn double(&self, meta_item: &str) -> Option<f64>
fn double(&self, meta_item: &str) -> Option<f64>
Gets the current double value of the specified field of the meta
container. If the field does not have a set value, or it is of the
wrong type, the method will fail. Read more
source§fn float(&self, meta_item: &str) -> Option<f32>
fn float(&self, meta_item: &str) -> Option<f32>
Gets the current float value of the specified field of the meta
container. If the field does not have a set value, or it is of the
wrong type, the method will fail. Read more
source§fn int(&self, meta_item: &str) -> Option<i32>
fn int(&self, meta_item: &str) -> Option<i32>
Gets the current int value of the specified field of the meta
container. If the field does not have a set value, or it is of the
wrong type, the method will fail. Read more
source§fn int64(&self, meta_item: &str) -> Option<i64>
fn int64(&self, meta_item: &str) -> Option<i64>
Gets the current int64 value of the specified field of the meta
container. If the field does not have a set value, or it is of the
wrong type, the method will fail. Read more
source§fn marker_list(&self, key: &str) -> Option<MarkerList>
fn marker_list(&self, key: &str) -> Option<MarkerList>
Gets the current marker list value of the specified field of the meta
container. If the field does not have a set value, or it is of the
wrong type, the method will fail. Read more
source§fn meta(&self, key: &str) -> Option<Value>
fn meta(&self, key: &str) -> Option<Value>
Gets the current value of the specified field of the meta container. Read more
source§fn string(&self, meta_item: &str) -> Option<GString>
fn string(&self, meta_item: &str) -> Option<GString>
Gets the current string value of the specified field of the meta
container. If the field does not have a set value, or it is of the
wrong type, the method will fail. Read more
source§fn uint(&self, meta_item: &str) -> Option<u32>
fn uint(&self, meta_item: &str) -> Option<u32>
Gets the current uint value of the specified field of the meta
container. If the field does not have a set value, or it is of the
wrong type, the method will fail. Read more
source§fn uint64(&self, meta_item: &str) -> Option<u64>
fn uint64(&self, meta_item: &str) -> Option<u64>
Gets the current uint64 value of the specified field of the meta
container. If the field does not have a set value, or it is of the
wrong type, the method will fail. Read more
source§fn metas_to_string(&self) -> GString
fn metas_to_string(&self) -> GString
Serializes the set metadata fields of the meta container to a string. Read more
source§fn register_meta(&self, flags: MetaFlag, meta_item: &str, value: &Value) -> bool
fn register_meta(&self, flags: MetaFlag, meta_item: &str, value: &Value) -> bool
Sets the value of the specified field of the meta container to the
given value, and registers the field to only hold a value of the
same type. After calling this, only values of the same type as
value
can be set for this field. The given flags can be set to make this
field only readable after calling this method. Read moresource§fn register_meta_boolean(
&self,
flags: MetaFlag,
meta_item: &str,
value: bool,
) -> bool
fn register_meta_boolean( &self, flags: MetaFlag, meta_item: &str, value: bool, ) -> bool
Sets the value of the specified field of the meta container to the
given boolean value, and registers the field to only hold a boolean
typed value. After calling this, only boolean values can be set for
this field. The given flags can be set to make this field only
readable after calling this method. Read more
source§fn register_meta_date(
&self,
flags: MetaFlag,
meta_item: &str,
value: &Date,
) -> bool
fn register_meta_date( &self, flags: MetaFlag, meta_item: &str, value: &Date, ) -> bool
Sets the value of the specified field of the meta container to the
given date value, and registers the field to only hold a date
typed value. After calling this, only date values can be set for
this field. The given flags can be set to make this field only
readable after calling this method. Read more
source§fn register_meta_date_time(
&self,
flags: MetaFlag,
meta_item: &str,
value: &DateTime,
) -> bool
fn register_meta_date_time( &self, flags: MetaFlag, meta_item: &str, value: &DateTime, ) -> bool
Sets the value of the specified field of the meta container to the
given date time value, and registers the field to only hold a date time
typed value. After calling this, only date time values can be set for
this field. The given flags can be set to make this field only
readable after calling this method. Read more
source§fn register_meta_double(
&self,
flags: MetaFlag,
meta_item: &str,
value: f64,
) -> bool
fn register_meta_double( &self, flags: MetaFlag, meta_item: &str, value: f64, ) -> bool
Sets the value of the specified field of the meta container to the
given double value, and registers the field to only hold a double
typed value. After calling this, only double values can be set for
this field. The given flags can be set to make this field only
readable after calling this method. Read more
source§fn register_meta_float(
&self,
flags: MetaFlag,
meta_item: &str,
value: f32,
) -> bool
fn register_meta_float( &self, flags: MetaFlag, meta_item: &str, value: f32, ) -> bool
Sets the value of the specified field of the meta container to the
given float value, and registers the field to only hold a float
typed value. After calling this, only float values can be set for
this field. The given flags can be set to make this field only
readable after calling this method. Read more
source§fn register_meta_int(
&self,
flags: MetaFlag,
meta_item: &str,
value: i32,
) -> bool
fn register_meta_int( &self, flags: MetaFlag, meta_item: &str, value: i32, ) -> bool
Sets the value of the specified field of the meta container to the
given int value, and registers the field to only hold an int
typed value. After calling this, only int values can be set for
this field. The given flags can be set to make this field only
readable after calling this method. Read more
source§fn register_meta_int64(
&self,
flags: MetaFlag,
meta_item: &str,
value: i64,
) -> bool
fn register_meta_int64( &self, flags: MetaFlag, meta_item: &str, value: i64, ) -> bool
Sets the value of the specified field of the meta container to the
given int64 value, and registers the field to only hold an int64
typed value. After calling this, only int64 values can be set for
this field. The given flags can be set to make this field only
readable after calling this method. Read more
source§fn register_meta_string(
&self,
flags: MetaFlag,
meta_item: &str,
value: &str,
) -> bool
fn register_meta_string( &self, flags: MetaFlag, meta_item: &str, value: &str, ) -> bool
Sets the value of the specified field of the meta container to the
given string value, and registers the field to only hold a string
typed value. After calling this, only string values can be set for
this field. The given flags can be set to make this field only
readable after calling this method. Read more
source§fn register_meta_uint(
&self,
flags: MetaFlag,
meta_item: &str,
value: u32,
) -> bool
fn register_meta_uint( &self, flags: MetaFlag, meta_item: &str, value: u32, ) -> bool
Sets the value of the specified field of the meta container to the
given uint value, and registers the field to only hold a uint
typed value. After calling this, only uint values can be set for
this field. The given flags can be set to make this field only
readable after calling this method. Read more
source§fn register_meta_uint64(
&self,
flags: MetaFlag,
meta_item: &str,
value: u64,
) -> bool
fn register_meta_uint64( &self, flags: MetaFlag, meta_item: &str, value: u64, ) -> bool
Sets the value of the specified field of the meta container to the
given uint64 value, and registers the field to only hold a uint64
typed value. After calling this, only uint64 values can be set for
this field. The given flags can be set to make this field only
readable after calling this method. Read more
source§fn register_static_meta(
&self,
flags: MetaFlag,
meta_item: &str,
type_: Type,
) -> bool
fn register_static_meta( &self, flags: MetaFlag, meta_item: &str, type_: Type, ) -> bool
Registers a static metadata field on the container to only hold the
specified type. After calling this, setting a value under this field
can only succeed if its type matches the registered type of the field. Read more
source§fn set_boolean(&self, meta_item: &str, value: bool) -> bool
fn set_boolean(&self, meta_item: &str, value: bool) -> bool
Sets the value of the specified field of the meta container to the
given boolean value. Read more
source§fn set_date(&self, meta_item: &str, value: &Date) -> bool
fn set_date(&self, meta_item: &str, value: &Date) -> bool
Sets the value of the specified field of the meta container to the
given date value. Read more
source§fn set_date_time(&self, meta_item: &str, value: &DateTime) -> bool
fn set_date_time(&self, meta_item: &str, value: &DateTime) -> bool
Sets the value of the specified field of the meta container to the
given date time value. Read more
source§fn set_double(&self, meta_item: &str, value: f64) -> bool
fn set_double(&self, meta_item: &str, value: f64) -> bool
Sets the value of the specified field of the meta container to the
given double value. Read more
source§fn set_float(&self, meta_item: &str, value: f32) -> bool
fn set_float(&self, meta_item: &str, value: f32) -> bool
Sets the value of the specified field of the meta container to the
given float value. Read more
source§fn set_int(&self, meta_item: &str, value: i32) -> bool
fn set_int(&self, meta_item: &str, value: i32) -> bool
Sets the value of the specified field of the meta container to the
given int value. Read more
source§fn set_int64(&self, meta_item: &str, value: i64) -> bool
fn set_int64(&self, meta_item: &str, value: i64) -> bool
Sets the value of the specified field of the meta container to the
given int64 value. Read more
source§fn set_marker_list(&self, meta_item: &str, list: &MarkerList) -> bool
fn set_marker_list(&self, meta_item: &str, list: &MarkerList) -> bool
Sets the value of the specified field of the meta container to the
given marker list value. Read more
source§fn set_string(&self, meta_item: &str, value: &str) -> bool
fn set_string(&self, meta_item: &str, value: &str) -> bool
Sets the value of the specified field of the meta container to the
given string value. Read more
source§fn set_uint(&self, meta_item: &str, value: u32) -> bool
fn set_uint(&self, meta_item: &str, value: u32) -> bool
Sets the value of the specified field of the meta container to the
given uint value. Read more
source§fn set_uint64(&self, meta_item: &str, value: u64) -> bool
fn set_uint64(&self, meta_item: &str, value: u64) -> bool
Sets the value of the specified field of the meta container to the
given uint64 value. Read more
source§fn connect_notify_meta<F: Fn(&Self, &str, Option<&Value>) + 'static>(
&self,
detail: Option<&str>,
f: F,
) -> SignalHandlerId
fn connect_notify_meta<F: Fn(&Self, &str, Option<&Value>) + 'static>( &self, detail: Option<&str>, f: F, ) -> SignalHandlerId
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,
) -> SignalHandlerId
fn connect<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
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,
) -> SignalHandlerId
fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
Connect to the signal
signal_id on this object. Read moresource§fn connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F,
) -> SignalHandlerId
fn connect_local<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
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,
) -> SignalHandlerId
fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
Connect to the signal
signal_id on this object. Read moresource§unsafe fn connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F,
) -> SignalHandlerId
unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
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,
) -> SignalHandlerId
unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
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) -> SignalHandlerId
fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
Connect to the
notify signal of the object. Read moresource§fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
Connect to the
notify signal of the object. Read moresource§unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F,
) -> SignalHandlerId
unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F, ) -> SignalHandlerId
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>
fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
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<'a, 'f, 't, O>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str,
) -> BindingBuilder<'a, 'f, 't>where
O: ObjectType,
fn bind_property<'a, 'f, 't, O>(
&'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.