Struct gstreamer::Pad [−][src]
pub struct Pad(_);
A crate::Element is linked to other elements via “pads”, which are extremely
light-weight generic link points.
Pads have a crate::PadDirection, source pads produce data, sink pads consume
data.
Pads are typically created from a crate::PadTemplate with
[Self::new_from_template()] and are then added to a crate::Element. This usually
happens when the element is created but it can also happen dynamically based
on the data that the element is processing or based on the pads that the
application requests.
Pads without pad templates can be created with Self::new(),
which takes a direction and a name as an argument. If the name is None,
then a guaranteed unique name will be assigned to it.
A crate::Element creating a pad will typically use the various
gst_pad_set_*_function() calls to register callbacks for events, queries or
dataflow on the pads.
gst_pad_get_parent() will retrieve the crate::Element that owns the pad.
After two pads are retrieved from an element by [crate::prelude::ElementExt::get_static_pad()],
the pads can be linked with crate::prelude::PadExt::link(). (For quick links,
you can also use crate::prelude::ElementExt::link(), which will make the obvious
link for you if it’s straightforward.). Pads can be unlinked again with
crate::prelude::PadExt::unlink(). [crate::prelude::PadExt::get_peer()] can be used to check what the pad is
linked to.
Before dataflow is possible on the pads, they need to be activated with
crate::prelude::PadExt::set_active().
[Self::query()] and [Self::peer_query()] can be used to query various
properties of the pad and the stream.
To send a crate::Event on a pad, use [Self::send_event()] and
[Self::push_event()]. Some events will be sticky on the pad, meaning that
after they pass on the pad they can be queried later with
[crate::prelude::PadExt::get_sticky_event()] and [Self::sticky_events_foreach()].
[crate::prelude::PadExt::get_current_caps()] and crate::prelude::PadExt::has_current_caps() are convenience
functions to query the current sticky CAPS event on a pad.
GstElements will use [Self::push()] and [Self::pull_range()] to push out
or pull in a buffer.
The dataflow, events and queries that happen on a pad can be monitored with
probes that can be installed with [Self::add_probe()]. crate::prelude::PadExt::is_blocked()
can be used to check if a block probe is installed on the pad.
crate::prelude::PadExt::is_blocking() checks if the blocking probe is currently blocking the
pad. [Self::remove_probe()] is used to remove a previously installed probe
and unblock blocking probes if any.
Pad have an offset that can be retrieved with [crate::prelude::PadExt::get_offset()]. This
offset will be applied to the running_time of all data passing over the pad.
crate::prelude::PadExt::set_offset() can be used to change the offset.
Convenience functions exist to start, pause and stop the task on a pad with
[Self::start_task()], crate::prelude::PadExt::pause_task() and crate::prelude::PadExt::stop_task()
respectively.
Implements
crate::prelude::PadExt, crate::prelude::GstObjectExt, glib::object::ObjectExt, crate::prelude::PadExtManual
Implementations
impl Pad[src]
impl Pad[src]pub fn new(name: Option<&str>, direction: PadDirection) -> Self[src]
pub fn new(name: Option<&str>, direction: PadDirection) -> Self[src]Creates a new pad with the given name in the given direction.
If name is None, a guaranteed unique name (across all pads)
will be assigned.
This function makes a copy of the name so you can safely free the name.
name
the name of the new pad.
direction
the crate::PadDirection of the pad.
Returns
a new crate::Pad.
MT safe.
pub fn builder(name: Option<&str>, direction: PadDirection) -> PadBuilder<Self>[src]
pub fn from_static_template(
templ: &StaticPadTemplate,
name: Option<&str>
) -> Self[src]
pub fn from_static_template(
templ: &StaticPadTemplate,
name: Option<&str>
) -> Self[src]Creates a new pad with the given name from the given static template.
If name is None, a guaranteed unique name (across all pads)
will be assigned.
This function makes a copy of the name so you can safely free the name.
templ
the crate::StaticPadTemplate to use
name
the name of the pad
Returns
a new crate::Pad.
pub fn builder_with_static_template(
templ: &StaticPadTemplate,
name: Option<&str>
) -> PadBuilder<Self>[src]
templ: &StaticPadTemplate,
name: Option<&str>
) -> PadBuilder<Self>
pub fn from_template(templ: &PadTemplate, name: Option<&str>) -> Self[src]
pub fn from_template(templ: &PadTemplate, name: Option<&str>) -> Self[src]Creates a new pad with the given name from the given template.
If name is None, a guaranteed unique name (across all pads)
will be assigned.
This function makes a copy of the name so you can safely free the name.
templ
the pad template to use
name
the name of the pad
Returns
a new crate::Pad.
pub fn builder_with_template(
templ: &PadTemplate,
name: Option<&str>
) -> PadBuilder<Self>[src]
templ: &PadTemplate,
name: Option<&str>
) -> PadBuilder<Self>
Trait Implementations
impl<T: PadImpl> IsSubclassable<T> for Pad[src]
impl<T: PadImpl> IsSubclassable<T> for Pad[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 Pad[src]
impl Ord for Pad[src]impl ParentClassIs for Pad[src]
impl ParentClassIs for Pad[src]impl<T: ObjectType> PartialEq<T> for Pad[src]
impl<T: ObjectType> PartialEq<T> for Pad[src]impl<T: ObjectType> PartialOrd<T> for Pad[src]
impl<T: ObjectType> PartialOrd<T> for Pad[src]fn partial_cmp(&self, other: &T) -> Option<Ordering>[src]
fn partial_cmp(&self, other: &T) -> Option<Ordering>[src]This method returns an ordering between self and other values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]This method tests less than (for self and other) and is used by the < operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more
impl StaticType for Pad[src]
impl StaticType for Pad[src]fn static_type() -> Type[src]
fn static_type() -> Type[src]Returns the type identifier of Self.
impl Eq for Pad[src]
impl IsA<Object> for Pad[src]
impl IsA<Pad> for GhostPad[src]
impl IsA<Pad> for ProxyPad[src]
impl Send for Pad[src]
impl StructuralEq for Pad[src]
impl Sync for Pad[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<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 = TThe resulting type after obtaining ownership.
pub fn to_owned(&self) -> T[src]
pub fn to_owned(&self) -> T[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)[src]
pub fn clone_into(&self, target: &mut T)[src]🔬 This is a nightly-only experimental API. (toowned_clone_into)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized, [src]
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized, [src]pub fn to_send_value(&self) -> SendValue[src]
pub fn to_send_value(&self) -> SendValue[src]Returns a SendValue clone of self.
impl<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>,