Struct gstreamer_audio::AudioSink[−][src]

pub struct AudioSink(_);

This is the most simple base class for audio sinks that only requires subclasses to implement a set of simple functions:

open() :Open the device.
prepare() :Configure the device with the specified format.
write() :Write samples to the device.
reset() :Unblock writes and flush the device.
delay() :Get the number of samples written but not yet played by the device.
unprepare() :Undo operations done by prepare.
close() :Close the device.

All scheduling of samples and timestamps is done in this base class together with crate::AudioBaseSink using a default implementation of a [crate::AudioRingBuffer] that uses threads.

Implements

crate::prelude::AudioBaseSinkExt, gst_base::prelude::BaseSinkExt, gst::prelude::ElementExt, gst::prelude::GstObjectExt, glib::object::ObjectExt

Trait Implementations

`impl Clone for AudioSink`[src]

`fn clone(&self) -> AudioSink`[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 AudioSink`[src]

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

Formats the value using the given formatter. Read more

`impl Hash for AudioSink`[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<T: AudioSinkImpl> IsSubclassable<T> for AudioSink`[src]

`fn class_init(klass: &mut Class<Self>)`[src]

Override the virtual methods of this class for the given subclass and do other class initialization. Read more

`fn instance_init(instance: &mut InitializingObject<T>)`[src]

Instance specific initialization. Read more

`impl Ord for AudioSink`[src]

`fn cmp(&self, other: &AudioSink) -> 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 AudioSink`[src]

`impl<T: ObjectType> PartialEq<T> for AudioSink`[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 AudioSink`[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 AudioSink`[src]

`fn static_type() -> Type`[src]

Returns the type identifier of Self.

`impl IsA<AudioBaseSink> for AudioSink`[src]

`impl IsA<BaseSink> for AudioSink`[src]

`impl IsA<Element> for AudioSink`[src]

`impl IsA<Object> for AudioSink`[src]

`impl Send for AudioSink`[src]

`impl StructuralEq for AudioSink`[src]

`impl Sync for AudioSink`[src]

Auto Trait Implementations

`impl RefUnwindSafe for AudioSink`

`impl UnwindSafe for AudioSink`

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<O> BaseSinkExt for O where O: IsA<BaseSink>,` [src]

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

Get the number of bytes that the sink will pull when it is operating in pull mode. Read more

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

This is supported on crate feature v1_12 only.

Checks if self is currently configured to drop buffers which are outside the current segment Read more

`pub fn last_sample(&self) -> Option<Sample>`[src]

Get the last sample that arrived in the sink and was used for preroll or for rendering. This property can be used to generate thumbnails. Read more

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

Get the currently configured latency. Read more

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

Get the maximum amount of bits per second that the sink will render. Read more

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

Gets the max lateness value. See Self::set_max_lateness() for more details. Read more

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

This is supported on crate feature v1_16 only.

Get the processing deadline of self. see Self::set_processing_deadline() for more information about the processing deadline. Read more

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

Get the render delay of self. see Self::set_render_delay() for more information about the render delay. Read more

`pub fn stats(&self) -> Structure`[src]

This is supported on crate feature v1_18 only.

Return various crate::BaseSink statistics. This function returns a crate::gst::Structure with name application/x-gst-base-sink-stats with the following fields: Read more

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

Checks if self is currently configured to synchronize against the clock. Read more

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

Get the time that will be inserted between frames to control the maximum buffers per second. Read more

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

Get the synchronisation offset of self. Read more

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

Checks if self is currently configured to perform asynchronous state changes to PAUSED. Read more

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

Checks if self is currently configured to store the last received sample in the last-sample property. Read more

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

Checks if self is currently configured to send Quality-of-Service events upstream. Read more

`pub fn set_async_enabled(&self, enabled: bool)`[src]

Configures self to perform all state changes asynchronously. When async is disabled, the sink will immediately go to PAUSED instead of waiting for a preroll buffer. This feature is useful if the sink does not synchronize against the clock or when it is dealing with sparse streams. Read more

`pub fn set_blocksize(&self, blocksize: u32)`[src]

Set the number of bytes that the sink will pull when it is operating in pull mode. Read more

`pub fn set_drop_out_of_segment(&self, drop_out_of_segment: bool)`[src]

This is supported on crate feature v1_12 only.

Configure self to drop buffers which are outside the current segment Read more

`pub fn set_last_sample_enabled(&self, enabled: bool)`[src]

Configures self to store the last received sample in the last-sample property. Read more

`pub fn set_max_bitrate(&self, max_bitrate: u64)`[src]

Set the maximum amount of bits per second that the sink will render. Read more

`pub fn set_max_lateness(&self, max_lateness: i64)`[src]

Sets the new max lateness value to max_lateness. This value is used to decide if a buffer should be dropped or not based on the buffer timestamp and the current clock time. A value of -1 means an unlimited time. Read more

`pub fn set_processing_deadline(&self, processing_deadline: ClockTime)`[src]

This is supported on crate feature v1_16 only.

Maximum amount of time (in nanoseconds) that the pipeline can take for processing the buffer. This is added to the latency of live pipelines. Read more

`pub fn set_qos_enabled(&self, enabled: bool)`[src]

Configures self to send Quality-of-Service events upstream. Read more

`pub fn set_render_delay(&self, delay: ClockTime)`[src]

Set the render delay in self to delay. The render delay is the time between actual rendering of a buffer and its synchronisation time. Some devices might delay media rendering which can be compensated for with this function. Read more

`pub fn set_sync(&self, sync: bool)`[src]

Configures self to synchronize on the clock or not. When sync is false, incoming samples will be played as fast as possible. If sync is true, the timestamps of the incoming buffers will be used to schedule the exact render time of its contents. Read more

`pub fn set_throttle_time(&self, throttle: u64)`[src]

Set the time that will be inserted between rendered buffers. This can be used to control the maximum buffers per second that the sink will render. Read more

`pub fn set_ts_offset(&self, offset: i64)`[src]

Adjust the synchronisation of self with offset. A negative value will render buffers earlier than their timestamp. A positive value will delay rendering. This function can be used to fix playback of badly timestamped buffers. Read more

`pub fn wait(&self, time: ClockTime) -> (Result<FlowSuccess, FlowError>, i64)`[src]

This function will wait for preroll to complete and will then block until time is reached. It is usually called by subclasses that use their own internal synchronisation but want to let some synchronization (like EOS) be handled by the base class. Read more

`pub fn wait_clock( &self, time: ClockTime ) -> (Result<ClockSuccess, ClockError>, i64)`[src]

This function will block until time is reached. It is usually called by subclasses that use their own internal synchronisation. Read more

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

If the [crate::GstBaseSinkClass.render()] method performs its own synchronisation against the clock it must unblock when going from PLAYING to the PAUSED state and call this method before continuing to render the remaining data. Read more

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

`pub fn set_async(&self, async_: bool)`[src]

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

`pub fn set_enable_last_sample(&self, enable_last_sample: bool)`[src]

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

`pub fn set_qos(&self, qos: bool)`[src]

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

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

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

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

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

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

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

This is supported on crate feature v1_16 only.

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

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

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

This is supported on crate feature v1_18 only.

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

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

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

`impl<O> BaseSinkExtManual for O where O: IsA<BaseSink>,` [src]

`pub fn segment(&self) -> FormattedSegment<GenericFormattedValue>`[src]

`pub fn query_latency( &self ) -> Result<(bool, bool, ClockTime, ClockTime), BoolError>`[src]

`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(&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(&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(&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(&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(&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 link(&self, dest: &P) -> Result<(), BoolError> where P: IsA<Element>,` [src]

`pub fn link_filtered( &self, dest: &P, filter: Option<&Caps> ) -> Result<(), BoolError> where P: IsA<Element>,` [src]

`pub fn link_pads( &self, srcpadname: Option<&str>, dest: &P, destpadname: Option<&str> ) -> Result<(), BoolError> where P: IsA<Element>,` [src]

`pub fn link_pads_filtered( &self, srcpadname: Option<&str>, dest: &P, destpadname: Option<&str>, filter: Option<&Caps> ) -> Result<(), BoolError> where P: IsA<Element>,` [src]

`pub fn link_pads_full( &self, srcpadname: Option<&str>, dest: &P, destpadname: Option<&str>, flags: PadLinkCheck ) -> Result<(), BoolError> where P: IsA<Element>,` [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(&self, pad: &P) where P: IsA<Pad>,` [src]

`pub fn remove_pad(&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(&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 unlink(&self, dest: &P) where P: IsA<Element>,` [src]

`pub fn unlink_pads(&self, srcpadname: &str, dest: &P, destpadname: &str) where P: IsA<Element>,` [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 where V: Into<GenericFormattedValue>, U: SpecificFormattedValue,` [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(&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(&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(&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(&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(&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(&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 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(&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(&self) -> Option<&Class> where U: IsClass,` [src]

`pub fn interface(&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 O: ObjectType, N: Into<&'a str>, 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 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>::Error>`[src]

Performs the conversion.

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

`type Error = >::Error`

The type returned in the event of a conversion error.

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

Performs the conversion.

Struct gstreamer_audio::AudioSink⎘[−][src]

Implements

Trait Implementations

impl Clone for AudioSink[src]

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

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

impl Debug for AudioSink[src]

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

impl Hash for AudioSink[src]

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

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

impl<T: AudioSinkImpl> IsSubclassable<T> for AudioSink[src]

fn class_init(klass: &mut Class<Self>)[src]

fn instance_init(instance: &mut InitializingObject<T>)[src]

impl Ord for AudioSink[src]

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

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

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

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

impl ParentClassIs for AudioSink[src]

type Parent = AudioBaseSink

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool1.0.0[src]

impl<T: ObjectType> PartialOrd<T> for AudioSink[src]

fn partial_cmp(&self, other: &T) -> Option<Ordering>[src]

#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn gt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn ge(&self, other: &Rhs) -> bool1.0.0[src]

impl StaticType for AudioSink[src]

fn static_type() -> Type[src]

impl Eq for AudioSink[src]

impl IsA<AudioBaseSink> for AudioSink[src]

impl IsA<BaseSink> for AudioSink[src]

impl IsA<Element> for AudioSink[src]

impl IsA<Object> for AudioSink[src]

impl Send for AudioSink[src]

impl StructuralEq for AudioSink[src]

impl Sync for AudioSink[src]

Auto Trait Implementations

impl RefUnwindSafe for AudioSink

impl Unpin for AudioSink

impl UnwindSafe for AudioSink

Blanket Implementations

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

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

impl<O> BaseSinkExt for O where O: IsA<BaseSink>, [src]

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

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

pub fn last_sample(&self) -> Option<Sample>[src]

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

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

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

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

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

pub fn stats(&self) -> Structure[src]

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

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

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

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

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

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

pub fn set_async_enabled(&self, enabled: bool)[src]

pub fn set_blocksize(&self, blocksize: u32)[src]

pub fn set_drop_out_of_segment(&self, drop_out_of_segment: bool)[src]

pub fn set_last_sample_enabled(&self, enabled: bool)[src]

pub fn set_max_bitrate(&self, max_bitrate: u64)[src]

pub fn set_max_lateness(&self, max_lateness: i64)[src]

pub fn set_processing_deadline(&self, processing_deadline: ClockTime)[src]

pub fn set_qos_enabled(&self, enabled: bool)[src]

pub fn set_render_delay(&self, delay: ClockTime)[src]

pub fn set_sync(&self, sync: bool)[src]

pub fn set_throttle_time(&self, throttle: u64)[src]

pub fn set_ts_offset(&self, offset: i64)[src]

pub fn wait(&self, time: ClockTime) -> (Result<FlowSuccess, FlowError>, i64)[src]

pub fn wait_clock( &self, time: ClockTime) -> (Result<ClockSuccess, ClockError>, i64)[src]

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

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

pub fn set_async(&self, async_: bool)[src]

Struct gstreamer_audio::AudioSink[−][src]

`impl Clone for AudioSink`[src]

`fn clone(&self) -> AudioSink`[src]

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

`impl Debug for AudioSink`[src]

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

`impl Hash for AudioSink`[src]

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

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

`impl<T: AudioSinkImpl> IsSubclassable<T> for AudioSink`[src]

`fn class_init(klass: &mut Class<Self>)`[src]

`fn instance_init(instance: &mut InitializingObject<T>)`[src]

`impl Ord for AudioSink`[src]

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

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

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

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

`impl ParentClassIs for AudioSink`[src]

`type Parent = AudioBaseSink`

`impl<T: ObjectType> PartialEq<T> for AudioSink`[src]

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

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

`impl<T: ObjectType> PartialOrd<T> for AudioSink`[src]

`fn partial_cmp(&self, other: &T) -> Option<Ordering>`[src]

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

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

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

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

`impl StaticType for AudioSink`[src]

`fn static_type() -> Type`[src]

`impl Eq for AudioSink`[src]

`impl IsA<AudioBaseSink> for AudioSink`[src]

`impl IsA<BaseSink> for AudioSink`[src]

`impl IsA<Element> for AudioSink`[src]

`impl IsA<Object> for AudioSink`[src]

`impl Send for AudioSink`[src]

`impl StructuralEq for AudioSink`[src]

`impl Sync for AudioSink`[src]

`impl RefUnwindSafe for AudioSink`

`impl Unpin for AudioSink`

`impl UnwindSafe for AudioSink`

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

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

`impl<O> BaseSinkExt for O where O: IsA<BaseSink>,` [src]

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

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

`pub fn last_sample(&self) -> Option<Sample>`[src]

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

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

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

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

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

`pub fn stats(&self) -> Structure`[src]

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

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

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

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

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

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

`pub fn set_async_enabled(&self, enabled: bool)`[src]

`pub fn set_blocksize(&self, blocksize: u32)`[src]

`pub fn set_drop_out_of_segment(&self, drop_out_of_segment: bool)`[src]

`pub fn set_last_sample_enabled(&self, enabled: bool)`[src]

`pub fn set_max_bitrate(&self, max_bitrate: u64)`[src]

`pub fn set_max_lateness(&self, max_lateness: i64)`[src]

`pub fn set_processing_deadline(&self, processing_deadline: ClockTime)`[src]

`pub fn set_qos_enabled(&self, enabled: bool)`[src]

`pub fn set_render_delay(&self, delay: ClockTime)`[src]

`pub fn set_sync(&self, sync: bool)`[src]

`pub fn set_throttle_time(&self, throttle: u64)`[src]

`pub fn set_ts_offset(&self, offset: i64)`[src]

`pub fn wait(&self, time: ClockTime) -> (Result<FlowSuccess, FlowError>, i64)`[src]

`pub fn wait_clock( &self, time: ClockTime ) -> (Result<ClockSuccess, ClockError>, i64)`[src]

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

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

`pub fn set_async(&self, async_: bool)`[src]

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

`pub fn set_enable_last_sample(&self, enable_last_sample: bool)`[src]

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

`pub fn set_qos(&self, qos: bool)`[src]