Struct gstreamer_app::AppSrc[][src]

pub struct AppSrc(_);

The appsrc element can be used by applications to insert data into a GStreamer pipeline. Unlike most GStreamer elements, appsrc provides external API functions.

appsrc can be used by linking with the libgstapp library to access the methods directly or by using the appsrc action signals.

Before operating appsrc, the caps property must be set to fixed caps describing the format of the data that will be pushed with appsrc. An exception to this is when pushing buffers with unknown caps, in which case no caps should be set. This is typically true of file-like sources that push raw byte buffers. If you don’t want to explicitly set the caps, you can use gst_app_src_push_sample. This method gets the caps associated with the sample and sets them on the appsrc replacing any previously set caps (if different from sample’s caps).

The main way of handing data to the appsrc element is by calling the Self::push_buffer() method or by emitting the push-buffer action signal. This will put the buffer onto a queue from which appsrc will read from in its streaming thread. It is important to note that data transport will not happen from the thread that performed the push-buffer call.

The “max-bytes” property controls how much data can be queued in appsrc before appsrc considers the queue full. A filled internal queue will always signal the “enough-data” signal, which signals the application that it should stop pushing data into appsrc. The “block” property will cause appsrc to block the push-buffer method until free data becomes available again.

When the internal queue is running out of data, the “need-data” signal is emitted, which signals the application that it should start pushing more data into appsrc.

In addition to the “need-data” and “enough-data” signals, appsrc can emit the “seek-data” signal when the “stream-mode” property is set to “seekable” or “random-access”. The signal argument will contain the new desired position in the stream expressed in the unit set with the “format” property. After receiving the seek-data signal, the application should push-buffers from the new position.

These signals allow the application to operate the appsrc in two different ways:

The push mode, in which the application repeatedly calls the push-buffer/push-sample method with a new buffer/sample. Optionally, the queue size in the appsrc can be controlled with the enough-data and need-data signals by respectively stopping/starting the push-buffer/push-sample calls. This is a typical mode of operation for the stream-type “stream” and “seekable”. Use this mode when implementing various network protocols or hardware devices.

The pull mode, in which the need-data signal triggers the next push-buffer call. This mode is typically used in the “random-access” stream-type. Use this mode for file access or other randomly accessible sources. In this mode, a buffer of exactly the amount of bytes given by the need-data signal should be pushed into appsrc.

In all modes, the size property on appsrc should contain the total stream size in bytes. Setting this property is mandatory in the random-access mode. For the stream and seekable modes, setting this property is optional but recommended.

When the application has finished pushing data into appsrc, it should call Self::end_of_stream() or emit the end-of-stream action signal. After this call, no more buffers can be pushed into appsrc until a flushing seek occurs or the state of the appsrc has gone through READY.

Implements

gst::prelude::ElementExt, gst::prelude::ObjectExt, trait@glib::object::ObjectExt, gst::prelude::URIHandlerExt

Implementations

impl AppSrc[src]

pub fn end_of_stream(&self) -> Result<FlowSuccess, FlowError>[src]

Indicates to the appsrc element that the last buffer queued in the element is the last buffer of the stream.

Returns

crate::gst::FlowReturn::Ok when the EOS was successfully queued. crate::gst::FlowReturn::Flushing when self is not PAUSED or PLAYING.

pub fn caps(&self) -> Option<Caps>[src]

Get the configured caps on self.

Returns

the crate::gst::Caps produced by the source. gst_caps_unref() after usage.

pub fn current_level_bytes(&self) -> u64[src]

Get the number of currently queued bytes inside self.

Returns

The number of currently queued bytes.

pub fn duration(&self) -> ClockTime[src]

This is supported on crate feature v1_10 only.

Get the duration of the stream in nanoseconds. A value of GST_CLOCK_TIME_NONE means that the duration is not known.

Returns

the duration of the stream previously set with Self::set_duration();

pub fn emits_signals(&self) -> bool[src]

Check if appsrc will emit the “new-preroll” and “new-buffer” signals.

Returns

true if self is emitting the “new-preroll” and “new-buffer” signals.

pub fn max_bytes(&self) -> u64[src]

Get the maximum amount of bytes that can be queued in self.

Returns

The maximum amount of bytes that can be queued.

pub fn size(&self) -> i64[src]

Get the size of the stream in bytes. A value of -1 means that the size is not known.

Returns

the size of the stream previously set with Self::set_size();

pub fn stream_type(&self) -> AppStreamType[src]

Get the stream type. Control the stream type of self with Self::set_stream_type().

Returns

the stream type.

pub fn push_sample(&self, sample: &Sample) -> Result<FlowSuccess, FlowError>[src]

Extract a buffer from the provided sample and adds it to the queue of buffers that the appsrc element will push to its source pad. Any previous caps that were set on appsrc will be replaced by the caps associated with the sample if not equal.

