Struct gstreamer_audio::AudioSrc
source · pub struct AudioSrc { /* private fields */ }Expand description
This is the most simple base class for audio sources that only requires subclasses to implement a set of simple functions:
open():Open the device.prepare():Configure the device with the specified format.read():Read samples from the device.reset():Unblock reads and flush the device.delay():Get the number of samples in the device but not yet read.unprepare():Undo operations done by prepare.close():Close the device.
All scheduling of samples and timestamps is done in this base class
together with AudioBaseSrc using a default implementation of a
GstAudioRingBuffer that uses threads.
§Implements
AudioBaseSrcExt, gst_base::prelude::BaseSrcExt, gst::prelude::ElementExt, gst::prelude::GstObjectExt, [trait@glib::ObjectExt]
GLib type: GObject with reference counted clone semantics.
Implementations§
Trait Implementations§
source§impl HasParamSpec for AudioSrc
impl HasParamSpec for AudioSrc
source§impl<T: AudioSrcImpl> IsSubclassable<T> for AudioSrc
impl<T: AudioSrcImpl> IsSubclassable<T> for AudioSrc
source§fn class_init(klass: &mut Class<Self>)
fn class_init(klass: &mut Class<Self>)
Override the virtual methods of this class for the given subclass and do other class
initialization. Read more
source§fn instance_init(instance: &mut InitializingObject<T>)
fn instance_init(instance: &mut InitializingObject<T>)
Instance specific initialization. Read more
source§impl Ord for AudioSrc
impl Ord for AudioSrc
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 ParentClassIs for AudioSrc
impl ParentClassIs for AudioSrc
type Parent = AudioBaseSrc
source§impl<OT: ObjectType> PartialEq<OT> for AudioSrc
impl<OT: ObjectType> PartialEq<OT> for AudioSrc
source§impl<OT: ObjectType> PartialOrd<OT> for AudioSrc
impl<OT: ObjectType> PartialOrd<OT> for AudioSrc
source§impl StaticType for AudioSrc
impl StaticType for AudioSrc
source§fn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of
Self.impl Eq for AudioSrc
impl IsA<AudioBaseSrc> for AudioSrc
impl IsA<BaseSrc> for AudioSrc
impl IsA<Element> for AudioSrc
impl IsA<Object> for AudioSrc
impl Send for AudioSrc
impl Sync for AudioSrc
Auto Trait Implementations§
impl Freeze for AudioSrc
impl RefUnwindSafe for AudioSrc
impl Unpin for AudioSrc
impl UnwindSafe for AudioSrc
Blanket Implementations§
source§impl<O> AudioBaseSrcExt for Owhere
O: IsA<AudioBaseSrc>,
impl<O> AudioBaseSrcExt for Owhere
O: IsA<AudioBaseSrc>,
source§fn is_provide_clock(&self) -> bool
fn is_provide_clock(&self) -> bool
Queries whether
self will provide a clock or not. See also
gst_audio_base_src_set_provide_clock. Read moresource§fn set_provide_clock(&self, provide: bool)
fn set_provide_clock(&self, provide: bool)
Controls whether
self will provide a clock or not. If provide is true,
[ElementExtManual::provide_clock()][crate::gst::prelude::ElementExtManual::provide_clock()] will return a clock that reflects the datarate
of self. If provide is false, [ElementExtManual::provide_clock()][crate::gst::prelude::ElementExtManual::provide_clock()] will return NULL. Read moresource§fn actual_buffer_time(&self) -> i64
fn actual_buffer_time(&self) -> i64
Actual configured size of audio buffer in microseconds.
source§fn actual_latency_time(&self) -> i64
fn actual_latency_time(&self) -> i64
Actual configured audio latency in microseconds.
fn buffer_time(&self) -> i64
fn set_buffer_time(&self, buffer_time: i64)
fn latency_time(&self) -> i64
fn set_latency_time(&self, latency_time: i64)
fn connect_actual_buffer_time_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
fn connect_actual_latency_time_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
fn connect_buffer_time_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
fn connect_latency_time_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
fn connect_provide_clock_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
fn connect_slave_method_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
source§impl<O> BaseSrcExt for O
impl<O> BaseSrcExt for O
source§fn blocksize(&self) -> u32
fn blocksize(&self) -> u32
Get the number of bytes that
self will push out with each buffer. Read moresource§fn buffer_pool(&self) -> Option<BufferPool>
fn buffer_pool(&self) -> Option<BufferPool>
Returns Read more
source§fn does_timestamp(&self) -> bool
fn does_timestamp(&self) -> bool
Query if
self timestamps outgoing buffers based on the current running_time. Read moresource§fn negotiate(&self) -> bool
fn negotiate(&self) -> bool
Negotiates src pad caps with downstream elements.
Unmarks GST_PAD_FLAG_NEED_RECONFIGURE in any case. But marks it again
if
GstBaseSrcClass::negotiate fails. Read moresource§fn new_seamless_segment(&self, start: i64, stop: i64, time: i64) -> bool
fn new_seamless_segment(&self, start: i64, stop: i64, time: i64) -> bool
👎Deprecated: Since 1.18
Prepare a new seamless segment for emission downstream. This function must
only be called by derived sub-classes, and only from the
GstBaseSrcClass::create function,
as the stream-lock needs to be held. Read moresource§fn new_segment(
&self,
segment: &FormattedSegment<GenericFormattedValue>,
) -> Result<(), BoolError>
fn new_segment( &self, segment: &FormattedSegment<GenericFormattedValue>, ) -> Result<(), BoolError>
Prepare a new segment for emission downstream. This function must
only be called by derived sub-classes, and only from the
GstBaseSrcClass::create function,
as the stream-lock needs to be held. Read moresource§fn push_segment(
&self,
segment: &FormattedSegment<GenericFormattedValue>,
) -> bool
fn push_segment( &self, segment: &FormattedSegment<GenericFormattedValue>, ) -> bool
Send a new segment downstream. This function must
only be called by derived sub-classes, and only from the
GstBaseSrcClass::create function,
as the stream-lock needs to be held.
This method also requires that an out caps has been configured, so
set_caps() needs to have been called before. Read moresource§fn set_async(&self, async_: bool)
fn set_async(&self, async_: bool)
Configure async behaviour in
self, no state change will block. The open,
close, start, stop, play and pause virtual methods will be executed in a
different thread and are thus allowed to perform blocking operations. Any
blocking operation should be unblocked with the unlock vmethod. Read moresource§fn set_automatic_eos(&self, automatic_eos: bool)
fn set_automatic_eos(&self, automatic_eos: bool)
source§fn set_blocksize(&self, blocksize: u32)
fn set_blocksize(&self, blocksize: u32)
Set the number of bytes that
self will push out with each buffer. When
blocksize is set to -1, a default length will be used. Read moresource§fn set_caps(&self, caps: &Caps) -> Result<(), BoolError>
fn set_caps(&self, caps: &Caps) -> Result<(), BoolError>
Set new caps on the basesrc source pad. Read more
source§fn set_do_timestamp(&self, timestamp: bool)
fn set_do_timestamp(&self, timestamp: bool)
Configure
self to automatically timestamp outgoing buffers based on the
current running_time of the pipeline. This property is mostly useful for live
sources. Read moresource§fn set_dynamic_size(&self, dynamic: bool)
fn set_dynamic_size(&self, dynamic: bool)
If not
dynamic, size is only updated when needed, such as when trying to
read past current tracked size. Otherwise, size is checked for upon each
read. Read moresource§fn set_format(&self, format: Format)
fn set_format(&self, format: Format)
Sets the default format of the source. This will be the format used
for sending SEGMENT events and for performing seeks. Read more
source§fn start_complete(&self, ret: impl Into<FlowReturn>)
fn start_complete(&self, ret: impl Into<FlowReturn>)
Complete an asynchronous start operation. When the subclass overrides the
start method, it should call
start_complete() when the start
operation completes either from the same thread or from an asynchronous
helper thread. Read moresource§fn start_wait(&self) -> Result<FlowSuccess, FlowError>
fn start_wait(&self) -> Result<FlowSuccess, FlowError>
Wait until the start operation completes. Read more
source§fn wait_playing(&self) -> Result<FlowSuccess, FlowError>
fn wait_playing(&self) -> Result<FlowSuccess, FlowError>
If the
GstBaseSrcClass::create method performs its own synchronisation
against the clock it must unblock when going from PLAYING to the PAUSED state
and call this method before continuing to produce the remaining data. Read moresource§fn is_automatic_eos(&self) -> bool
fn is_automatic_eos(&self) -> bool
fn num_buffers(&self) -> i32
fn set_num_buffers(&self, num_buffers: i32)
fn is_typefind(&self) -> bool
fn set_typefind(&self, typefind: bool)
fn connect_automatic_eos_notify<F>(&self, f: F) -> SignalHandlerId
fn connect_blocksize_notify<F>(&self, f: F) -> SignalHandlerId
fn connect_do_timestamp_notify<F>(&self, f: F) -> SignalHandlerId
fn connect_num_buffers_notify<F>(&self, f: F) -> SignalHandlerId
fn connect_typefind_notify<F>(&self, f: F) -> SignalHandlerId
source§impl<O> BaseSrcExtManual for O
impl<O> BaseSrcExtManual for O
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<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> GObjectExtManualGst for O
impl<O> GObjectExtManualGst for O
fn set_property_from_str(&self, name: &str, value: &str)
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<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.
source§impl<T> ToSendValue for T
impl<T> ToSendValue for T
source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
Returns a
SendValue clone of self.