Struct Video
Source pub struct VideoEncoder { /* private fields */ }Expand description
This base class is for video encoders turning raw video into encoded video data.
GstVideoEncoder and subclass should cooperate as follows.
§Configuration
- Initially, GstVideoEncoder calls
startwhen the encoder element is activated, which allows subclass to perform any global setup. - GstVideoEncoder calls
set_formatto inform subclass of the format of input video data that it is about to receive. Subclass should setup for encoding and configure base class as appropriate (e.g. latency). While unlikely, it might be called more than once, if changing input parameters require reconfiguration. Baseclass will ensure that processing of current configuration is finished. - GstVideoEncoder calls
stopat end of all processing.
§Data processing
-
Base class collects input data and metadata into a frame and hands this to subclass’
handle_frame. -
If codec processing results in encoded data, subclass should call
VideoEncoderExt::finish_frame()to have encoded data pushed downstream. -
If implemented, baseclass calls subclass
pre_pushjust prior to pushing to allow subclasses to modify some metadata on the buffer. If it returns GST_FLOW_OK, the buffer is pushed downstream. -
GstVideoEncoderClass will handle both srcpad and sinkpad events. Sink events will be passed to subclass if
eventcallback has been provided.
§Shutdown phase
- GstVideoEncoder class calls
stopto inform the subclass that data parsing will be stopped.
Subclass is responsible for providing pad template caps for
source and sink pads. The pads need to be named “sink” and “src”. It should
also be able to provide fixed src pad caps in getcaps by the time it calls
VideoEncoderExt::finish_frame().
Things that subclass need to take care of:
- Provide pad templates
- Provide source pad caps before pushing the first buffer
- Accept data in
handle_frameand provide encoded results toVideoEncoderExt::finish_frame().
The qos property will enable the Quality-of-Service
features of the encoder which gather statistics about the real-time
performance of the downstream elements. If enabled, subclasses can
use VideoEncoderExt::max_encode_time() to check if input frames
are already late and drop them right away to give a chance to the
pipeline to catch up.
This is an Abstract Base Class, you cannot instantiate it.
§Properties
§min-force-key-unit-interval
Minimum interval between force-keyunit requests in nanoseconds. See
VideoEncoderExt::set_min_force_key_unit_interval() for more details.
Readable | Writeable
§qos
Readable | Writeable
Object
§name
Readable | Writeable | Construct
§parent
The parent of the object. Please note, that when changing the ‘parent’
property, we don’t emit notify and [deep-notify][struct@crate::gst::Object#deep-notify]
signals due to locking issues. In some cases one can use
GstBin::element-added or GstBin::element-removed signals on the parent to
achieve a similar effect.
Readable | Writeable
§Implements
VideoEncoderExt, [trait@gst::prelude::ElementExt], gst::prelude::ObjectExt, [trait@glib::ObjectExt], VideoEncoderExtManual
GLib type: GObject with reference counted clone semantics.
Implementations§
Source§impl VideoEncoder
impl VideoEncoder
pub const NONE: Option<&'static VideoEncoder> = None
Trait Implementations§
Source§impl Clone for VideoEncoder
impl Clone for VideoEncoder
Source§impl Debug for VideoEncoder
impl Debug for VideoEncoder
Source§impl HasParamSpec for VideoEncoder
impl HasParamSpec for VideoEncoder
type ParamSpec = ParamSpecObject
Source§type SetValue = VideoEncoder
type SetValue = VideoEncoder
Preferred value to be used as setter for the associated ParamSpec.
type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, VideoEncoder>
fn param_spec_builder() -> Self::BuilderFn
Source§impl Hash for VideoEncoder
impl Hash for VideoEncoder
Source§impl<T: VideoEncoderImpl> IsSubclassable<T> for VideoEncoder
impl<T: VideoEncoderImpl> IsSubclassable<T> for VideoEncoder
Source§fn class_init(klass: &mut Class<Self>)
fn class_init(klass: &mut Class<Self>)
Override the virtual methods of this class for the given subclass and do other class
initialization. Read more
Source§fn instance_init(instance: &mut InitializingObject<T>)
fn instance_init(instance: &mut InitializingObject<T>)
Instance specific initialization. Read more
Source§impl Ord for VideoEncoder
impl Ord for VideoEncoder
Source§fn cmp(&self, other: &Self) -> Ordering
fn cmp(&self, other: &Self) -> Ordering
Comparison for two GObjects.
Compares the memory addresses of the provided objects.
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
Source§impl ParentClassIs for VideoEncoder
impl ParentClassIs for VideoEncoder
Source§impl<OT: ObjectType> PartialEq<OT> for VideoEncoder
impl<OT: ObjectType> PartialEq<OT> for VideoEncoder
Source§impl<OT: ObjectType> PartialOrd<OT> for VideoEncoder
impl<OT: ObjectType> PartialOrd<OT> for VideoEncoder
Source§impl StaticType for VideoEncoder
impl StaticType for VideoEncoder
Source§fn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of
Self.impl Eq for VideoEncoder
impl IsA<Element> for VideoEncoder
impl IsA<Object> for VideoEncoder
impl Send for VideoEncoder
impl Sync for VideoEncoder
Auto Trait Implementations§
impl Freeze for VideoEncoder
impl RefUnwindSafe for VideoEncoder
impl Unpin for VideoEncoder
impl UnwindSafe for VideoEncoder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Cast for Twhere
T: ObjectType,
impl<T> Cast for Twhere
T: ObjectType,
Source§fn upcast<T>(self) -> Twhere
T: ObjectType,
Self: IsA<T>,
fn upcast<T>(self) -> Twhere
T: ObjectType,
Self: IsA<T>,
Upcasts an object to a superclass or interface
T. Read moreSource§fn upcast_ref<T>(&self) -> &Twhere
T: ObjectType,
Self: IsA<T>,
fn upcast_ref<T>(&self) -> &Twhere
T: ObjectType,
Self: IsA<T>,
Upcasts an object to a reference of its superclass or interface
T. Read moreSource§fn downcast<T>(self) -> Result<T, Self>where
T: ObjectType,
Self: MayDowncastTo<T>,
fn downcast<T>(self) -> Result<T, Self>where
T: ObjectType,
Self: MayDowncastTo<T>,
Tries to downcast to a subclass or interface implementor
T. Read moreSource§fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: MayDowncastTo<T>,
fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: MayDowncastTo<T>,
Tries to downcast to a reference of its subclass or interface implementor
T. Read moreSource§fn dynamic_cast<T>(self) -> Result<T, Self>where
T: ObjectType,
fn dynamic_cast<T>(self) -> Result<T, Self>where
T: ObjectType,
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 upcast will do many checks at compile-time already. downcast will
perform the same checks at runtime as dynamic_cast, but will also ensure some amount of
compile-time safety. Read moreSource§fn dynamic_cast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
fn dynamic_cast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
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 moreSource§unsafe fn unsafe_cast<T>(self) -> Twhere
T: ObjectType,
unsafe fn unsafe_cast<T>(self) -> Twhere
T: ObjectType,
Casts to
T unconditionally. Read moreSource§unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,
unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,
Casts to
&T unconditionally. Read moreSource§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<O> ElementExt for Owhere
O: IsA<Element>,
impl<O> ElementExt for Owhere
O: IsA<Element>,
§fn abort_state(&self)
fn abort_state(&self)
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
§fn add_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
fn add_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
Adds a pad (link point) to
self. pad’s parent will be set to self;
see [GstObjectExt::set_parent()][crate::prelude::GstObjectExt::set_parent()] for refcounting information. Read more§fn change_state(
&self,
transition: StateChange,
) -> Result<StateChangeSuccess, StateChangeError>
fn change_state( &self, transition: StateChange, ) -> Result<StateChangeSuccess, StateChangeError>
§fn continue_state(
&self,
ret: impl Into<StateChangeReturn>,
) -> Result<StateChangeSuccess, StateChangeError>
fn continue_state( &self, ret: impl Into<StateChangeReturn>, ) -> Result<StateChangeSuccess, StateChangeError>
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 [
StateChangeReturn::Success][crate::StateChangeReturn::Success] from the state change function. Read more§fn create_all_pads(&self)
fn create_all_pads(&self)
Creates a pad for each pad template that is always available.
This function is only useful during object initialization of
subclasses of [
Element][crate::Element].§fn decorate_stream_id(&self, stream_id: &str) -> GString
fn decorate_stream_id(&self, stream_id: &str) -> GString
§fn base_time(&self) -> Option<ClockTime>
fn base_time(&self) -> Option<ClockTime>
Returns the base time of the element. The base time is the
absolute time of the clock when this element was last put to
PLAYING. Subtracting the base time from the clock time gives
the running time of the element. Read more
§fn bus(&self) -> Option<Bus>
fn bus(&self) -> Option<Bus>
Returns the bus of the element. Note that only a [
Pipeline][crate::Pipeline] will provide a
bus for the application. Read more§fn clock(&self) -> Option<Clock>
fn clock(&self) -> Option<Clock>
Gets the currently configured clock of the element. This is the clock as was
last set with [
set_clock()][Self::set_clock()]. Read more§fn compatible_pad(
&self,
pad: &impl IsA<Pad>,
caps: Option<&Caps>,
) -> Option<Pad>
fn compatible_pad( &self, pad: &impl IsA<Pad>, caps: Option<&Caps>, ) -> Option<Pad>
Looks for an unlinked pad to which the given pad can link. It is not
guaranteed that linking the pads will work, though it should work in most
cases. Read more
§fn compatible_pad_template(
&self,
compattempl: &PadTemplate,
) -> Option<PadTemplate>
fn compatible_pad_template( &self, compattempl: &PadTemplate, ) -> Option<PadTemplate>
Retrieves a pad template from
self that is compatible with compattempl.
Pads from compatible templates can be linked together. Read more§fn context(&self, context_type: &str) -> Option<Context>
fn context(&self, context_type: &str) -> Option<Context>
Gets the context with
context_type set on the element or NULL. Read more§fn factory(&self) -> Option<ElementFactory>
fn factory(&self) -> Option<ElementFactory>
Retrieves the factory that was used to create this element. Read more
§fn start_time(&self) -> Option<ClockTime>
fn start_time(&self) -> Option<ClockTime>
Returns the start time of the element. The start time is the
running time of the clock when this element was last put to PAUSED. Read more
§fn state(
&self,
timeout: impl Into<Option<ClockTime>>,
) -> (Result<StateChangeSuccess, StateChangeError>, State, State)
fn state( &self, timeout: impl Into<Option<ClockTime>>, ) -> (Result<StateChangeSuccess, StateChangeError>, State, State)
Gets the state of the element. Read more
§fn static_pad(&self, name: &str) -> Option<Pad>
fn static_pad(&self, name: &str) -> Option<Pad>
Retrieves a pad from
self by name. This version only retrieves
already-existing (i.e. ‘static’) pads. Read more§fn is_locked_state(&self) -> bool
fn is_locked_state(&self) -> bool
Checks if the state of an element is locked.
If the state of an element is locked, state changes of the parent don’t
affect the element.
This way you can leave currently unused elements inside bins. Just lock their
state before changing the state from [
State::Null][crate::State::Null]. Read more§fn lost_state(&self)
fn lost_state(&self)
Brings the element to the lost state. The current state of the
element is copied to the pending state so that any call to
[
state()][Self::state()] will return [StateChangeReturn::Async][crate::StateChangeReturn::Async]. Read more§fn no_more_pads(&self)
fn no_more_pads(&self)
Use this function to signal that the element does not expect any more pads
to show up in the current pipeline. This function should be called whenever
pads have been added by the element itself. Elements with [
PadPresence::Sometimes][crate::PadPresence::Sometimes]
pad templates use this in combination with autopluggers to figure out that
the element is done initializing its pads. Read more§fn post_message(&self, message: Message) -> Result<(), BoolError>
fn post_message(&self, message: Message) -> Result<(), BoolError>
Post a message on the element’s [
Bus][crate::Bus]. This function takes ownership of the
message; if you want to access the message after this call, you should add an
additional reference before calling. Read more§fn provide_clock(&self) -> Option<Clock>
fn provide_clock(&self) -> Option<Clock>
Get the clock provided by the given element. Read more
§fn release_request_pad(&self, pad: &impl IsA<Pad>)
fn release_request_pad(&self, pad: &impl IsA<Pad>)
Makes the element free the previously requested pad as obtained
with [
request_pad()][Self::request_pad()]. Read more§fn remove_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
fn remove_pad(&self, pad: &impl IsA<Pad>) -> Result<(), BoolError>
Removes
pad from self. pad will be destroyed if it has not been
referenced elsewhere using [GstObjectExt::unparent()][crate::prelude::GstObjectExt::unparent()]. Read more§fn request_pad(
&self,
templ: &PadTemplate,
name: Option<&str>,
caps: Option<&Caps>,
) -> Option<Pad>
fn request_pad( &self, templ: &PadTemplate, name: Option<&str>, caps: Option<&Caps>, ) -> Option<Pad>
Retrieves a request pad from the element according to the provided template.
Pad templates can be looked up using
[
ElementFactory::static_pad_templates()][crate::ElementFactory::static_pad_templates()]. Read more§fn set_base_time(&self, time: ClockTime)
fn set_base_time(&self, time: ClockTime)
Set the base time of an element. See [
base_time()][Self::base_time()]. Read more§fn set_bus(&self, bus: Option<&Bus>)
fn set_bus(&self, bus: Option<&Bus>)
Sets the bus of the element. Increases the refcount on the bus.
For internal use only, unless you’re testing elements. Read more
§fn set_clock(&self, clock: Option<&impl IsA<Clock>>) -> Result<(), BoolError>
fn set_clock(&self, clock: Option<&impl IsA<Clock>>) -> Result<(), BoolError>
Sets the clock for the element. This function increases the
refcount on the clock. Any previously set clock on the object
is unreffed. Read more
§fn set_context(&self, context: &Context)
fn set_context(&self, context: &Context)
Sets the context of the element. Increases the refcount of the context. Read more
§fn set_locked_state(&self, locked_state: bool) -> bool
fn set_locked_state(&self, locked_state: bool) -> bool
Locks the state of an element, so state changes of the parent don’t affect
this element anymore. Read more
§fn set_start_time(&self, time: impl Into<Option<ClockTime>>)
fn set_start_time(&self, time: impl Into<Option<ClockTime>>)
Set the start time of an element. The start time of the element is the
running time of the element when it last went to the PAUSED state. In READY
or after a flushing seek, it is set to 0. Read more
§fn set_state(
&self,
state: State,
) -> Result<StateChangeSuccess, StateChangeError>
fn set_state( &self, state: State, ) -> Result<StateChangeSuccess, StateChangeError>
Sets the state of the element. This function will try to set the
requested state by going through all the intermediary states and calling
the class’s state change function for each. Read more
§fn sync_state_with_parent(&self) -> Result<(), BoolError>
fn sync_state_with_parent(&self) -> Result<(), BoolError>
§fn unlink(&self, dest: &impl IsA<Element>)
fn unlink(&self, dest: &impl IsA<Element>)
Unlinks all source pads of the source element with all sink pads
of the sink element to which they are linked. Read more
§fn unlink_pads(
&self,
srcpadname: &str,
dest: &impl IsA<Element>,
destpadname: &str,
)
fn unlink_pads( &self, srcpadname: &str, dest: &impl IsA<Element>, destpadname: &str, )
Unlinks the two named pads of the source and destination elements. Read more
§fn connect_no_more_pads<F>(&self, f: F) -> SignalHandlerId
fn connect_no_more_pads<F>(&self, f: F) -> SignalHandlerId
This signals that the element will not generate more dynamic pads.
Note that this signal will usually be emitted from the context of
the streaming thread.
§fn connect_pad_added<F>(&self, f: F) -> SignalHandlerId
fn connect_pad_added<F>(&self, f: F) -> SignalHandlerId
a new [
Pad][crate::Pad] has been added to the element. Note that this signal will
usually be emitted from the context of the streaming thread. Also keep in
mind that if you add new elements to the pipeline in the signal handler
you will need to set them to the desired target state with
[set_state()][Self::set_state()] or [sync_state_with_parent()][Self::sync_state_with_parent()]. Read more§fn connect_pad_removed<F>(&self, f: F) -> SignalHandlerId
fn connect_pad_removed<F>(&self, f: F) -> SignalHandlerId
a [
Pad][crate::Pad] has been removed from the element Read more§impl<O> ElementExtManual for Owhere
O: IsA<Element>,
impl<O> ElementExtManual for Owhere
O: IsA<Element>,
fn element_class(&self) -> &Class<Element>
fn current_state(&self) -> State
fn pending_state(&self) -> State
§fn send_event(&self, event: impl Into<Event>) -> bool
fn send_event(&self, event: impl Into<Event>) -> bool
Sends an event to an element. If the element doesn’t implement an
event handler, the event will be pushed on a random linked sink pad for
downstream events or a random linked source pad for upstream events. Read more
§fn pad_template(&self, name: &str) -> Option<PadTemplate>
fn pad_template(&self, name: &str) -> Option<PadTemplate>
Retrieves a padtemplate from
self with the given name. Read more§fn pad_template_list(&self) -> List<PadTemplate>
fn pad_template_list(&self) -> List<PadTemplate>
Retrieves a list of the pad templates associated with
self. The
list must not be modified by the calling code. Read more§fn message_full<T>(
&self,
type_: ElementMessageType,
code: T,
message: Option<&str>,
debug: Option<&str>,
file: &str,
function: &str,
line: u32,
)where
T: MessageErrorDomain,
fn message_full<T>(
&self,
type_: ElementMessageType,
code: T,
message: Option<&str>,
debug: Option<&str>,
file: &str,
function: &str,
line: u32,
)where
T: MessageErrorDomain,
Post an error, warning or info message on the bus from inside an element. Read more
fn set_element_flags(&self, flags: ElementFlags)
fn unset_element_flags(&self, flags: ElementFlags)
fn element_flags(&self) -> ElementFlags
§fn message_full_with_details<T>(
&self,
type_: ElementMessageType,
code: T,
message: Option<&str>,
debug: Option<&str>,
file: &str,
function: &str,
line: u32,
structure: Structure,
)where
T: MessageErrorDomain,
fn message_full_with_details<T>(
&self,
type_: ElementMessageType,
code: T,
message: Option<&str>,
debug: Option<&str>,
file: &str,
function: &str,
line: u32,
structure: Structure,
)where
T: MessageErrorDomain,
Post an error, warning or info message on the bus from inside an element. Read more
fn post_error_message(&self, msg: ErrorMessage)
§fn iterate_pads(&self) -> Iterator<Pad>
fn iterate_pads(&self) -> Iterator<Pad>
Retrieves an iterator of
self’s pads. The iterator should
be freed after usage. Also more specialized iterators exists such as
[iterate_src_pads()][Self::iterate_src_pads()] or [iterate_sink_pads()][Self::iterate_sink_pads()]. Read more§fn iterate_sink_pads(&self) -> Iterator<Pad>
fn iterate_sink_pads(&self) -> Iterator<Pad>
Retrieves an iterator of
self’s sink pads. Read more§fn iterate_src_pads(&self) -> Iterator<Pad>
fn iterate_src_pads(&self) -> Iterator<Pad>
Retrieves an iterator of
self’s source pads. Read morefn pads(&self) -> Vec<Pad>
fn sink_pads(&self) -> Vec<Pad>
fn src_pads(&self) -> Vec<Pad>
§fn foreach_pad<F>(&self, func: F)
fn foreach_pad<F>(&self, func: F)
Call
func with user_data for each of self’s pads. func will be called
exactly once for each pad that exists at the time of this call, unless
one of the calls to func returns false in which case we will stop
iterating pads and return early. If new pads are added or pads are removed
while pads are being iterated, this will not be taken into account until
next time this function is used. Read more§fn foreach_sink_pad<F>(&self, func: F)
fn foreach_sink_pad<F>(&self, func: F)
Call
func with user_data for each of self’s sink pads. func will be
called exactly once for each sink pad that exists at the time of this call,
unless one of the calls to func returns false in which case we will stop
iterating pads and return early. If new sink pads are added or sink pads
are removed while the sink pads are being iterated, this will not be taken
into account until next time this function is used. Read more§fn foreach_src_pad<F>(&self, func: F)
fn foreach_src_pad<F>(&self, func: F)
Call
func with user_data for each of self’s source pads. func will be
called exactly once for each source pad that exists at the time of this call,
unless one of the calls to func returns false in which case we will stop
iterating pads and return early. If new source pads are added or source pads
are removed while the source pads are being iterated, this will not be taken
into account until next time this function is used. Read morefn num_pads(&self) -> u16
fn num_sink_pads(&self) -> u16
fn num_src_pads(&self) -> u16
§fn add_property_deep_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool,
) -> NotifyWatchId
fn add_property_deep_notify_watch( &self, property_name: Option<&str>, include_value: bool, ) -> NotifyWatchId
property_name Read more§fn add_property_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool,
) -> NotifyWatchId
fn add_property_notify_watch( &self, property_name: Option<&str>, include_value: bool, ) -> NotifyWatchId
property_name Read more§fn remove_property_notify_watch(&self, watch_id: NotifyWatchId)
fn remove_property_notify_watch(&self, watch_id: NotifyWatchId)
watch_id Read more§fn query_convert<U>(&self, src_val: impl FormattedValue) -> Option<U>where
U: SpecificFormattedValueFullRange,
fn query_convert<U>(&self, src_val: impl FormattedValue) -> Option<U>where
U: SpecificFormattedValueFullRange,
fn query_convert_generic( &self, src_val: impl FormattedValue, dest_format: Format, ) -> Option<GenericFormattedValue>
§fn query_duration<T>(&self) -> Option<T>where
T: SpecificFormattedValueIntrinsic,
fn query_duration<T>(&self) -> Option<T>where
T: SpecificFormattedValueIntrinsic,
Queries an element (usually top-level pipeline or playbin element) for the
total stream duration in nanoseconds. This query will only work once the
pipeline is prerolled (i.e. reached PAUSED or PLAYING state). The application
will receive an ASYNC_DONE message on the pipeline bus when that is the case. Read more
fn query_duration_generic( &self, format: Format, ) -> Option<GenericFormattedValue>
§fn query_position<T>(&self) -> Option<T>where
T: SpecificFormattedValueIntrinsic,
fn query_position<T>(&self) -> Option<T>where
T: SpecificFormattedValueIntrinsic,
Queries an element (usually top-level pipeline or playbin element) for the
stream position in nanoseconds. This will be a value between 0 and the
stream duration (if the stream duration is known). This query will usually
only work once the pipeline is prerolled (i.e. reached PAUSED or PLAYING
state). The application will receive an ASYNC_DONE message on the pipeline
bus when that is the case. Read more
fn query_position_generic( &self, format: Format, ) -> Option<GenericFormattedValue>
§fn seek<V>(
&self,
rate: f64,
flags: SeekFlags,
start_type: SeekType,
start: V,
stop_type: SeekType,
stop: impl CompatibleFormattedValue<V>,
) -> Result<(), BoolError>where
V: FormattedValue,
fn seek<V>(
&self,
rate: f64,
flags: SeekFlags,
start_type: SeekType,
start: V,
stop_type: SeekType,
stop: impl CompatibleFormattedValue<V>,
) -> Result<(), BoolError>where
V: FormattedValue,
Sends a seek event to an element. See
gst_event_new_seek() for the details of
the parameters. The seek event is sent to the element using
[send_event()][Self::send_event()]. Read more§fn seek_simple(
&self,
seek_flags: SeekFlags,
seek_pos: impl FormattedValue,
) -> Result<(), BoolError>
fn seek_simple( &self, seek_flags: SeekFlags, seek_pos: impl FormattedValue, ) -> Result<(), BoolError>
Simple API to perform a seek on the given element, meaning it just seeks
to the given position relative to the start of the stream. For more complex
operations like segment seeks (e.g. for looping) or changing the playback
rate or seeking relative to the last configured playback segment you should
use [
seek()][Self::seek()]. Read more§fn call_async<F>(&self, func: F)
fn call_async<F>(&self, func: F)
Calls
func from another thread and passes user_data to it. This is to be
used for cases when a state change has to be performed from a streaming
thread, directly via [ElementExt::set_state()][crate::prelude::ElementExt::set_state()] or indirectly e.g. via SEEK
events. Read morefn call_async_future<F, T>( &self, func: F, ) -> Pin<Box<dyn Future<Output = T> + Send>>
§fn current_running_time(&self) -> Option<ClockTime>
fn current_running_time(&self) -> Option<ClockTime>
Returns the running time of the element. The running time is the
element’s clock time minus its base time. Will return GST_CLOCK_TIME_NONE
if the element has no clock, or if its base time has not been set. Read more
§fn current_clock_time(&self) -> Option<ClockTime>
fn current_clock_time(&self) -> Option<ClockTime>
Returns the current clock time of the element, as in, the time of the
element’s clock, or GST_CLOCK_TIME_NONE if there is no clock. Read more
§fn request_pad_simple(&self, name: &str) -> Option<Pad>
fn request_pad_simple(&self, name: &str) -> Option<Pad>
The name of this function is confusing to people learning GStreamer.
[
request_pad_simple()][Self::request_pad_simple()] aims at making it more explicit it is
a simplified [ElementExt::request_pad()][crate::prelude::ElementExt::request_pad()]. Read more§fn link(&self, dest: &impl IsA<Element>) -> Result<(), BoolError>
fn link(&self, dest: &impl IsA<Element>) -> Result<(), BoolError>
Links
self to dest. The link must be from source to
destination; the other direction will not be tried. The function looks for
existing pads that aren’t linked yet. It will request new pads if necessary.
Such pads need to be released manually when unlinking.
If multiple links are possible, only one is established. Read more§fn link_filtered(
&self,
dest: &impl IsA<Element>,
filter: &Caps,
) -> Result<(), BoolError>
fn link_filtered( &self, dest: &impl IsA<Element>, filter: &Caps, ) -> Result<(), BoolError>
Links
self to dest using the given caps as filtercaps.
The link must be from source to
destination; the other direction will not be tried. The function looks for
existing pads that aren’t linked yet. It will request new pads if necessary.
If multiple links are possible, only one is established. Read more§fn link_pads(
&self,
srcpadname: Option<&str>,
dest: &impl IsA<Element>,
destpadname: Option<&str>,
) -> Result<(), BoolError>
fn link_pads( &self, srcpadname: Option<&str>, dest: &impl IsA<Element>, destpadname: Option<&str>, ) -> Result<(), BoolError>
Links the two named pads of the source and destination elements.
Side effect is that if one of the pads has no parent, it becomes a
child of the parent of the other element. If they have different
parents, the link fails. Read more
§fn link_pads_filtered(
&self,
srcpadname: Option<&str>,
dest: &impl IsA<Element>,
destpadname: Option<&str>,
filter: &Caps,
) -> Result<(), BoolError>
fn link_pads_filtered( &self, srcpadname: Option<&str>, dest: &impl IsA<Element>, destpadname: Option<&str>, filter: &Caps, ) -> Result<(), BoolError>
Links the two named pads of the source and destination elements. Side effect
is that if one of the pads has no parent, it becomes a child of the parent of
the other element. If they have different parents, the link fails. If
caps
is not None, makes sure that the caps of the link is a subset of caps. Read more§fn link_pads_full(
&self,
srcpadname: Option<&str>,
dest: &impl IsA<Element>,
destpadname: Option<&str>,
flags: PadLinkCheck,
) -> Result<(), BoolError>
fn link_pads_full( &self, srcpadname: Option<&str>, dest: &impl IsA<Element>, destpadname: Option<&str>, flags: PadLinkCheck, ) -> Result<(), BoolError>
Links the two named pads of the source and destination elements.
Side effect is that if one of the pads has no parent, it becomes a
child of the parent of the other element. If they have different
parents, the link fails. Read more
Source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>
unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>
unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>
Source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>
unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>
unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>
Source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>
unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>
unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>
Source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>
unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>
unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>
Source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>
unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>
unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>
Source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>
unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>
unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>
§impl<O> GObjectExtManualGst for O
impl<O> GObjectExtManualGst for O
fn set_property_from_str(&self, name: &str, value: &str)
§impl<O> GstObjectExt for Owhere
O: IsA<Object>,
impl<O> GstObjectExt for Owhere
O: IsA<Object>,
§fn add_control_binding(
&self,
binding: &impl IsA<ControlBinding>,
) -> Result<(), BoolError>
fn add_control_binding( &self, binding: &impl IsA<ControlBinding>, ) -> Result<(), BoolError>
Attach the [
ControlBinding][crate::ControlBinding] to the object. If there already was a
[ControlBinding][crate::ControlBinding] for this property it will be replaced. Read more§fn default_error(&self, error: &Error, debug: Option<&str>)
fn default_error(&self, error: &Error, debug: Option<&str>)
A default error function that uses
g_printerr() to display the error message
and the optional debug string.. Read more§fn control_binding(&self, property_name: &str) -> Option<ControlBinding>
fn control_binding(&self, property_name: &str) -> Option<ControlBinding>
Gets the corresponding [
ControlBinding][crate::ControlBinding] for the property. This should be
unreferenced again after use. Read more§fn control_rate(&self) -> Option<ClockTime>
fn control_rate(&self) -> Option<ClockTime>
Obtain the control-rate for this
self. Audio processing [Element][crate::Element]
objects will use this rate to sub-divide their processing loop and call
[sync_values()][Self::sync_values()] in between. The length of the processing segment
should be up to control-rate nanoseconds. Read more§fn parent(&self) -> Option<Object>
fn parent(&self) -> Option<Object>
Returns the parent of
self. This function increases the refcount
of the parent object so you should gst_object_unref() it after usage. Read more§fn path_string(&self) -> GString
fn path_string(&self) -> GString
Generates a string describing the path of
self in
the object hierarchy. Only useful (or used) for debugging. Read more§fn value(
&self,
property_name: &str,
timestamp: impl Into<Option<ClockTime>>,
) -> Option<Value>
fn value( &self, property_name: &str, timestamp: impl Into<Option<ClockTime>>, ) -> Option<Value>
Gets the value for the given controlled property at the requested time. Read more
§fn has_active_control_bindings(&self) -> bool
fn has_active_control_bindings(&self) -> bool
Check if the
self has active controlled properties. Read more§fn has_ancestor(&self, ancestor: &impl IsA<Object>) -> bool
fn has_ancestor(&self, ancestor: &impl IsA<Object>) -> bool
Check if
self has an ancestor ancestor somewhere up in
the hierarchy. One can e.g. check if a [Element][crate::Element] is inside a [Pipeline][crate::Pipeline]. Read more§fn has_as_ancestor(&self, ancestor: &impl IsA<Object>) -> bool
fn has_as_ancestor(&self, ancestor: &impl IsA<Object>) -> bool
Check if
self has an ancestor ancestor somewhere up in
the hierarchy. One can e.g. check if a [Element][crate::Element] is inside a [Pipeline][crate::Pipeline]. Read more§fn has_as_parent(&self, parent: &impl IsA<Object>) -> bool
fn has_as_parent(&self, parent: &impl IsA<Object>) -> bool
Check if
parent is the parent of self.
E.g. a [Element][crate::Element] can check if it owns a given [Pad][crate::Pad]. Read more§fn remove_control_binding(&self, binding: &impl IsA<ControlBinding>) -> bool
fn remove_control_binding(&self, binding: &impl IsA<ControlBinding>) -> bool
Removes the corresponding [
ControlBinding][crate::ControlBinding]. If it was the
last ref of the binding, it will be disposed. Read more§fn set_control_binding_disabled(&self, property_name: &str, disabled: bool)
fn set_control_binding_disabled(&self, property_name: &str, disabled: bool)
This function is used to disable the control bindings on a property for
some time, i.e. [
sync_values()][Self::sync_values()] will do nothing for the
property. Read more§fn set_control_bindings_disabled(&self, disabled: bool)
fn set_control_bindings_disabled(&self, disabled: bool)
This function is used to disable all controlled properties of the
self for
some time, i.e. [sync_values()][Self::sync_values()] will do nothing. Read more§fn set_control_rate(&self, control_rate: impl Into<Option<ClockTime>>)
fn set_control_rate(&self, control_rate: impl Into<Option<ClockTime>>)
Change the control-rate for this
self. Audio processing [Element][crate::Element]
objects will use this rate to sub-divide their processing loop and call
[sync_values()][Self::sync_values()] in between. The length of the processing segment
should be up to control-rate nanoseconds. Read more§fn set_parent(&self, parent: &impl IsA<Object>) -> Result<(), BoolError>
fn set_parent(&self, parent: &impl IsA<Object>) -> Result<(), BoolError>
Sets the parent of
self to parent. The object’s reference count will
be incremented, and any floating reference will be removed (see gst_object_ref_sink()). Read more§fn suggest_next_sync(&self) -> Option<ClockTime>
fn suggest_next_sync(&self) -> Option<ClockTime>
Returns a suggestion for timestamps where buffers should be split
to get best controller results. Read more
§fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>
fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>
Sets the properties of the object, according to the
GstControlSources that
(maybe) handle them and for the given timestamp. Read more§fn unparent(&self)
fn unparent(&self)
Clear the parent of
self, removing the associated reference.
This function decreases the refcount of self. Read morefn connect_parent_notify<F>(&self, f: F) -> SignalHandlerId
§impl<O> GstObjectExtManual for Owhere
O: IsA<Object>,
impl<O> GstObjectExtManual for Owhere
O: IsA<Object>,
fn connect_deep_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
fn set_object_flags(&self, flags: ObjectFlags)
fn unset_object_flags(&self, flags: ObjectFlags)
fn object_flags(&self) -> ObjectFlags
fn g_value_array( &self, property_name: &str, timestamp: ClockTime, interval: ClockTime, values: &mut [Value], ) -> Result<(), BoolError>
fn object_lock(&self) -> ObjectLockGuard<'_, Self>
Source§impl<T> IntoClosureReturnValue for T
impl<T> IntoClosureReturnValue for T
fn into_closure_return_value(self) -> Option<Value>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<U> IsSubclassableExt for Uwhere
U: IsClass + ParentClassIs,
impl<U> IsSubclassableExt for Uwhere
U: IsClass + ParentClassIs,
fn parent_class_init<T>(class: &mut Class<U>)
fn parent_instance_init<T>(instance: &mut InitializingObject<T>)
Source§impl<T> ObjectExt for Twhere
T: ObjectType,
impl<T> ObjectExt for Twhere
T: ObjectType,
Source§fn is<U>(&self) -> boolwhere
U: StaticType,
fn is<U>(&self) -> boolwhere
U: StaticType,
Returns
true if the object is an instance of (can be cast to) T.Source§fn object_class(&self) -> &Class<Object>
fn object_class(&self) -> &Class<Object>
Returns the
ObjectClass of the object. Read moreSource§fn class_of<U>(&self) -> Option<&Class<U>>where
U: IsClass,
fn class_of<U>(&self) -> Option<&Class<U>>where
U: IsClass,
Returns the class of the object in the given type
T. Read moreSource§fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
U: IsInterface,
fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
U: IsInterface,
Returns the interface
T of the object. Read moreSource§fn set_property_from_value(&self, property_name: &str, value: &Value)
fn set_property_from_value(&self, property_name: &str, value: &Value)
Source§fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])
fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])
Sets multiple properties of the object at once. Read more
Source§fn set_properties_from_value(&self, property_values: &[(&str, Value)])
fn set_properties_from_value(&self, property_values: &[(&str, Value)])
Sets multiple properties of the object at once. Read more
Source§fn property<V>(&self, property_name: &str) -> Vwhere
V: for<'b> FromValue<'b> + 'static,
fn property<V>(&self, property_name: &str) -> Vwhere
V: for<'b> FromValue<'b> + 'static,
Gets the property
property_name of the object and cast it to the type V. Read moreSource§fn property_value(&self, property_name: &str) -> Value
fn property_value(&self, property_name: &str) -> Value
Gets the property
property_name of the object. Read moreSource§fn has_property(&self, property_name: &str) -> bool
fn has_property(&self, property_name: &str) -> bool
Check if the object has a property
property_name.Source§fn has_property_with_type(&self, property_name: &str, type_: Type) -> bool
fn has_property_with_type(&self, property_name: &str, type_: Type) -> bool
Check if the object has a property
property_name of the given type_.Source§fn property_type(&self, property_name: &str) -> Option<Type>
fn property_type(&self, property_name: &str) -> Option<Type>
Get the type of the property
property_name of this object. Read moreSource§fn find_property(&self, property_name: &str) -> Option<ParamSpec>
fn find_property(&self, property_name: &str) -> Option<ParamSpec>
Get the
ParamSpec of the property property_name of this object.Source§fn list_properties(&self) -> PtrSlice<ParamSpec>
fn list_properties(&self) -> PtrSlice<ParamSpec>
Return all
ParamSpec of the properties of this object.Source§fn freeze_notify(&self) -> PropertyNotificationFreezeGuard
fn freeze_notify(&self) -> PropertyNotificationFreezeGuard
Freeze all property notifications until the return guard object is dropped. Read more
Source§unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
QD: 'static,
unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
QD: 'static,
Set arbitrary data on this object with the given
key. Read moreSource§unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
QD: 'static,
unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
QD: 'static,
Return previously set arbitrary data of this object with the given
key. Read moreSource§unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
QD: 'static,
unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
QD: 'static,
Retrieve previously set arbitrary data of this object with the given
key. Read moreSource§unsafe fn set_data<QD>(&self, key: &str, value: QD)where
QD: 'static,
unsafe fn set_data<QD>(&self, key: &str, value: QD)where
QD: 'static,
Set arbitrary data on this object with the given
key. Read moreSource§unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where
QD: 'static,
unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where
QD: 'static,
Return previously set arbitrary data of this object with the given
key. Read moreSource§unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where
QD: 'static,
unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where
QD: 'static,
Retrieve previously set arbitrary data of this object with the given
key. Read moreSource§fn block_signal(&self, handler_id: &SignalHandlerId)
fn block_signal(&self, handler_id: &SignalHandlerId)
Block a given signal handler. Read more
Source§fn unblock_signal(&self, handler_id: &SignalHandlerId)
fn unblock_signal(&self, handler_id: &SignalHandlerId)
Unblock a given signal handler.
Source§fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)
fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)
Stop emission of the currently emitted signal.
Source§fn stop_signal_emission_by_name(&self, signal_name: &str)
fn stop_signal_emission_by_name(&self, signal_name: &str)
Stop emission of the currently emitted signal by the (possibly detailed) signal name.
Source§fn connect<F>(
&self,
signal_name: &str,
after: bool,
callback: F,
) -> SignalHandlerId
fn connect<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
Connect to the signal
signal_name on this object. Read moreSource§fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F,
) -> SignalHandlerId
fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
Connect to the signal
signal_id on this object. Read moreSource§fn connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F,
) -> SignalHandlerId
fn connect_local<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
Connect to the signal
signal_name on this object. Read moreSource§fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F,
) -> SignalHandlerId
fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
Connect to the signal
signal_id on this object. Read moreSource§unsafe fn connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F,
) -> SignalHandlerId
unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
Connect to the signal
signal_name on this object. Read moreSource§unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F,
) -> SignalHandlerId
unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
Connect to the signal
signal_id on this object. Read moreSource§fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure,
) -> SignalHandlerId
fn connect_closure( &self, signal_name: &str, after: bool, closure: RustClosure, ) -> SignalHandlerId
Connect a closure to the signal
signal_name on this object. Read moreSource§fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure,
) -> SignalHandlerId
fn connect_closure_id( &self, signal_id: SignalId, details: Option<Quark>, after: bool, closure: RustClosure, ) -> SignalHandlerId
Connect a closure to the signal
signal_id on this object. Read moreSource§fn watch_closure(&self, closure: &impl AsRef<Closure>)
fn watch_closure(&self, closure: &impl AsRef<Closure>)
Limits the lifetime of
closure to the lifetime of the object. When
the object’s reference count drops to zero, the closure will be
invalidated. An invalidated closure will ignore any calls to
invoke_with_values, or
invoke when using Rust closures.Source§fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
Emit signal by signal id. Read more
Source§fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>
fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>
Same as
Self::emit but takes Value for the arguments.Source§fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
Emit signal by its name. Read more
Source§fn emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value],
) -> Option<Value>
fn emit_by_name_with_values( &self, signal_name: &str, args: &[Value], ) -> Option<Value>
Emit signal by its name. Read more
Source§fn emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue],
) -> Rwhere
R: TryFromClosureReturnValue,
fn emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue],
) -> Rwhere
R: TryFromClosureReturnValue,
Emit signal by its name with details. Read more
Source§fn emit_by_name_with_details_and_values(
&self,
signal_name: &str,
details: Quark,
args: &[Value],
) -> Option<Value>
fn emit_by_name_with_details_and_values( &self, signal_name: &str, details: Quark, args: &[Value], ) -> Option<Value>
Emit signal by its name with details. Read more
Source§fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue],
) -> Rwhere
R: TryFromClosureReturnValue,
fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue],
) -> Rwhere
R: TryFromClosureReturnValue,
Emit signal by signal id with details. Read more
Source§fn emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value],
) -> Option<Value>
fn emit_with_details_and_values( &self, signal_id: SignalId, details: Quark, args: &[Value], ) -> Option<Value>
Emit signal by signal id with details. Read more
Source§fn disconnect(&self, handler_id: SignalHandlerId)
fn disconnect(&self, handler_id: SignalHandlerId)
Disconnect a previously connected signal handler.
Source§fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
Connect to the
notify signal of the object. Read moreSource§fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
Connect to the
notify signal of the object. Read moreSource§unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F,
) -> SignalHandlerId
unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F, ) -> SignalHandlerId
Connect to the
notify signal of the object. Read moreSource§fn notify(&self, property_name: &str)
fn notify(&self, property_name: &str)
Notify that the given property has changed its value. Read more
Source§fn notify_by_pspec(&self, pspec: &ParamSpec)
fn notify_by_pspec(&self, pspec: &ParamSpec)
Notify that the given property has changed its value. Read more
Source§fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
Add a callback to be notified when the Object is disposed.
Source§fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>where
F: FnOnce() + 'static,
fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>where
F: FnOnce() + 'static,
Add a callback to be notified when the Object is disposed. Read more
Source§fn bind_property<'a, 'f, 't, O>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str,
) -> BindingBuilder<'a, 'f, 't>where
O: ObjectType,
fn bind_property<'a, 'f, 't, O>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str,
) -> BindingBuilder<'a, 'f, 't>where
O: ObjectType,
Source§unsafe fn run_dispose(&self)
unsafe fn run_dispose(&self)
Runs the dispose mechanism of the object. Read more
Source§impl<T> PropertyGet for Twhere
T: HasParamSpec,
impl<T> PropertyGet for Twhere
T: HasParamSpec,
Source§impl<T> StaticTypeExt for Twhere
T: StaticType,
impl<T> StaticTypeExt for Twhere
T: StaticType,
Source§fn ensure_type()
fn ensure_type()
Ensures that the type has been registered with the type system.
Source§impl<T> ToSendValue for T
impl<T> ToSendValue for T
Source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
Returns a
SendValue clone of self.Source§impl<T> TransparentType for Twhere
T: TransparentPtrType,
impl<T> TransparentType for Twhere
T: TransparentPtrType,
type GlibType = <T as GlibPtrDefault>::GlibType
Source§impl<T> TryFromClosureReturnValue for Twhere
T: for<'a> FromValue<'a> + StaticType + 'static,
impl<T> TryFromClosureReturnValue for Twhere
T: for<'a> FromValue<'a> + StaticType + 'static,
Source§impl<O> VideoEncoderExt for Owhere
O: IsA<VideoEncoder>,
impl<O> VideoEncoderExt for Owhere
O: IsA<VideoEncoder>,
Source§fn allocate_output_buffer(&self, size: usize) -> Buffer
fn allocate_output_buffer(&self, size: usize) -> Buffer
Helper function that allocates a buffer to hold an encoded video frame
for
self’s current VideoCodecState. Read moreSource§fn drop_frame(&self, frame: VideoCodecFrame<'_>)
fn drop_frame(&self, frame: VideoCodecFrame<'_>)
Removes
frame from the list of pending frames, releases it
and posts a QoS message with the frame’s details on the bus.
Similar to calling finish_frame() without a buffer
attached to frame, but this function additionally stores events
from frame as pending, to be pushed out alongside the next frame
submitted via finish_frame(). Read moreSource§fn finish_frame(
&self,
frame: VideoCodecFrame<'_>,
) -> Result<FlowSuccess, FlowError>
fn finish_frame( &self, frame: VideoCodecFrame<'_>, ) -> Result<FlowSuccess, FlowError>
frame must have a valid encoded data buffer, whose metadata fields
are then appropriately set according to frame data or no buffer at
all if the frame should be dropped.
It is subsequently pushed downstream or provided to pre_push.
In any case, the frame is considered finished and released. Read moreSource§fn max_encode_time(&self, frame: &VideoCodecFrame<'_>) -> ClockTimeDiff
fn max_encode_time(&self, frame: &VideoCodecFrame<'_>) -> ClockTimeDiff
Determines maximum possible encoding time for
frame that will
allow it to encode and arrive in time (as determined by QoS events).
In particular, a negative result means encoding in time is no longer possible
and should therefore occur as soon/skippy as possible. Read moreSource§fn min_force_key_unit_interval(&self) -> Option<ClockTime>
fn min_force_key_unit_interval(&self) -> Option<ClockTime>
Returns the minimum force-keyunit interval, see
set_min_force_key_unit_interval()
for more details. Read moreSource§fn is_qos_enabled(&self) -> bool
fn is_qos_enabled(&self) -> bool
Checks if
self is currently configured to handle Quality-of-Service
events from downstream. Read moreSource§fn merge_tags(&self, tags: Option<&TagList>, mode: TagMergeMode)
fn merge_tags(&self, tags: Option<&TagList>, mode: TagMergeMode)
Sets the video encoder tags and how they should be merged with any
upstream stream tags. This will override any tags previously-set
with
merge_tags(). Read moreSource§fn proxy_getcaps(&self, caps: Option<&Caps>, filter: Option<&Caps>) -> Caps
fn proxy_getcaps(&self, caps: Option<&Caps>, filter: Option<&Caps>) -> Caps
Returns caps that express
caps (or sink template caps if caps == NULL)
restricted to resolution/format/… combinations supported by downstream
elements (e.g. muxers). Read moreSource§fn release_frame(&self, frame: VideoCodecFrame<'_>)
fn release_frame(&self, frame: VideoCodecFrame<'_>)
Removes
frame from list of pending frames and releases it, similar
to calling finish_frame() without a buffer attached
to the frame, but does not post a QoS message or do any additional
processing. Events from frame are moved to the pending events list. Read moreSource§fn set_min_force_key_unit_interval(
&self,
interval: impl Into<Option<ClockTime>>,
)
fn set_min_force_key_unit_interval( &self, interval: impl Into<Option<ClockTime>>, )
Sets the minimum interval for requesting keyframes based on force-keyunit
events. Setting this to 0 will allow to handle every event, setting this to
GST_CLOCK_TIME_NONE causes force-keyunit events to be ignored. Read moreSource§fn set_min_pts(&self, min_pts: impl Into<Option<ClockTime>>)
fn set_min_pts(&self, min_pts: impl Into<Option<ClockTime>>)
Request minimal value for PTS passed to handle_frame. Read more
Source§fn set_qos_enabled(&self, enabled: bool)
fn set_qos_enabled(&self, enabled: bool)
Configures
self to handle Quality-of-Service events from downstream. Read morefn is_qos(&self) -> bool
fn set_qos(&self, qos: bool)
fn connect_min_force_key_unit_interval_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
fn connect_qos_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId
Source§impl<O> VideoEncoderExtManual for Owhere
O: IsA<VideoEncoder>,
impl<O> VideoEncoderExtManual for Owhere
O: IsA<VideoEncoder>,
Source§fn allocate_output_frame(
&self,
frame: &mut VideoCodecFrame<'_>,
size: usize,
) -> Result<FlowSuccess, FlowError>
fn allocate_output_frame( &self, frame: &mut VideoCodecFrame<'_>, size: usize, ) -> Result<FlowSuccess, FlowError>
Helper function that allocates a buffer to hold an encoded video frame for
self’s
current VideoCodecState. Subclass should already have configured video
state and set src pad caps. Read moreSource§fn frame(&self, frame_number: i32) -> Option<VideoCodecFrame<'_>>
fn frame(&self, frame_number: i32) -> Option<VideoCodecFrame<'_>>
Get a pending unfinished
VideoCodecFrame Read moreSource§fn frames(&self) -> Vec<VideoCodecFrame<'_>>
fn frames(&self) -> Vec<VideoCodecFrame<'_>>
Get all pending unfinished
VideoCodecFrame Read moreSource§fn oldest_frame(&self) -> Option<VideoCodecFrame<'_>>
fn oldest_frame(&self) -> Option<VideoCodecFrame<'_>>
Get the oldest unfinished pending
VideoCodecFrame Read moreSource§fn allocator(&self) -> (Option<Allocator>, AllocationParams)
fn allocator(&self) -> (Option<Allocator>, AllocationParams)
Lets
VideoEncoder sub-classes to know the memory allocator
used by the base class and its params. Read moreSource§fn finish_subframe(
&self,
frame: &VideoCodecFrame<'_>,
) -> Result<FlowSuccess, FlowError>
fn finish_subframe( &self, frame: &VideoCodecFrame<'_>, ) -> Result<FlowSuccess, FlowError>
If multiple subframes are produced for one input frame then use this method
for each subframe, except for the last one. Before calling this function,
you need to fill frame->output_buffer with the encoded buffer to push. Read more
Source§fn latency(&self) -> (ClockTime, Option<ClockTime>)
fn latency(&self) -> (ClockTime, Option<ClockTime>)
Query the configured encoding latency. Results will be returned via
min_latency and max_latency. Read moreSource§fn set_latency(
&self,
min_latency: ClockTime,
max_latency: impl Into<Option<ClockTime>>,
)
fn set_latency( &self, min_latency: ClockTime, max_latency: impl Into<Option<ClockTime>>, )
Informs baseclass of encoding latency. If the provided values changed from
previously provided ones, this will also post a LATENCY message on the bus
so the pipeline can reconfigure its global latency. Read more
Source§fn output_state(&self) -> Option<VideoCodecState<'static, Readable>>
fn output_state(&self) -> Option<VideoCodecState<'static, Readable>>
Get the current
VideoCodecState Read moreSource§fn set_output_state(
&self,
caps: Caps,
reference: Option<&VideoCodecState<'_, Readable>>,
) -> Result<VideoCodecState<'_, InNegotiation<'_>>, FlowError>
fn set_output_state( &self, caps: Caps, reference: Option<&VideoCodecState<'_, Readable>>, ) -> Result<VideoCodecState<'_, InNegotiation<'_>>, FlowError>
Creates a new
VideoCodecState with the specified caps as the output state
for the encoder.
Any previously set output state on self will be replaced by the newly
created one. Read moreSource§fn negotiate<'a>(
&'a self,
output_state: VideoCodecState<'a, InNegotiation<'a>>,
) -> Result<(), FlowError>
fn negotiate<'a>( &'a self, output_state: VideoCodecState<'a, InNegotiation<'a>>, ) -> Result<(), FlowError>
Negotiate with downstream elements to currently configured
VideoCodecState.
Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
negotiate fails. Read moreSource§fn set_headers(&self, headers: impl IntoIterator<Item = Buffer>)
fn set_headers(&self, headers: impl IntoIterator<Item = Buffer>)
Set the codec headers to be sent downstream whenever requested. Read more