Struct gstreamer_app::AppSink [−][src]
pub struct AppSink(_);
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
Self::pull_sample() and Self::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, Self::try_pull_sample() and Self::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” property 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 Self::is_eos() method.
The eos signal can also be used to be informed when the EOS state is reached to avoid polling.
Implements
gst::prelude::ElementExt, gst::prelude::ObjectExt, trait@glib::object::ObjectExt, gst::prelude::URIHandlerExt
Implementations
impl AppSink[src]
impl AppSink[src]pub fn is_buffer_list_support(&self) -> bool[src]
This is supported on crate feature v1_12 only.
pub fn is_buffer_list_support(&self) -> bool[src]v1_12 only.pub fn caps(&self) -> Option<Caps>[src]
pub fn caps(&self) -> Option<Caps>[src]Get the configured caps on self.
Returns
the crate::gst::Caps accepted by the sink. gst_caps_unref() after usage.
pub fn emits_signals(&self) -> bool[src]
pub fn emits_signals(&self) -> bool[src]pub fn max_buffers(&self) -> u32[src]
pub fn max_buffers(&self) -> u32[src]Get the maximum amount of buffers that can be queued in self.
Returns
The maximum amount of buffers that can be queued.
pub fn is_wait_on_eos(&self) -> bool[src]
pub fn is_wait_on_eos(&self) -> bool[src]pub fn pull_preroll(&self) -> Result<Sample, BoolError>[src]
pub fn pull_preroll(&self) -> Result<Sample, BoolError>[src]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 Self::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 crate::gst::Sample or NULL when the appsink is stopped or EOS.
Call gst_sample_unref() after usage.
pub fn pull_sample(&self) -> Result<Sample, BoolError>[src]
pub fn pull_sample(&self) -> Result<Sample, BoolError>[src]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 crate::gst::Sample or NULL when the appsink is stopped or EOS.
Call gst_sample_unref() after usage.
pub fn set_buffer_list_support(&self, enable_lists: bool)[src]
This is supported on crate feature v1_12 only.
pub fn set_buffer_list_support(&self, enable_lists: bool)[src]v1_12 only.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
pub fn set_caps(&self, caps: Option<&Caps>)[src]
pub fn set_caps(&self, caps: Option<&Caps>)[src]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
pub fn set_drop(&self, drop: bool)[src]
pub fn set_drop(&self, drop: bool)[src]Instruct self to drop old buffers when the maximum amount of queued
buffers is reached.
drop
the new state
pub fn set_emit_signals(&self, emit: bool)[src]
pub fn set_emit_signals(&self, emit: bool)[src]Make appsink emit the “new-preroll” and “new-sample” signals. This option is by default disabled because signal emission is expensive and unneeded when the application prefers to operate in pull mode.
emit
the new state
pub fn set_max_buffers(&self, max: u32)[src]
pub fn set_max_buffers(&self, max: u32)[src]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.
max
the maximum number of buffers to queue
pub fn set_wait_on_eos(&self, wait: bool)[src]
pub fn set_wait_on_eos(&self, wait: bool)[src]pub fn try_pull_preroll(&self, timeout: ClockTime) -> Option<Sample>[src]
This is supported on crate feature v1_10 only.
pub fn try_pull_preroll(&self, timeout: ClockTime) -> Option<Sample>[src]v1_10 only.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 Self::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 crate::gst::Sample or NULL when the appsink is stopped or EOS or the timeout expires.
Call gst_sample_unref() after usage.
pub fn try_pull_sample(&self, timeout: ClockTime) -> Option<Sample>[src]
This is supported on crate feature v1_10 only.
pub fn try_pull_sample(&self, timeout: ClockTime) -> Option<Sample>[src]v1_10 only.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 crate::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[src]
pub fn set_buffer_list(&self, buffer_list: bool)[src]
pub fn connect_eos<F: Fn(&AppSink) + Send + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
pub fn connect_eos<F: Fn(&AppSink) + Send + 'static>(
&self,
f: F
) -> SignalHandlerId[src]Signal that the end-of-stream has been reached. This signal is emitted from the streaming thread.
pub fn connect_new_preroll<F: Fn(&AppSink) -> Result<FlowSuccess, FlowError> + Send + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
pub fn connect_new_preroll<F: Fn(&AppSink) -> Result<FlowSuccess, FlowError> + Send + 'static>(
&self,
f: F
) -> SignalHandlerId[src]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 Self::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.
pub fn connect_new_sample<F: Fn(&AppSink) -> Result<FlowSuccess, FlowError> + Send + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
pub fn connect_new_sample<F: Fn(&AppSink) -> Result<FlowSuccess, FlowError> + Send + 'static>(
&self,
f: F
) -> SignalHandlerId[src]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 Self::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.
pub fn connect_buffer_list_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
pub fn connect_caps_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
pub fn connect_drop_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
pub fn connect_emit_signals_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
pub fn connect_eos_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
pub fn connect_max_buffers_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
pub fn connect_wait_on_eos_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
impl AppSink[src]
impl AppSink[src]pub fn set_callbacks(&self, callbacks: AppSinkCallbacks)[src]
pub fn set_callbacks(&self, callbacks: AppSinkCallbacks)[src]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
user_data
a user_data argument for the callbacks
notify
a destroy notify function
pub fn stream(&self) -> AppSinkStream[src]
Trait Implementations
impl Ord for AppSink[src]
impl Ord for AppSink[src]impl ParentClassIs for AppSink[src]
impl ParentClassIs for AppSink[src]impl<T: ObjectType> PartialEq<T> for AppSink[src]
impl<T: ObjectType> PartialEq<T> for AppSink[src]impl<T: ObjectType> PartialOrd<T> for AppSink[src]
impl<T: ObjectType> PartialOrd<T> for AppSink[src]fn partial_cmp(&self, other: &T) -> Option<Ordering>[src]
fn partial_cmp(&self, other: &T) -> Option<Ordering>[src]This method returns an ordering between self and other values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]This method tests less than (for self and other) and is used by the < operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more
impl StaticType for AppSink[src]
impl StaticType for AppSink[src]fn static_type() -> Type[src]
fn static_type() -> Type[src]Returns the type identifier of Self.
impl Eq for AppSink[src]
impl IsA<Element> for AppSink[src]
impl IsA<Object> for AppSink[src]
impl IsA<URIHandler> for AppSink[src]
impl Send for AppSink[src]
impl StructuralEq for AppSink[src]
impl Sync for AppSink[src]
Auto Trait Implementations
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]
pub fn borrow_mut(&mut self) -> &mut T[src]Mutably borrows from an owned value. Read more
impl<T> Cast for T where
T: ObjectType, [src]
impl<T> Cast for T where
T: ObjectType, [src]fn upcast<T>(self) -> T where
Self: IsA<T>,
T: ObjectType, [src]
fn upcast<T>(self) -> T where
Self: IsA<T>,
T: ObjectType, [src]Upcasts an object to a superclass or interface T. Read more
fn upcast_ref<T>(&self) -> &T where
Self: IsA<T>,
T: ObjectType, [src]
fn upcast_ref<T>(&self) -> &T where
Self: IsA<T>,
T: ObjectType, [src]Upcasts an object to a reference of its superclass or interface T. Read more
fn downcast<T>(self) -> Result<T, Self> where
Self: CanDowncast<T>,
T: ObjectType, [src]
fn downcast<T>(self) -> Result<T, Self> where
Self: CanDowncast<T>,
T: ObjectType, [src]Tries to downcast to a subclass or interface implementor T. Read more
fn downcast_ref<T>(&self) -> Option<&T> where
Self: CanDowncast<T>,
T: ObjectType, [src]
fn downcast_ref<T>(&self) -> Option<&T> where
Self: CanDowncast<T>,
T: ObjectType, [src]Tries to downcast to a reference of its subclass or interface implementor T. Read more
fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType, [src]
fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType, [src]Tries to cast to an object of type T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read more
fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType, [src]
fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType, [src]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 more
unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType, [src]
unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType, [src]Casts to T unconditionally. Read more
unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType, [src]
unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType, [src]Casts to &T unconditionally. Read more
impl<O> ElementExt for O where
O: IsA<Element>, [src]
impl<O> ElementExt for O where
O: IsA<Element>, [src]pub fn abort_state(&self)[src]
pub fn abort_state(&self)[src]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
pub fn add_pad<P>(&self, pad: &P) -> Result<(), BoolError> where
P: IsA<Pad>, [src]
pub fn add_pad<P>(&self, pad: &P) -> Result<(), BoolError> where
P: IsA<Pad>, [src]Adds a pad (link point) to self. pad’s parent will be set to self;
see crate::prelude::GstObjectExt::set_parent() for refcounting information. Read more
pub fn change_state(
&self,
transition: StateChange
) -> Result<StateChangeSuccess, StateChangeError>[src]
pub fn change_state(
&self,
transition: StateChange
) -> Result<StateChangeSuccess, StateChangeError>[src]Perform transition on self. Read more
pub fn continue_state(
&self,
ret: impl Into<StateChangeReturn>
) -> Result<StateChangeSuccess, StateChangeError>[src]
pub fn continue_state(
&self,
ret: impl Into<StateChangeReturn>
) -> Result<StateChangeSuccess, StateChangeError>[src]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 crate::StateChangeReturn::Success from the state change function. Read more
pub fn create_all_pads(&self)[src]
pub fn foreach_pad<P>(&self, func: P) -> bool where
P: FnMut(&Element, &Pad) -> bool, [src]
pub fn foreach_pad<P>(&self, func: P) -> bool where
P: FnMut(&Element, &Pad) -> bool, [src]v1_14 only.pub fn foreach_sink_pad<P>(&self, func: P) -> bool where
P: FnMut(&Element, &Pad) -> bool, [src]
pub fn foreach_sink_pad<P>(&self, func: P) -> bool where
P: FnMut(&Element, &Pad) -> bool, [src]v1_14 only.pub fn foreach_src_pad<P>(&self, func: P) -> bool where
P: FnMut(&Element, &Pad) -> bool, [src]
pub fn foreach_src_pad<P>(&self, func: P) -> bool where
P: FnMut(&Element, &Pad) -> bool, [src]v1_14 only.pub fn base_time(&self) -> ClockTime[src]
pub fn bus(&self) -> Option<Bus>[src]
pub fn clock(&self) -> Option<Clock>[src]
pub fn compatible_pad<P>(&self, pad: &P, caps: Option<&Caps>) -> Option<Pad> where
P: IsA<Pad>, [src]
P: IsA<Pad>,
pub fn compatible_pad_template(
&self,
compattempl: &PadTemplate
) -> Option<PadTemplate>[src]
&self,
compattempl: &PadTemplate
) -> Option<PadTemplate>
pub fn context(&self, context_type: &str) -> Option<Context>[src]
pub fn contexts(&self) -> Vec<Context, Global>[src]
pub fn factory(&self) -> Option<ElementFactory>[src]
pub fn request_pad_simple(&self, name: &str) -> Option<Pad>[src]
pub fn start_time(&self) -> ClockTime[src]
pub fn state(
&self,
timeout: ClockTime
) -> (Result<StateChangeSuccess, StateChangeError>, State, State)[src]
&self,
timeout: ClockTime
) -> (Result<StateChangeSuccess, StateChangeError>, State, State)
pub fn static_pad(&self, name: &str) -> Option<Pad>[src]
pub fn is_locked_state(&self) -> bool[src]
pub fn link<P>(&self, dest: &P) -> Result<(), BoolError> where
P: IsA<Element>, [src]
P: IsA<Element>,
pub fn link_filtered<P>(
&self,
dest: &P,
filter: Option<&Caps>
) -> Result<(), BoolError> where
P: IsA<Element>, [src]
&self,
dest: &P,
filter: Option<&Caps>
) -> Result<(), BoolError> where
P: IsA<Element>,
pub fn link_pads<P>(
&self,
srcpadname: Option<&str>,
dest: &P,
destpadname: Option<&str>
) -> Result<(), BoolError> where
P: IsA<Element>, [src]
&self,
srcpadname: Option<&str>,
dest: &P,
destpadname: Option<&str>
) -> Result<(), BoolError> where
P: IsA<Element>,
pub fn link_pads_filtered<P>(
&self,
srcpadname: Option<&str>,
dest: &P,
destpadname: Option<&str>,
filter: Option<&Caps>
) -> Result<(), BoolError> where
P: IsA<Element>, [src]
&self,
srcpadname: Option<&str>,
dest: &P,
destpadname: Option<&str>,
filter: Option<&Caps>
) -> Result<(), BoolError> where
P: IsA<Element>,
pub fn link_pads_full<P>(
&self,
srcpadname: Option<&str>,
dest: &P,
destpadname: Option<&str>,
flags: PadLinkCheck
) -> Result<(), BoolError> where
P: IsA<Element>, [src]
&self,
srcpadname: Option<&str>,
dest: &P,
destpadname: Option<&str>,
flags: PadLinkCheck
) -> Result<(), BoolError> where
P: IsA<Element>,
pub fn lost_state(&self)[src]
pub fn no_more_pads(&self)[src]
pub fn provide_clock(&self) -> Option<Clock>[src]
pub fn release_request_pad<P>(&self, pad: &P) where
P: IsA<Pad>, [src]
P: IsA<Pad>,
pub fn remove_pad<P>(&self, pad: &P) -> Result<(), BoolError> where
P: IsA<Pad>, [src]
P: IsA<Pad>,
pub fn request_pad(
&self,
templ: &PadTemplate,
name: Option<&str>,
caps: Option<&Caps>
) -> Option<Pad>[src]
&self,
templ: &PadTemplate,
name: Option<&str>,
caps: Option<&Caps>
) -> Option<Pad>
pub fn set_base_time(&self, time: ClockTime)[src]
pub fn set_bus(&self, bus: Option<&Bus>)[src]
pub fn set_clock<P>(&self, clock: Option<&P>) -> Result<(), BoolError> where
P: IsA<Clock>, [src]
P: IsA<Clock>,
pub fn set_context(&self, context: &Context)[src]
pub fn set_locked_state(&self, locked_state: bool) -> bool[src]
pub fn set_start_time(&self, time: ClockTime)[src]
pub fn set_state(
&self,
state: State
) -> Result<StateChangeSuccess, StateChangeError>[src]
&self,
state: State
) -> Result<StateChangeSuccess, StateChangeError>
pub fn sync_state_with_parent(&self) -> Result<(), BoolError>[src]
pub fn unlink<P>(&self, dest: &P) where
P: IsA<Element>, [src]
P: IsA<Element>,
pub fn unlink_pads<P>(&self, srcpadname: &str, dest: &P, destpadname: &str) where
P: IsA<Element>, [src]
P: IsA<Element>,
pub fn connect_no_more_pads<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O) + Send + Sync, [src]
F: 'static + Fn(&O) + Send + Sync,
pub fn connect_pad_added<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Pad) + Send + Sync, [src]
F: 'static + Fn(&O, &Pad) + Send + Sync,
pub fn connect_pad_removed<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Pad) + Send + Sync, [src]
F: 'static + Fn(&O, &Pad) + Send + Sync,
impl<O> ElementExtManual for O where
O: IsA<Element>, [src]
impl<O> ElementExtManual for O where
O: IsA<Element>, [src]pub fn element_class(&self) -> &Class<Element>[src]
pub fn current_state(&self) -> State[src]
pub fn pending_state(&self) -> State[src]
pub fn query(&self, query: &mut QueryRef) -> bool[src]
pub fn send_event(&self, event: Event) -> bool[src]
pub fn metadata<'a>(&self, key: &str) -> Option<&'a str>[src]
pub fn pad_template(&self, name: &str) -> Option<PadTemplate>[src]
pub fn pad_template_list(&self) -> Vec<PadTemplate, Global>[src]
pub fn set_element_flags(&self, flags: ElementFlags)[src]
pub fn unset_element_flags(&self, flags: ElementFlags)[src]
pub fn element_flags(&self) -> ElementFlags[src]
pub fn message_full<T>(
&self,
type_: ElementMessageType,
code: T,
message: Option<&str>,
debug: Option<&str>,
file: &str,
function: &str,
line: u32
) where
T: MessageErrorDomain, [src]
&self,
type_: ElementMessageType,
code: T,
message: Option<&str>,
debug: Option<&str>,
file: &str,
function: &str,
line: u32
) where
T: MessageErrorDomain,
pub 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, [src]
pub 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, [src]v1_10 only.pub fn post_message(&self, message: Message) -> Result<(), BoolError>[src]
pub fn post_error_message(&self, msg: ErrorMessage)[src]
pub fn iterate_pads(&self) -> Iterator<Pad>[src]
pub fn iterate_sink_pads(&self) -> Iterator<Pad>[src]
pub fn iterate_src_pads(&self) -> Iterator<Pad>[src]
pub fn pads(&self) -> Vec<Pad, Global>[src]
pub fn sink_pads(&self) -> Vec<Pad, Global>[src]
pub fn src_pads(&self) -> Vec<Pad, Global>[src]
pub fn num_pads(&self) -> u16[src]
pub fn num_sink_pads(&self) -> u16[src]
pub fn num_src_pads(&self) -> u16[src]
pub fn add_property_deep_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool
) -> NotifyWatchId[src]
pub fn add_property_deep_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool
) -> NotifyWatchId[src]v1_10 only.pub fn add_property_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool
) -> NotifyWatchId[src]
pub fn add_property_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool
) -> NotifyWatchId[src]v1_10 only.pub fn remove_property_notify_watch(&self, watch_id: NotifyWatchId)[src]
pub fn remove_property_notify_watch(&self, watch_id: NotifyWatchId)[src]v1_10 only.pub fn query_convert<V, U>(&self, src_val: V) -> Option<U> where
U: SpecificFormattedValue,
V: Into<GenericFormattedValue>, [src]
U: SpecificFormattedValue,
V: Into<GenericFormattedValue>,
pub fn query_convert_generic<V>(
&self,
src_val: V,
dest_format: Format
) -> Option<GenericFormattedValue> where
V: Into<GenericFormattedValue>, [src]
&self,
src_val: V,
dest_format: Format
) -> Option<GenericFormattedValue> where
V: Into<GenericFormattedValue>,
pub fn query_duration<T>(&self) -> Option<T> where
T: SpecificFormattedValue, [src]
T: SpecificFormattedValue,
pub fn query_duration_generic(
&self,
format: Format
) -> Option<GenericFormattedValue>[src]
&self,
format: Format
) -> Option<GenericFormattedValue>
pub fn query_position<T>(&self) -> Option<T> where
T: SpecificFormattedValue, [src]
T: SpecificFormattedValue,
pub fn query_position_generic(
&self,
format: Format
) -> Option<GenericFormattedValue>[src]
&self,
format: Format
) -> Option<GenericFormattedValue>
pub fn seek<V>(
&self,
rate: f64,
flags: SeekFlags,
start_type: SeekType,
start: V,
stop_type: SeekType,
stop: V
) -> Result<(), BoolError> where
V: Into<GenericFormattedValue>, [src]
&self,
rate: f64,
flags: SeekFlags,
start_type: SeekType,
start: V,
stop_type: SeekType,
stop: V
) -> Result<(), BoolError> where
V: Into<GenericFormattedValue>,
pub fn seek_simple<V>(
&self,
seek_flags: SeekFlags,
seek_pos: V
) -> Result<(), BoolError> where
V: Into<GenericFormattedValue>, [src]
&self,
seek_flags: SeekFlags,
seek_pos: V
) -> Result<(), BoolError> where
V: Into<GenericFormattedValue>,
pub fn call_async<F>(&self, func: F) where
F: FnOnce(&O) + Send + 'static, [src]
pub fn call_async<F>(&self, func: F) where
F: FnOnce(&O) + Send + 'static, [src]v1_10 only.pub fn call_async_future<F, T>(
&self,
func: F
) -> Pin<Box<dyn Future<Output = T> + 'static + Send, Global>> where
F: FnOnce(&O) -> T + Send + 'static,
T: Send + 'static, [src]
pub fn call_async_future<F, T>(
&self,
func: F
) -> Pin<Box<dyn Future<Output = T> + 'static + Send, Global>> where
F: FnOnce(&O) -> T + Send + 'static,
T: Send + 'static, [src]v1_10 only.pub fn current_running_time(&self) -> ClockTime[src]
pub fn current_clock_time(&self) -> ClockTime[src]
impl<O> GObjectExtManualGst for O where
O: IsA<Object>, [src]
impl<O> GObjectExtManualGst for O where
O: IsA<Object>, [src]pub fn set_property_from_str(&self, name: &str, value: &str)[src]
impl<O> GstObjectExt for O where
O: IsA<Object>, [src]
impl<O> GstObjectExt for O where
O: IsA<Object>, [src]pub fn add_control_binding<P>(&self, binding: &P) -> Result<(), BoolError> where
P: IsA<ControlBinding>, [src]
pub fn add_control_binding<P>(&self, binding: &P) -> Result<(), BoolError> where
P: IsA<ControlBinding>, [src]Attach the crate::ControlBinding to the object. If there already was a
crate::ControlBinding for this property it will be replaced. Read more
pub fn default_error(&self, error: &Error, debug: Option<&str>)[src]
pub fn default_error(&self, error: &Error, debug: Option<&str>)[src]A default error function that uses g_printerr() to display the error message
and the optional debug string.. Read more
pub fn control_binding(&self, property_name: &str) -> Option<ControlBinding>[src]
pub fn control_binding(&self, property_name: &str) -> Option<ControlBinding>[src]Gets the corresponding crate::ControlBinding for the property. This should be
unreferenced again after use. Read more
pub fn control_rate(&self) -> ClockTime[src]
pub fn control_rate(&self) -> ClockTime[src]Obtain the control-rate for this self. Audio processing crate::Element
objects will use this rate to sub-divide their processing loop and call
Self::sync_values() in between. The length of the processing segment
should be up to control-rate nanoseconds. Read more
pub fn parent(&self) -> Option<Object>[src]
pub fn parent(&self) -> Option<Object>[src]Returns the parent of self. This function increases the refcount
of the parent object so you should [Self::unref()] it after usage. Read more
pub fn path_string(&self) -> GString[src]
pub fn path_string(&self) -> GString[src]Generates a string describing the path of self in
the object hierarchy. Only useful (or used) for debugging. Read more
pub fn value(&self, property_name: &str, timestamp: ClockTime) -> Option<Value>[src]
pub fn value(&self, property_name: &str, timestamp: ClockTime) -> Option<Value>[src]Gets the value for the given controlled property at the requested time. Read more
pub fn has_active_control_bindings(&self) -> bool[src]
pub fn has_active_control_bindings(&self) -> bool[src]Check if the self has active controlled properties. Read more
pub fn has_ancestor<P>(&self, ancestor: &P) -> bool where
P: IsA<Object>, [src]
pub fn has_ancestor<P>(&self, ancestor: &P) -> bool where
P: IsA<Object>, [src]Check if self has an ancestor ancestor somewhere up in
the hierarchy. One can e.g. check if a crate::Element is inside a crate::Pipeline. Read more
pub fn has_as_ancestor<P>(&self, ancestor: &P) -> bool where
P: IsA<Object>, [src]
pub fn has_as_ancestor<P>(&self, ancestor: &P) -> bool where
P: IsA<Object>, [src]Check if self has an ancestor ancestor somewhere up in
the hierarchy. One can e.g. check if a crate::Element is inside a crate::Pipeline. Read more
pub fn has_as_parent<P>(&self, parent: &P) -> bool where
P: IsA<Object>, [src]
pub fn has_as_parent<P>(&self, parent: &P) -> bool where
P: IsA<Object>, [src]Check if parent is the parent of self.
E.g. a crate::Element can check if it owns a given crate::Pad. Read more
pub fn remove_control_binding<P>(&self, binding: &P) -> bool where
P: IsA<ControlBinding>, [src]
pub fn remove_control_binding<P>(&self, binding: &P) -> bool where
P: IsA<ControlBinding>, [src]Removes the corresponding crate::ControlBinding. If it was the
last ref of the binding, it will be disposed. Read more
pub fn set_control_binding_disabled(&self, property_name: &str, disabled: bool)[src]
pub fn set_control_binding_disabled(&self, property_name: &str, disabled: bool)[src]This function is used to disable the control bindings on a property for
some time, i.e. Self::sync_values() will do nothing for the
property. Read more
pub fn set_control_bindings_disabled(&self, disabled: bool)[src]
pub fn set_control_bindings_disabled(&self, disabled: bool)[src]This function is used to disable all controlled properties of the self for
some time, i.e. Self::sync_values() will do nothing. Read more
pub fn set_control_rate(&self, control_rate: ClockTime)[src]
pub fn set_control_rate(&self, control_rate: ClockTime)[src]Change the control-rate for this self. Audio processing crate::Element
objects will use this rate to sub-divide their processing loop and call
Self::sync_values() in between. The length of the processing segment
should be up to control-rate nanoseconds. Read more
pub fn set_parent<P>(&self, parent: &P) -> Result<(), BoolError> where
P: IsA<Object>, [src]
pub fn set_parent<P>(&self, parent: &P) -> Result<(), BoolError> where
P: IsA<Object>, [src]Sets the parent of self to parent. The object’s reference count will
be incremented, and any floating reference will be removed (see [crate::Object::ref_sink()]). Read more
pub fn suggest_next_sync(&self) -> ClockTime[src]
pub fn suggest_next_sync(&self) -> ClockTime[src]Returns a suggestion for timestamps where buffers should be split to get best controller results. Read more
pub fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>[src]
pub fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>[src]Sets the properties of the object, according to the GstControlSources that
(maybe) handle them and for the given timestamp. Read more
pub fn unparent(&self)[src]
pub fn unparent(&self)[src]Clear the parent of self, removing the associated reference.
This function decreases the refcount of self. Read more
pub fn connect_parent_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O) + Send + Sync, [src]
F: 'static + Fn(&O) + Send + Sync,
impl<O> GstObjectExtManual for O where
O: IsA<Object>, [src]
impl<O> GstObjectExtManual for O where
O: IsA<Object>, [src]pub fn connect_deep_notify<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&O, &Object, &ParamSpec) + Send + Sync, [src]
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&O, &Object, &ParamSpec) + Send + Sync,
pub fn set_object_flags(&self, flags: ObjectFlags)[src]
pub fn unset_object_flags(&self, flags: ObjectFlags)[src]
pub fn object_flags(&self) -> ObjectFlags[src]
pub fn g_value_array(
&self,
property_name: &str,
timestamp: ClockTime,
interval: ClockTime,
values: &mut [Value]
) -> Result<(), BoolError>[src]
&self,
property_name: &str,
timestamp: ClockTime,
interval: ClockTime,
values: &mut [Value]
) -> Result<(), BoolError>
impl<T> ObjectExt for T where
T: ObjectType, [src]
impl<T> ObjectExt for T where
T: ObjectType, [src]pub fn is<U>(&self) -> bool where
U: StaticType, [src]
pub fn is<U>(&self) -> bool where
U: StaticType, [src]Returns true if the object is an instance of (can be cast to) T.
pub fn type_(&self) -> Type[src]
pub fn object_class(&self) -> &Class<Object>[src]
pub fn class(&self) -> &Class<T> where
T: IsClass, [src]
T: IsClass,
pub fn class_of<U>(&self) -> Option<&Class<U>> where
U: IsClass, [src]
U: IsClass,
pub fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
U: IsInterface, [src]
U: IsInterface,
pub fn set_properties(
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>[src]
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>[src]
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>
pub fn set_property<'a, N, V>(
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
V: ToValue,
N: Into<&'a str>, [src]
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
V: ToValue,
N: Into<&'a str>,
pub fn set_property_from_value<'a, N>(
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>, [src]
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>,
pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
QD: 'static, [src]
pub unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
QD: 'static, [src]Safety Read more
pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static, [src]
pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static, [src]Safety Read more
pub unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
QD: 'static, [src]
pub unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
QD: 'static, [src]Safety Read more
pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static, [src]
pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static, [src]Safety Read more
pub fn block_signal(&self, handler_id: &SignalHandlerId)[src]
pub fn unblock_signal(&self, handler_id: &SignalHandlerId)[src]
pub fn stop_signal_emission(&self, signal_name: &str)[src]
pub fn disconnect(&self, handler_id: SignalHandlerId)[src]
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync, [src]
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec), [src]
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec), [src]
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
pub fn notify<'a, N>(&self, property_name: N) where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub fn notify_by_pspec(&self, pspec: &ParamSpec)[src]
pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub fn property_type<'a, N>(&self, property_name: N) -> Option<Type> where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub fn list_properties(&self) -> Vec<ParamSpec, Global>[src]
pub fn connect<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>, [src]
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>,
pub fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static, [src]
pub fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static, [src]Same as connect but takes a SignalId instead of a signal name.
pub fn connect_local<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>, [src]
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>,
pub fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static, [src]
pub fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static, [src]Same as connect_local but takes a SignalId instead of a signal name.
pub unsafe fn connect_unsafe<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>, [src]
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>,
pub unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>, [src]
pub unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>, [src]Same as connect_unsafe but takes a SignalId instead of a signal name.
pub fn emit(
&self,
signal_id: SignalId,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>[src]
pub fn emit(
&self,
signal_id: SignalId,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>[src]Emit signal by signal id.
pub fn emit_with_details(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>[src]
pub fn emit_with_details(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>[src]Emit signal with details by signal id.
pub fn emit_by_name<'a, N>(
&self,
signal_name: N,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>, [src]
pub fn emit_by_name<'a, N>(
&self,
signal_name: N,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>, [src]Emit signal by it’s name.
pub fn downgrade(&self) -> WeakRef<T>[src]
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
N: Into<&'a str>,
O: ObjectType,
M: Into<&'a str>, [src]
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
N: Into<&'a str>,
O: ObjectType,
M: Into<&'a str>,
pub fn ref_count(&self) -> u32[src]
pub fn emit_with_values(
&self,
signal_id: SignalId,
args: &[Value]
) -> Result<Option<Value>, BoolError>[src]
pub fn emit_with_values(
&self,
signal_id: SignalId,
args: &[Value]
) -> Result<Option<Value>, BoolError>[src]Same as emit but takes Value for the arguments.
impl<T> ToOwned for T where
T: Clone, [src]
impl<T> ToOwned for T where
T: Clone, [src]type Owned = T
type Owned = TThe resulting type after obtaining ownership.
pub fn to_owned(&self) -> T[src]
pub fn to_owned(&self) -> T[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)[src]
pub fn clone_into(&self, target: &mut T)[src]🔬 This is a nightly-only experimental API. (toowned_clone_into)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized, [src]
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized, [src]pub fn to_send_value(&self) -> SendValue[src]
pub fn to_send_value(&self) -> SendValue[src]Returns a SendValue clone of self.
impl<O> URIHandlerExt for O where
O: IsA<URIHandler>, [src]
impl<O> URIHandlerExt for O where
O: IsA<URIHandler>, [src]impl<Super, Sub> CanDowncast<Sub> for Super where
Sub: IsA<Super>,
Super: IsA<Super>, [src]
Sub: IsA<Super>,
Super: IsA<Super>,
impl<'a, T, C> FromValueOptional<'a> for T where
C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
T: FromValue<'a, Checker = C>, [src]
C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
T: FromValue<'a, Checker = C>,