Struct gstreamer_app::AppSink
source · pub struct AppSink { /* private fields */ }
Expand description
Appsink is a sink plugin that supports many different methods for making the application get a handle on the GStreamer data in a pipeline. Unlike most GStreamer elements, Appsink provides external API functions.
appsink can be used by linking to the gstappsink.h header file to access the methods or by using the appsink action signals and properties.
The normal way of retrieving samples from appsink is by using the
pull_sample()
and pull_preroll()
methods.
These methods block until a sample becomes available in the sink or when the
sink is shut down or reaches EOS. There are also timed variants of these
methods, try_pull_sample()
and try_pull_preroll()
,
which accept a timeout parameter to limit the amount of time to wait.
Appsink will internally use a queue to collect buffers from the streaming thread. If the application is not pulling samples fast enough, this queue will consume a lot of memory over time. The “max-buffers”, “max-time” and “max-bytes” properties can be used to limit the queue size. The “drop” property controls whether the streaming thread blocks or if older buffers are dropped when the maximum queue size is reached. Note that blocking the streaming thread can negatively affect real-time performance and should be avoided.
If a blocking behaviour is not desirable, setting the “emit-signals” property
to true
will make appsink emit the “new-sample” and “new-preroll” signals
when a sample can be pulled without blocking.
The “caps” property on appsink can be used to control the formats that appsink can receive. This property can contain non-fixed caps, the format of the pulled samples can be obtained by getting the sample caps.
If one of the pull-preroll or pull-sample methods return None
, the appsink
is stopped or in the EOS state. You can check for the EOS state with the
“eos” property or with the is_eos()
method.
The eos signal can also be used to be informed when the EOS state is reached to avoid polling.
§Properties
§buffer-list
Readable | Writeable
§caps
Readable | Writeable
§drop
Readable | Writeable
§emit-signals
Readable | Writeable
§eos
Readable
§max-buffers
Maximum amount of buffers in the queue (0 = unlimited).
Readable | Writeable
§max-bytes
Maximum amount of bytes in the queue (0 = unlimited)
Readable | Writeable
§max-time
Maximum total duration of data in the queue (0 = unlimited)
Readable | Writeable
§wait-on-eos
Wait for all buffers to be processed after receiving an EOS.
In cases where it is uncertain if an appsink
will have a consumer for its buffers
when it receives an EOS, set to false
to ensure that the appsink
will not hang.
Readable | Writeable
BaseSink
§async
If set to true
, the basesink will perform asynchronous state changes.
When set to false
, the sink will not signal the parent when it prerolls.
Use this option when dealing with sparse streams or when synchronisation is
not required.
Readable | Writeable
§blocksize
The amount of bytes to pull when operating in pull mode.
Readable | Writeable
§enable-last-sample
Enable the last-sample property. If false
, basesink doesn’t keep a
reference to the last buffer arrived and the last-sample property is always
set to None
. This can be useful if you need buffers to be released as soon
as possible, eg. if you’re using a buffer pool.
Readable | Writeable
§last-sample
The last buffer that arrived in the sink and was used for preroll or for
rendering. This property can be used to generate thumbnails. This property
can be None
when the sink has not yet received a buffer.
Readable
§max-bitrate
Control the maximum amount of bits that will be rendered per second. Setting this property to a value bigger than 0 will make the sink delay rendering of the buffers when it would exceed to max-bitrate.
Readable | Writeable
§max-lateness
Readable | Writeable
§processing-deadline
Maximum amount of time (in nanoseconds) that the pipeline can take for processing the buffer. This is added to the latency of live pipelines.
Readable | Writeable
§qos
Readable | Writeable
§render-delay
The additional delay between synchronisation and actual rendering of the media. This property will add additional latency to the device in order to make other sinks compensate for the delay.
Readable | Writeable
§stats
Various GstBaseSink
statistics. This property returns a gst::Structure
with name application/x-gst-base-sink-stats
with the following fields:
- “average-rate” G_TYPE_DOUBLE average frame rate
- “dropped” G_TYPE_UINT64 Number of dropped frames
- “rendered” G_TYPE_UINT64 Number of rendered frames
Readable
§sync
Readable | Writeable
§throttle-time
The time to insert between buffers. This property can be used to control the maximum amount of buffers per second to render. Setting this property to a value bigger than 0 will make the sink create THROTTLE QoS events.
Readable | Writeable
§ts-offset
Controls the final synchronisation, a negative value will render the buffer earlier while a positive value delays playback. This property can be used to fix synchronisation in bad files.
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
GstBin::element-added
or GstBin::element-removed
signals on the parent to
achieve a similar effect.
Readable | Writeable
§Signals
§eos
Signal that the end-of-stream has been reached. This signal is emitted from the streaming thread.
§new-preroll
Signal that a new preroll sample is available.
This signal is emitted from the streaming thread and only when the
“emit-signals” property is true
.
The new preroll sample can be retrieved with the “pull-preroll” action
signal or AppSink::pull_preroll()
either from this signal callback
or from any other thread.
Note that this signal is only emitted when the “emit-signals” property is
set to true
, which it is not by default for performance reasons.
§new-sample
Signal that a new sample is available.
This signal is emitted from the streaming thread and only when the
“emit-signals” property is true
.
The new sample can be retrieved with the “pull-sample” action
signal or AppSink::pull_sample()
either from this signal callback
or from any other thread.
Note that this signal is only emitted when the “emit-signals” property is
set to true
, which it is not by default for performance reasons.
§new-serialized-event
Signal that a new downstream serialized event is available.
This signal is emitted from the streaming thread and only when the
“emit-signals” property is true
.
The new event can be retrieved with the “try-pull-object” action
signal or AppSink::pull_object()
either from this signal callback
or from any other thread.
EOS will not be notified using this signal, use eos
instead.
EOS cannot be pulled either, use AppSink::is_eos()
to check for it.
Note that this signal is only emitted when the “emit-signals” property is
set to true
, which it is not by default for performance reasons.
The callback should return true
if the event has been handled, which will
skip basesink handling of the event, false
otherwise.
§propose-allocation
Signal that a new propose_allocation query is available.
This signal is emitted from the streaming thread and only when the
“emit-signals” property is true
.
§pull-preroll
Get the last preroll sample in appsink
. This was the sample that caused the
appsink to preroll in the PAUSED state.
This function is typically used when dealing with a pipeline in the PAUSED state. Calling this function after doing a seek will give the sample right after the seek position.
Calling this function will clear the internal reference to the preroll buffer.
Note that the preroll sample will also be returned as the first sample
when calling AppSink::pull_sample()
or the “pull-sample” action signal.
If an EOS event was received before any buffers, this function returns
None
. Use gst_app_sink_is_eos () to check for the EOS condition.
This function blocks until a preroll sample or EOS is received or the appsink element is set to the READY/NULL state.
Action
§pull-sample
This function blocks until a sample or EOS becomes available or the appsink element is set to the READY/NULL state.
This function will only return samples when the appsink is in the PLAYING state. All rendered samples will be put in a queue so that the application can pull samples at its own rate.
Note that when the application does not pull samples fast enough, the queued samples could consume a lot of memory, especially when dealing with raw video frames. It’s possible to control the behaviour of the queue with the “drop” and “max-buffers” / “max-bytes” / “max-time” set of properties.
If an EOS event was received before any buffers, this function returns
None
. Use gst_app_sink_is_eos () to check for the EOS condition.
Action
§try-pull-object
This function blocks until a sample or an event becomes available or the appsink element is set to the READY/NULL state or the timeout expires.
This function will only return samples when the appsink is in the PLAYING state. All rendered samples and events will be put in a queue so that the application can pull them at its own rate. Events can be pulled when the appsink is in the READY, PAUSED or PLAYING state.
Note that when the application does not pull samples fast enough, the queued samples could consume a lot of memory, especially when dealing with raw video frames. It’s possible to control the behaviour of the queue with the “drop” and “max-buffers” / “max-bytes” / “max-time” set of properties.
This function will only pull serialized events, excluding
the EOS event for which this functions returns
None
. Use AppSink::is_eos()
to check for the EOS condition.
This signal is a variant of try-pull-sample
: that can be used
to handle incoming events as well as samples.
Note that future releases may extend this API to return other object types so make sure that your code is checking for the actual type it is handling.
Action
§try-pull-preroll
Get the last preroll sample in appsink
. This was the sample that caused the
appsink to preroll in the PAUSED state.
This function is typically used when dealing with a pipeline in the PAUSED state. Calling this function after doing a seek will give the sample right after the seek position.
Calling this function will clear the internal reference to the preroll buffer.
Note that the preroll sample will also be returned as the first sample
when calling AppSink::pull_sample()
or the “pull-sample” action signal.
If an EOS event was received before any buffers or the timeout expires,
this function returns None
. Use gst_app_sink_is_eos () to check for the EOS
condition.
This function blocks until a preroll sample or EOS is received, the appsink element is set to the READY/NULL state, or the timeout expires.
Action
§try-pull-sample
This function blocks until a sample or EOS becomes available or the appsink element is set to the READY/NULL state or the timeout expires.
This function will only return samples when the appsink is in the PLAYING state. All rendered samples will be put in a queue so that the application can pull samples at its own rate.
Note that when the application does not pull samples fast enough, the queued samples could consume a lot of memory, especially when dealing with raw video frames. It’s possible to control the behaviour of the queue with the “drop” and “max-buffers” / “max-bytes” / “max-time” set of properties.
If an EOS event was received before any buffers or the timeout expires,
this function returns None
. Use gst_app_sink_is_eos () to check
for the EOS condition.
Action
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 GstPad
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 GstPad
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
§Implements
gst::prelude::ElementExt
, gst::prelude::ObjectExt
, [trait@glib::ObjectExt
], gst::prelude::URIHandlerExt
GLib type: GObject with reference counted clone semantics.
Implementations§
source§impl AppSink
impl AppSink
sourcepub fn is_buffer_list_support(&self) -> bool
pub fn is_buffer_list_support(&self) -> bool
sourcepub fn max_buffers(&self) -> u32
pub fn max_buffers(&self) -> u32
Get the maximum amount of buffers that can be queued in self
.
§Returns
The maximum amount of buffers that can be queued.
sourcepub fn max_bytes(&self) -> u64
pub fn max_bytes(&self) -> u64
Get the maximum total size, in bytes, that can be queued in self
.
§Returns
The maximum amount of bytes that can be queued
sourcepub fn max_time(&self) -> Option<ClockTime>
pub fn max_time(&self) -> Option<ClockTime>
Get the maximum total duration that can be queued in self
.
§Returns
The maximum total duration that can be queued.
sourcepub fn is_wait_on_eos(&self) -> bool
pub fn is_wait_on_eos(&self) -> bool
sourcepub fn pull_object(&self) -> Result<MiniObject, BoolError>
pub fn pull_object(&self) -> Result<MiniObject, BoolError>
This function blocks until a sample or an event becomes available or the appsink element is set to the READY/NULL state.
This function will only return samples when the appsink is in the PLAYING state. All rendered buffers and events will be put in a queue so that the application can pull them at its own rate. Note that when the application does not pull samples fast enough, the queued buffers could consume a lot of memory, especially when dealing with raw video frames. Events can be pulled when the appsink is in the READY, PAUSED or PLAYING state.
This function will only pull serialized events, excluding
the EOS event for which this functions returns
None
. Use is_eos()
to check for the EOS condition.
This method is a variant of pull_sample()
that can be used
to handle incoming events events as well as samples.
Note that future releases may extend this API to return other object types so make sure that your code is checking for the actual type it is handling.
§Returns
a gst::Sample
, or a GstEvent
or NULL when the appsink is stopped or EOS.
Call gst_mini_object_unref()
after usage.
sourcepub fn pull_preroll(&self) -> Result<Sample, BoolError>
pub fn pull_preroll(&self) -> Result<Sample, BoolError>
Get the last preroll sample in self
. This was the sample that caused the
appsink to preroll in the PAUSED state.
This function is typically used when dealing with a pipeline in the PAUSED state. Calling this function after doing a seek will give the sample right after the seek position.
Calling this function will clear the internal reference to the preroll buffer.
Note that the preroll sample will also be returned as the first sample
when calling pull_sample()
.
If an EOS event was received before any buffers, this function returns
None
. Use gst_app_sink_is_eos () to check for the EOS condition.
This function blocks until a preroll sample or EOS is received or the appsink element is set to the READY/NULL state.
§Returns
a gst::Sample
or NULL when the appsink is stopped or EOS.
Call gst_sample_unref()
after usage.
sourcepub fn pull_sample(&self) -> Result<Sample, BoolError>
pub fn pull_sample(&self) -> Result<Sample, BoolError>
This function blocks until a sample or EOS becomes available or the appsink element is set to the READY/NULL state.
This function will only return samples when the appsink is in the PLAYING state. All rendered buffers will be put in a queue so that the application can pull samples at its own rate. Note that when the application does not pull samples fast enough, the queued buffers could consume a lot of memory, especially when dealing with raw video frames.
If an EOS event was received before any buffers, this function returns
None
. Use gst_app_sink_is_eos () to check for the EOS condition.
§Returns
a gst::Sample
or NULL when the appsink is stopped or EOS.
Call gst_sample_unref()
after usage.
sourcepub fn set_buffer_list_support(&self, enable_lists: bool)
pub fn set_buffer_list_support(&self, enable_lists: bool)
Instruct self
to enable or disable buffer list support.
For backwards-compatibility reasons applications need to opt in to indicate that they will be able to handle buffer lists.
§enable_lists
enable or disable buffer list support
sourcepub fn set_caps(&self, caps: Option<&Caps>)
pub fn set_caps(&self, caps: Option<&Caps>)
Set the capabilities on the appsink element. This function takes
a copy of the caps structure. After calling this method, the sink will only
accept caps that match caps
. If caps
is non-fixed, or incomplete,
you must check the caps on the samples to get the actual used caps.
§caps
caps to set
sourcepub fn set_drop(&self, drop: bool)
pub fn set_drop(&self, drop: bool)
Instruct self
to drop old buffers when the maximum amount of queued
data is reached, that is, when any configured limit is hit (max-buffers, max-time or max-bytes).
§drop
the new state
sourcepub fn set_max_buffers(&self, max: u32)
pub fn set_max_buffers(&self, max: u32)
Set the maximum amount of buffers that can be queued in self
. After this
amount of buffers are queued in appsink, any more buffers will block upstream
elements until a sample is pulled from self
, unless ‘drop’ is set, in which
case new buffers will be discarded.
§max
the maximum number of buffers to queue
sourcepub fn set_max_bytes(&self, max: u64)
pub fn set_max_bytes(&self, max: u64)
Set the maximum total size that can be queued in self
. After this
amount of buffers are queued in appsink, any more buffers will block upstream
elements until a sample is pulled from self
, unless ‘drop’ is set, in which
case new buffers will be discarded.
§max
the maximum total size of buffers to queue, in bytes
sourcepub fn set_max_time(&self, max: impl Into<Option<ClockTime>>)
pub fn set_max_time(&self, max: impl Into<Option<ClockTime>>)
Set the maximum total duration that can be queued in self
. After this
amount of buffers are queued in appsink, any more buffers will block upstream
elements until a sample is pulled from self
, unless ‘drop’ is set, in which
case new buffers will be discarded.
§max
the maximum total duration to queue
sourcepub fn set_wait_on_eos(&self, wait: bool)
pub fn set_wait_on_eos(&self, wait: bool)
sourcepub fn try_pull_object(
&self,
timeout: impl Into<Option<ClockTime>>,
) -> Option<MiniObject>
pub fn try_pull_object( &self, timeout: impl Into<Option<ClockTime>>, ) -> Option<MiniObject>
This function blocks until a sample or an event or EOS becomes available or the appsink element is set to the READY/NULL state or the timeout expires.
This function will only return samples when the appsink is in the PLAYING state. All rendered buffers and events will be put in a queue so that the application can pull them at its own rate. Note that when the application does not pull samples fast enough, the queued buffers could consume a lot of memory, especially when dealing with raw video frames. Events can be pulled when the appsink is in the READY, PAUSED or PLAYING state.
This function will only pull serialized events, excluding
the EOS event for which this functions returns
None
. Use is_eos()
to check for the EOS condition.
This method is a variant of try_pull_sample()
that can be used
to handle incoming events events as well as samples.
Note that future releases may extend this API to return other object types so make sure that your code is checking for the actual type it is handling.
§timeout
the maximum amount of time to wait for a sample
§Returns
a gst::Sample
, or GstEvent
or NULL when the appsink is stopped or EOS or the timeout expires.
Call gst_mini_object_unref()
after usage.
sourcepub fn try_pull_preroll(
&self,
timeout: impl Into<Option<ClockTime>>,
) -> Option<Sample>
pub fn try_pull_preroll( &self, timeout: impl Into<Option<ClockTime>>, ) -> Option<Sample>
Get the last preroll sample in self
. This was the sample that caused the
appsink to preroll in the PAUSED state.
This function is typically used when dealing with a pipeline in the PAUSED state. Calling this function after doing a seek will give the sample right after the seek position.
Calling this function will clear the internal reference to the preroll buffer.
Note that the preroll sample will also be returned as the first sample
when calling pull_sample()
.
If an EOS event was received before any buffers or the timeout expires,
this function returns None
. Use gst_app_sink_is_eos () to check for the EOS
condition.
This function blocks until a preroll sample or EOS is received, the appsink element is set to the READY/NULL state, or the timeout expires.
§timeout
the maximum amount of time to wait for the preroll sample
§Returns
a gst::Sample
or NULL when the appsink is stopped or EOS or the timeout expires.
Call gst_sample_unref()
after usage.
sourcepub fn try_pull_sample(
&self,
timeout: impl Into<Option<ClockTime>>,
) -> Option<Sample>
pub fn try_pull_sample( &self, timeout: impl Into<Option<ClockTime>>, ) -> Option<Sample>
This function blocks until a sample or EOS becomes available or the appsink element is set to the READY/NULL state or the timeout expires.
This function will only return samples when the appsink is in the PLAYING state. All rendered buffers will be put in a queue so that the application can pull samples at its own rate. Note that when the application does not pull samples fast enough, the queued buffers could consume a lot of memory, especially when dealing with raw video frames.
If an EOS event was received before any buffers or the timeout expires,
this function returns None
. Use gst_app_sink_is_eos () to check for the EOS
condition.
§timeout
the maximum amount of time to wait for a sample
§Returns
a gst::Sample
or NULL when the appsink is stopped or EOS or the timeout expires.
Call gst_sample_unref()
after usage.
pub fn is_buffer_list(&self) -> bool
pub fn set_buffer_list(&self, buffer_list: bool)
pub fn connect_buffer_list_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_caps_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_drop_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_eos_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_max_buffers_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_max_bytes_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_max_time_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_wait_on_eos_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
source§impl AppSink
impl AppSink
sourcepub fn builder() -> AppSinkBuilder
pub fn builder() -> AppSinkBuilder
Creates a new builder-pattern struct instance to construct AppSink
objects.
This method returns an instance of AppSinkBuilder
which can be used to create AppSink
objects.
sourcepub fn set_callbacks(&self, callbacks: AppSinkCallbacks)
pub fn set_callbacks(&self, callbacks: AppSinkCallbacks)
Set callbacks which will be executed for each new preroll, new sample and eos. This is an alternative to using the signals, it has lower overhead and is thus less expensive, but also less flexible.
If callbacks are installed, no signals will be emitted for performance reasons.
Before 1.16.3 it was not possible to change the callbacks in a thread-safe way.
§callbacks
the callbacks
§notify
a destroy notify function
pub fn drops_out_of_segment(&self) -> bool
pub fn max_bitrate(&self) -> u64
pub fn max_lateness(&self) -> i64
pub fn processing_deadline(&self) -> ClockTime
pub fn render_delay(&self) -> ClockTime
pub fn stats(&self) -> Structure
pub fn is_sync(&self) -> bool
pub fn throttle_time(&self) -> u64
pub fn ts_offset(&self) -> ClockTimeDiff
pub fn is_async(&self) -> bool
pub fn enables_last_sample(&self) -> bool
pub fn is_qos(&self) -> bool
pub fn set_async(&self, enabled: bool)
pub fn set_drop_out_of_segment(&self, drop_out_of_segment: bool)
pub fn set_enable_last_sample(&self, enabled: bool)
pub fn set_max_bitrate(&self, max_bitrate: u64)
pub fn set_max_lateness(&self, max_lateness: i64)
pub fn set_processing_deadline(&self, processing_deadline: ClockTime)
pub fn set_qos(&self, enabled: bool)
pub fn set_render_delay(&self, delay: ClockTime)
pub fn set_sync(&self, sync: bool)
pub fn set_throttle_time(&self, throttle: u64)
pub fn set_ts_offset(&self, offset: ClockTimeDiff)
pub fn connect_async_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_blocksize_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_enable_last_sample_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_last_sample_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_max_bitrate_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_max_lateness_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_processing_deadline_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_qos_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_render_delay_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_stats_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_sync_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_throttle_time_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn connect_ts_offset_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
pub fn stream(&self) -> AppSinkStream
Trait Implementations§
source§impl HasParamSpec for AppSink
impl HasParamSpec for AppSink
source§impl Ord for AppSink
impl Ord for AppSink
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,
source§impl<OT: ObjectType> PartialEq<OT> for AppSink
impl<OT: ObjectType> PartialEq<OT> for AppSink
source§impl<OT: ObjectType> PartialOrd<OT> for AppSink
impl<OT: ObjectType> PartialOrd<OT> for AppSink
source§fn partial_cmp(&self, other: &OT) -> Option<Ordering>
fn partial_cmp(&self, other: &OT) -> Option<Ordering>
Partial comparison for two GObjects.
Compares the memory addresses of the provided objects.
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl StaticType for AppSink
impl StaticType for AppSink
source§fn static_type() -> Type
fn static_type() -> Type
Self
.impl Eq for AppSink
impl IsA<Element> for AppSink
impl IsA<Object> for AppSink
impl IsA<URIHandler> for AppSink
impl Send for AppSink
impl Sync for AppSink
Auto Trait Implementations§
impl Freeze for AppSink
impl RefUnwindSafe for AppSink
impl Unpin for AppSink
impl UnwindSafe for AppSink
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
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>,
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>,
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>,
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>,
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,
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,
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,
T
unconditionally. Read moresource§unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,
unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,
&T
unconditionally. Read moresource§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<O> ElementExt for O
impl<O> ElementExt for O
source§fn abort_state(&self)
fn abort_state(&self)
source§fn add_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
fn add_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
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>
StateChangeReturn::Success
from the state change function. Read moresource§fn create_all_pads(&self)
fn create_all_pads(&self)
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
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
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
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>
source§fn clock(&self) -> Option<Clock>
fn clock(&self) -> Option<Clock>
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>
source§fn compatible_pad_template(
&self,
compattempl: &PadTemplate,
) -> Option<PadTemplate>
fn compatible_pad_template( &self, compattempl: &PadTemplate, ) -> Option<PadTemplate>
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>
context_type
set on the element or NULL. Read moresource§fn factory(&self) -> Option<ElementFactory>
fn factory(&self) -> Option<ElementFactory>
source§fn start_time(&self) -> Option<ClockTime>
fn start_time(&self) -> Option<ClockTime>
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)
source§fn static_pad(&self, name: &str) -> Option<Pad>
fn static_pad(&self, name: &str) -> Option<Pad>
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
State::Null
. Read moresource§fn lost_state(&self)
fn lost_state(&self)
state()
will return StateChangeReturn::Async
. Read moresource§fn no_more_pads(&self)
fn no_more_pads(&self)
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>
source§fn release_request_pad(&self, pad: &impl IsA<Pad>)
fn release_request_pad(&self, pad: &impl IsA<Pad>)
request_pad()
. Read moresource§fn remove_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
fn remove_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
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>
ElementFactory::static_pad_templates()
. Read moresource§fn set_base_time(&self, time: ClockTime)
fn set_base_time(&self, time: ClockTime)
base_time()
. Read moresource§fn set_bus(&self, bus: Option<&Bus>)
fn set_bus(&self, bus: Option<&Bus>)
source§fn set_clock(&self, clock: Option<&impl IsA<Clock>>) -> Result<(), BoolError>
fn set_clock(&self, clock: Option<&impl IsA<Clock>>) -> Result<(), BoolError>
source§fn set_context(&self, context: &Context)
fn set_context(&self, context: &Context)
source§fn set_locked_state(&self, locked_state: bool) -> bool
fn set_locked_state(&self, locked_state: bool) -> bool
source§fn set_start_time(&self, time: impl Into<Option<ClockTime>>)
fn set_start_time(&self, time: impl Into<Option<ClockTime>>)
source§fn set_state(
&self,
state: State,
) -> Result<StateChangeSuccess, StateChangeError>
fn set_state( &self, state: State, ) -> Result<StateChangeSuccess, StateChangeError>
source§fn unlink(&self, dest: &impl IsA<Element>)
fn unlink(&self, dest: &impl IsA<Element>)
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, )
source§fn connect_no_more_pads<F>(&self, f: F) -> SignalHandlerId
fn connect_no_more_pads<F>(&self, f: F) -> SignalHandlerId
source§fn connect_pad_added<F>(&self, f: F) -> SignalHandlerId
fn connect_pad_added<F>(&self, f: F) -> SignalHandlerId
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§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
source§fn send_event(&self, event: impl Into<Event>) -> bool
fn send_event(&self, event: impl Into<Event>) -> bool
source§fn pad_template(&self, name: &str) -> Option<PadTemplate>
fn pad_template(&self, name: &str) -> Option<PadTemplate>
self
with the given name. Read moresource§fn pad_template_list(&self) -> List<PadTemplate>
fn pad_template_list(&self) -> List<PadTemplate>
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,
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,
fn post_error_message(&self, msg: ErrorMessage)
source§fn iterate_pads(&self) -> Iterator<Pad>
fn iterate_pads(&self) -> Iterator<Pad>
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>
self
’s sink pads. Read moresource§fn iterate_src_pads(&self) -> Iterator<Pad>
fn iterate_src_pads(&self) -> Iterator<Pad>
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,
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,
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,
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>
seek()
. Read moresource§fn call_async<F>(&self, func: F)
fn call_async<F>(&self, func: F)
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>
source§fn current_clock_time(&self) -> Option<ClockTime>
fn current_clock_time(&self) -> Option<ClockTime>
source§fn request_pad_simple(&self, name: &str) -> Option<Pad>
fn request_pad_simple(&self, name: &str) -> Option<Pad>
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>
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>
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>
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>
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>
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>
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>)
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>
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>
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>
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
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>
source§fn has_active_control_bindings(&self) -> bool
fn has_active_control_bindings(&self) -> bool
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
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)
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)
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>>)
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>
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>
source§fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>
fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>
GstControlSources
that
(maybe) handle them and for the given timestamp. Read moresource§fn unparent(&self)
fn unparent(&self)
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>
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>
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,
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>
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,
T
. Read moresource§fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
U: IsInterface,
fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
U: IsInterface,
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)])
source§fn set_properties_from_value(&self, property_values: &[(&str, Value)])
fn set_properties_from_value(&self, property_values: &[(&str, Value)])
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,
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
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>
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>
ParamSpec
of the property property_name
of this object.source§fn list_properties(&self) -> PtrSlice<ParamSpec>
fn list_properties(&self) -> PtrSlice<ParamSpec>
ParamSpec
of the properties of this object.source§fn freeze_notify(&self) -> PropertyNotificationFreezeGuard
fn freeze_notify(&self) -> PropertyNotificationFreezeGuard
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,
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,
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,
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,
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,
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,
key
. Read moresource§fn block_signal(&self, handler_id: &SignalHandlerId)
fn block_signal(&self, handler_id: &SignalHandlerId)
source§fn unblock_signal(&self, handler_id: &SignalHandlerId)
fn unblock_signal(&self, handler_id: &SignalHandlerId)
source§fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)
fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)
source§fn stop_signal_emission_by_name(&self, signal_name: &str)
fn stop_signal_emission_by_name(&self, signal_name: &str)
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
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
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
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
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
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
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
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
signal_id
on this object. Read moresource§fn watch_closure(&self, closure: &impl AsRef<Closure>)
fn watch_closure(&self, closure: &impl AsRef<Closure>)
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,
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>
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,
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>
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,
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>
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,
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>
source§fn disconnect(&self, handler_id: SignalHandlerId)
fn disconnect(&self, handler_id: SignalHandlerId)
source§fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
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
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
notify
signal of the object. Read moresource§fn notify(&self, property_name: &str)
fn notify(&self, property_name: &str)
source§fn notify_by_pspec(&self, pspec: &ParamSpec)
fn notify_by_pspec(&self, pspec: &ParamSpec)
source§fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
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,
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)
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()
source§impl<T> ToSendValue for T
impl<T> ToSendValue for T
source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
SendValue
clone of self
.