This function does not take ownership of the sample so the sample needs to be unreffed after calling this function.

When the block property is TRUE, this function can block until free space becomes available in the queue.

sample

a crate::gst::Sample from which buffer and caps may be extracted

Returns

crate::gst::FlowReturn::Ok when the buffer was successfully queued. crate::gst::FlowReturn::Flushing when self is not PAUSED or PLAYING. crate::gst::FlowReturn::Eos when EOS occurred.

pub fn set_caps(&self, caps: Option<&Caps>)[src]

Set the capabilities on the appsrc element. This function takes a copy of the caps structure. After calling this method, the source will only produce caps that match caps. caps must be fixed and the caps on the buffers must match the caps or left NULL.

caps

caps to set

pub fn set_duration(&self, duration: ClockTime)[src]

This is supported on crate feature v1_10 only.

Set the duration of the stream in nanoseconds. A value of GST_CLOCK_TIME_NONE means that the duration is not known.

duration

the duration to set

pub fn set_emit_signals(&self, emit: bool)[src]

Make appsrc emit the “new-preroll” and “new-buffer” 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_bytes(&self, max: u64)[src]

Set the maximum amount of bytes that can be queued in self. After the maximum amount of bytes are queued, self will emit the “enough-data” signal.

max

the maximum number of bytes to queue

pub fn set_size(&self, size: i64)[src]

Set the size of the stream in bytes. A value of -1 means that the size is not known.

size

the size to set

pub fn set_stream_type(&self, type_: AppStreamType)[src]

Set the stream type on self. For seekable streams, the “seek” signal must be connected to.

A stream_type stream

type_

the new state

pub fn is_block(&self) -> bool[src]

pub fn set_block(&self, block: bool)[src]

pub fn format(&self) -> Format[src]

pub fn set_format(&self, format: Format)[src]

pub fn is_handle_segment_change(&self) -> bool[src]

This is supported on crate feature v1_18 only.

pub fn set_handle_segment_change(&self, handle_segment_change: bool)[src]

This is supported on crate feature v1_18 only.

pub fn is_live(&self) -> bool[src]

pub fn set_is_live(&self, is_live: bool)[src]

pub fn max_latency(&self) -> i64[src]

pub fn set_max_latency(&self, max_latency: i64)[src]

pub fn min_latency(&self) -> i64[src]

pub fn set_min_latency(&self, min_latency: i64)[src]

pub fn min_percent(&self) -> u32[src]

pub fn set_min_percent(&self, min_percent: u32)[src]

pub fn connect_enough_data<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

Signal that the source has enough data. It is recommended that the application stops calling push-buffer until the need-data signal is emitted again to avoid excessive buffer queueing.

pub fn connect_need_data<F: Fn(&AppSrc, u32) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

Signal that the source needs more data. In the callback or from another thread you should call push-buffer or end-of-stream.

length is just a hint and when it is set to -1, any number of bytes can be pushed into appsrc.

You can call push-buffer multiple times until the enough-data signal is fired.

length

the amount of bytes needed.

pub fn connect_seek_data<F: Fn(&AppSrc, u64) -> bool + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

Seek to the given offset. The next push-buffer should produce buffers from the new offset. This callback is only called for seekable stream types.

offset

the offset to seek to

Returns

true if the seek succeeded.

pub fn connect_block_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_caps_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_current_level_bytes_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_duration_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

This is supported on crate feature v1_10 only.

pub fn connect_emit_signals_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_format_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_handle_segment_change_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

This is supported on crate feature v1_18 only.

pub fn connect_is_live_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_max_bytes_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_max_latency_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_min_latency_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_min_percent_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_size_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_stream_type_notify<F: Fn(&AppSrc) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

impl AppSrc[src]

pub fn push_buffer(&self, buffer: Buffer) -> Result<FlowSuccess, FlowError>[src]

Adds a buffer to the queue of buffers that the appsrc element will push to its source pad. This function takes ownership of the buffer.

When the block property is TRUE, this function can block until free space becomes available in the queue.

buffer

a crate::gst::Buffer to push

Returns

crate::gst::FlowReturn::Ok when the buffer was successfully queued. crate::gst::FlowReturn::Flushing when self is not PAUSED or PLAYING. crate::gst::FlowReturn::Eos when EOS occurred.

pub fn push_buffer_list(
    &self,
    list: BufferList
) -> Result<FlowSuccess, FlowError>
[src]

This is supported on crate feature v1_14 only.

Adds a buffer list to the queue of buffers and buffer lists that the appsrc element will push to its source pad. This function takes ownership of buffer_list.

When the block property is TRUE, this function can block until free space becomes available in the queue.

buffer_list

a crate::gst::BufferList to push

Returns

