Struct gstreamer::Pad [−]
pub struct Pad(_, _);
A Element
is linked to other elements via "pads", which are extremely
light-weight generic link points.
Pads have a PadDirection
, source pads produce data, sink pads consume
data.
Pads are typically created from a PadTemplate
with
Pad::new_from_template
and are then added to a 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 Pad::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 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 Element
that owns the pad.
After two pads are retrieved from an element by ElementExt::get_static_pad
,
the pads can be linked with PadExt::link
. (For quick links,
you can also use ElementExt::link
, which will make the obvious
link for you if it's straightforward.). Pads can be unlinked again with
PadExt::unlink
. 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
PadExt::set_active
.
Pad::query
and Pad::peer_query
can be used to query various
properties of the pad and the stream.
To send a Event
on a pad, use Pad::send_event
and
Pad::push_event
. Some events will be sticky on the pad, meaning that
after they pass on the pad they can be queried later with
PadExt::get_sticky_event
and PadExt::sticky_events_foreach
.
PadExt::get_current_caps
and PadExt::has_current_caps
are convenience
functions to query the current sticky CAPS event on a pad.
GstElements will use Pad::push
and Pad::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 PadExt::add_probe
. PadExt::is_blocked
can be used to check if a block probe is installed on the pad.
PadExt::is_blocking
checks if the blocking probe is currently blocking the
pad. Pad::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 PadExt::get_offset
. This
offset will be applied to the running_time of all data passing over the pad.
PadExt::set_offset
can be used to change the offset.
Convenience functions exist to start, pause and stop the task on a pad with
PadExt::start_task
, PadExt::pause_task
and PadExt::stop_task
respectively.
Implements
Methods
impl Pad
[src]
impl Pad
pub fn new<'a, P: Into<Option<&'a str>>>(
name: P,
direction: PadDirection
) -> Pad
[src]
pub fn new<'a, P: Into<Option<&'a str>>>(
name: P,
direction: PadDirection
) -> Pad
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 PadDirection
of the pad.
Returns
a new Pad
, or None
in
case of an error.
MT safe.
pub fn new_from_template<'a, P: Into<Option<&'a str>>>(
templ: &PadTemplate,
name: P
) -> Pad
[src]
pub fn new_from_template<'a, P: Into<Option<&'a str>>>(
templ: &PadTemplate,
name: P
) -> Pad
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 Pad
, or None
in
case of an error.
impl Pad
[src]
impl Pad
pub fn new_from_static_template<'a, P: Into<Option<&'a str>>>(
templ: &StaticPadTemplate,
name: P
) -> Pad
[src]
pub fn new_from_static_template<'a, P: Into<Option<&'a str>>>(
templ: &StaticPadTemplate,
name: P
) -> Pad
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 StaticPadTemplate
to use
name
the name of the pad
Returns
a new Pad
, or None
in
case of an error.
Trait Implementations
impl IsA<Pad> for GhostPad
impl IsA<Pad> for GhostPad
impl Clone for Pad
impl Clone for Pad
fn clone(&self) -> Pad
fn clone(&self) -> Pad
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)
Performs copy-assignment from source
. Read more
impl Hash for Pad
impl Hash for Pad
fn hash<__H: Hasher>(&self, state: &mut __H)
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Ord for Pad
impl Ord for Pad
fn cmp(&self, other: &Pad) -> Ordering
fn cmp(&self, other: &Pad) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
impl StaticType for Pad
impl StaticType for Pad
fn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of Self
.
impl<T: IsA<Object>> PartialEq<T> for Pad
impl<T: IsA<Object>> PartialEq<T> for Pad
fn eq(&self, other: &T) -> bool
fn eq(&self, other: &T) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl Eq for Pad
impl Eq for Pad
impl<T: IsA<Object>> PartialOrd<T> for Pad
impl<T: IsA<Object>> PartialOrd<T> for Pad
fn partial_cmp(&self, other: &T) -> Option<Ordering>
fn partial_cmp(&self, other: &T) -> Option<Ordering>
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
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
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Debug for Pad
impl Debug for Pad
impl IsA<Object> for Pad
impl IsA<Object> for Pad
impl IsA<Object> for Pad
impl IsA<Object> for Pad
impl Send for Pad
[src]
impl Send for Pad
impl Sync for Pad
[src]
impl Sync for Pad
impl IsA<Pad> for ProxyPad
impl IsA<Pad> for ProxyPad