Struct gstreamer_video::VideoDecoder [−][src]
pub struct VideoDecoder(_);
This base class is for video decoders turning encoded data into raw video frames.
The GstVideoDecoder base class and derived subclasses should cooperate as follows:
Configuration
-
Initially, GstVideoDecoder calls
start
when the decoder element is activated, which allows the subclass to perform any global setup. -
GstVideoDecoder calls
set_format
to inform the subclass of caps describing input video data that it is about to receive, including possibly configuration data. While unlikely, it might be called more than once, if changing input parameters require reconfiguration. -
Incoming data buffers are processed as needed, described in Data Processing below.
-
GstVideoDecoder calls
stop
at end of all processing.
Data processing
-
The base class gathers input data, and optionally allows subclass to parse this into subsequently manageable chunks, typically corresponding to and referred to as ‘frames’.
-
Each input frame is provided in turn to the subclass’
handle_frame
callback. The ownership of the frame is given to thehandle_frame
callback. -
If codec processing results in decoded data, the subclass should call [
Self::finish_frame
] to have decoded data pushed. downstream. Otherwise, the subclass must call [Self::drop_frame
], to allow the base class to do timestamp and offset tracking, and possibly to requeue the frame for a later attempt in the case of reverse playback.
Shutdown phase
- The GstVideoDecoder class calls
stop
to inform the subclass that data parsing will be stopped.
Additional Notes
-
Seeking/Flushing
-
When the pipeline is seeked or otherwise flushed, the subclass is informed via a call to its
reset
callback, with the hard parameter set to true. This indicates the subclass should drop any internal data queues and timestamps and prepare for a fresh set of buffers to arrive for parsing and decoding. -
End Of Stream
-
At end-of-stream, the subclass
parse
function may be called some final times with the at_eos parameter set to true, indicating that the element should not expect any more data to be arriving, and it should parse and remaining frames and callcrate::prelude::VideoDecoderExt::have_frame()
if possible.
The subclass is responsible for providing pad template caps for
source and sink pads. The pads need to be named “sink” and “src”. It also
needs to provide information about the output caps, when they are known.
This may be when the base class calls the subclass’ set_format
function,
though it might be during decoding, before calling
[Self::finish_frame
]. This is done via
[Self::set_output_state
]
The subclass is also responsible for providing (presentation) timestamps (likely based on corresponding input ones). If that is not applicable or possible, the base class provides limited framerate based interpolation.
Similarly, the base class provides some limited (legacy) seeking support
if specifically requested by the subclass, as full-fledged support
should rather be left to upstream demuxer, parser or alike. This simple
approach caters for seeking and duration reporting using estimated input
bitrates. To enable it, a subclass should call
crate::prelude::VideoDecoderExt::set_estimate_rate
(XXX: @-reference does not belong to VideoDecoder!) to enable handling of incoming
byte-streams.
The base class provides some support for reverse playback, in particular in case incoming data is not packetized or upstream does not provide fragments on keyframe boundaries. However, the subclass should then be prepared for the parsing and frame processing stage to occur separately (in normal forward processing, the latter immediately follows the former), The subclass also needs to ensure the parsing stage properly marks keyframes, unless it knows the upstream elements will do so properly for incoming data.
The bare minimum that a functional subclass needs to implement is:
-
Provide pad templates
-
Inform the base class of output caps via [
Self::set_output_state
] -
Parse input data, if it is not considered packetized from upstream Data will be provided to
parse
which should invokecrate::prelude::VideoDecoderExt::add_to_frame
(XXX: @-reference does not belong to VideoDecoder!) andcrate::prelude::VideoDecoderExt::have_frame
(XXX: @-reference does not belong to VideoDecoder!) to separate the data belonging to each video frame. -
Accept data in
handle_frame
and provide decoded results to [Self::finish_frame
], or call [Self::drop_frame
].
This is an Abstract Base Class, you cannot instantiate it.
Implements
crate::prelude::VideoDecoderExt
, gst::prelude::ElementExt
, gst::prelude::ObjectExt
, trait@glib::object::ObjectExt
, crate::prelude::VideoDecoderExtManual
Trait Implementations
impl Clone for VideoDecoder
[src]
impl Clone for VideoDecoder
[src]fn clone(&self) -> VideoDecoder
[src]
fn clone(&self) -> VideoDecoder
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for VideoDecoder
[src]
impl Debug for VideoDecoder
[src]impl Hash for VideoDecoder
[src]
impl Hash for VideoDecoder
[src]impl<T: VideoDecoderImpl> IsSubclassable<T> for VideoDecoder
[src]
impl<T: VideoDecoderImpl> IsSubclassable<T> for VideoDecoder
[src]fn class_init(klass: &mut Class<Self>)
[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]
fn instance_init(instance: &mut InitializingObject<T>)
[src]Instance specific initialization. Read more
impl Ord for VideoDecoder
[src]
impl Ord for VideoDecoder
[src]impl ParentClassIs for VideoDecoder
[src]
impl ParentClassIs for VideoDecoder
[src]impl<T: ObjectType> PartialEq<T> for VideoDecoder
[src]
impl<T: ObjectType> PartialEq<T> for VideoDecoder
[src]impl<T: ObjectType> PartialOrd<T> for VideoDecoder
[src]
impl<T: ObjectType> PartialOrd<T> for VideoDecoder
[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) -> bool
1.0.0[src]
#[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]
#[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
impl StaticType for VideoDecoder
[src]
impl StaticType for VideoDecoder
[src]fn static_type() -> Type
[src]
fn static_type() -> Type
[src]Returns the type identifier of Self
.
impl Eq for VideoDecoder
[src]
impl IsA<Element> for VideoDecoder
[src]
impl IsA<Object> for VideoDecoder
[src]
impl Send for VideoDecoder
[src]
impl StructuralEq for VideoDecoder
[src]
impl Sync for VideoDecoder
[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
V: Into<GenericFormattedValue>,
U: SpecificFormattedValue,
[src]
V: Into<GenericFormattedValue>,
U: SpecificFormattedValue,
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
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>,
[src]
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
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 = T
The 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<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>,