crate::gst::FlowReturn::Ok when the buffer list was successfully queued. crate::gst::FlowReturn::Flushing when self is not PAUSED or PLAYING. crate::gst::FlowReturn::Eos when EOS occurred.

pub fn set_callbacks(&self, callbacks: AppSrcCallbacks)[src]

Set callbacks which will be executed when data is needed, enough data has been collected or when a seek should be performed. 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 set_latency(&self, min: ClockTime, max: ClockTime)[src]

Configure the min and max latency in src. If min is set to -1, the default latency calculations for pseudo-live sources will be used.

min

the min latency

max

the max latency

pub fn latency(&self) -> (ClockTime, ClockTime)[src]

Retrieve the min and max latencies in min and max respectively.

min

the min latency

max

the max latency

pub fn sink(&self) -> AppSrcSink[src]

Trait Implementations

impl Clone for AppSrc[src]

fn clone(&self) -> AppSrc[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for AppSrc[src]

fn fmt(&self, f: &mut Formatter<'_>) -> Result[src]

Formats the value using the given formatter. Read more

impl Hash for AppSrc[src]

fn hash<__H: Hasher>(&self, state: &mut __H)[src]

Feeds this value into the given Hasher. Read more

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher
1.3.0[src]

Feeds a slice of this type into the given Hasher. Read more

impl Ord for AppSrc[src]

fn cmp(&self, other: &AppSrc) -> Ordering[src]

This method returns an Ordering between self and other. Read more

#[must_use]
fn max(self, other: Self) -> Self
1.21.0[src]

Compares and returns the maximum of two values. Read more

#[must_use]
fn min(self, other: Self) -> Self
1.21.0[src]

Compares and returns the minimum of two values. Read more

#[must_use]
fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]

Restrict a value to a certain interval. Read more

impl ParentClassIs for AppSrc[src]

impl<T: ObjectType> PartialEq<T> for AppSrc[src]

fn eq(&self, other: &T) -> bool[src]

This method tests for self and other values to be equal, and is used by ==. Read more

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for AppSrc[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) -> bool
1.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) -> bool
1.0.0[src]

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests greater than (for self and other) and is used by the > operator. Read more

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl StaticType for AppSrc[src]

fn static_type() -> Type[src]

Returns the type identifier of Self.

impl Eq for AppSrc[src]

impl IsA<Element> for AppSrc[src]

impl IsA<Object> for AppSrc[src]

impl IsA<URIHandler> for AppSrc[src]

impl Send for AppSrc[src]

impl StructuralEq for AppSrc[src]

impl Sync for AppSrc[src]

Auto Trait Implementations

impl RefUnwindSafe for AppSrc

impl Unpin for AppSrc

impl UnwindSafe for AppSrc

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[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]

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]

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]

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]

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]

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]

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]

Casts to T unconditionally. Read more

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]

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]

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]

Perform transition on self. Read more

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]

This is supported on crate feature v1_14 only.

pub fn foreach_sink_pad<P>(&self, func: P) -> bool where
    P: FnMut(&Element, &Pad) -> bool
[src]

This is supported on crate feature v1_14 only.

pub fn foreach_src_pad<P>(&self, func: P) -> bool where
    P: FnMut(&Element, &Pad) -> bool
[src]

This is supported on crate feature 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]

pub fn compatible_pad_template(
    &self,
    compattempl: &PadTemplate
) -> Option<PadTemplate>
[src]

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]

pub fn static_pad(&self, name: &str) -> Option<Pad>[src]

pub fn is_locked_state(&self) -> bool[src]

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]

pub fn remove_pad<P>(&self, pad: &P) -> Result<(), BoolError> where
    P: IsA<Pad>, 
[src]

pub fn request_pad(
    &self,
    templ: &PadTemplate,
    name: Option<&str>,
    caps: Option<&Caps>
) -> Option<Pad>
[src]

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]

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]

pub fn sync_state_with_parent(&self) -> Result<(), BoolError>[src]

pub fn connect_no_more_pads<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&O) + Send + Sync
[src]

pub fn connect_pad_added<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&O, &Pad) + Send + Sync
[src]

pub fn connect_pad_removed<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&O, &Pad) + Send + Sync
[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]

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]

This is supported on crate feature 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]

This is supported on crate feature v1_10 only.

pub fn add_property_notify_watch(
    &self,
    property_name: Option<&str>,
    include_value: bool
) -> NotifyWatchId
[src]

This is supported on crate feature v1_10 only.

pub fn remove_property_notify_watch(&self, watch_id: NotifyWatchId)[src]

This is supported on crate feature v1_10 only.

pub fn query_convert<V, U>(&self, src_val: V) -> Option<U> where
    U: SpecificFormattedValue,
    V: Into<GenericFormattedValue>, 
[src]

pub fn query_convert_generic<V>(
    &self,
    src_val: V,
    dest_format: Format
) -> Option<GenericFormattedValue> where
    V: Into<GenericFormattedValue>, 
[src]

pub fn query_duration<T>(&self) -> Option<T> where
    T: SpecificFormattedValue
[src]

pub fn query_duration_generic(
    &self,
    format: Format
) -> Option<GenericFormattedValue>
[src]

pub fn query_position<T>(&self) -> Option<T> where
    T: SpecificFormattedValue
[src]

pub fn query_position_generic(
    &self,
    format: Format
) -> Option<GenericFormattedValue>
[src]

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]

pub fn seek_simple<V>(
    &self,
    seek_flags: SeekFlags,
    seek_pos: V
) -> Result<(), BoolError> where
    V: Into<GenericFormattedValue>, 
[src]

pub fn call_async<F>(&self, func: F) where
    F: FnOnce(&O) + Send + 'static, 
[src]

This is supported on crate feature 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]

This is supported on crate feature v1_10 only.

pub fn current_running_time(&self) -> ClockTime[src]

pub fn current_clock_time(&self) -> ClockTime[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

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]

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]

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]

Gets the corresponding crate::ControlBinding for the property. This should be unreferenced again after use. Read more

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 name(&self) -> GString[src]

Returns a copy of the name of self. Caller should g_free() the return value after usage. For a nameless object, this returns None, which you can safely g_free() as well. Read more

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]

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]

Gets the value for the given controlled property at the requested time. Read more

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]

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]

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]

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]

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]

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]

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]

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]

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]

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]

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]

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]

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]

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]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ObjectExt for T where
    T: ObjectType
[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]

pub fn class_of<U>(&self) -> Option<&Class<U>> where
    U: IsClass
[src]

pub fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
    U: IsInterface
[src]

pub fn set_properties(
    &self,
    property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
[src]

pub fn set_properties_from_value(
    &self,
    property_values: &[(&str, Value)]
) -> Result<(), BoolError>
[src]

pub fn set_property<'a, N, V>(
    &self,
    property_name: N,
    value: V
) -> Result<(), BoolError> where
    V: ToValue,
    N: Into<&'a str>, 
[src]

pub fn set_property_from_value<'a, N>(
    &self,
    property_name: N,
    value: &Value
) -> Result<(), BoolError> where
    N: Into<&'a str>, 
[src]

pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
    N: Into<&'a str>, 
[src]

pub unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
    QD: 'static, 
[src]

Safety Read more

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]

Safety Read more

pub unsafe fn set_data<QD>(&self, key: &str, value: QD) where
    QD: 'static, 
[src]

Safety Read more

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]

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]

pub fn connect_notify_local<F>(
    &self,
    name: Option<&str>,
    f: F
) -> SignalHandlerId where
    F: 'static + Fn(&T, &ParamSpec), 
[src]

pub unsafe fn connect_notify_unsafe<F>(
    &self,
    name: Option<&str>,
    f: F
) -> SignalHandlerId where
    F: Fn(&T, &ParamSpec), 
[src]

pub fn notify<'a, N>(&self, property_name: N) where
    N: Into<&'a str>, 
[src]

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]

pub fn property_type<'a, N>(&self, property_name: N) -> Option<Type> where
    N: Into<&'a str>, 
[src]

pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
    N: Into<&'a str>, 
[src]

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]

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]

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]

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]

Emit signal by signal id.

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]

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]

pub fn ref_count(&self) -> u32[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.

pub fn emit_by_name_with_values<'a, N>(
    &self,
    signal_name: N,
    args: &[Value]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>, 
[src]

Same as emit_by_name but takes Value for the arguments.

pub fn emit_with_details_and_values(
    &self,
    signal_id: SignalId,
    details: Quark,
    args: &[Value]
) -> Result<Option<Value>, BoolError>
[src]

Same as emit_with_details but takes Value for the arguments.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

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]

🔬 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]

pub fn to_send_value(&self) -> SendValue[src]

Returns a SendValue clone of self.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<O> URIHandlerExt for O where
    O: IsA<URIHandler>, 
[src]

pub fn protocols(&self) -> Vec<GString, Global>[src]

Gets the list of protocols supported by self. This list may not be modified. Read more

pub fn uri(&self) -> Option<GString>[src]

Gets the currently handled URI. Read more

pub fn uri_type(&self) -> URIType[src]

Gets the type of the given URI handler Read more

pub fn set_uri(&self, uri: &str) -> Result<(), Error>[src]

Tries to set the URI of the given handler. Read more

impl<Super, Sub> CanDowncast<Sub> for Super where
    Sub: IsA<Super>,
    Super: IsA<Super>, 
[src]

impl<'a, T, C> FromValueOptional<'a> for T where
    C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
    T: FromValue<'a, Checker = C>, 
[src]