Struct gstreamer::GhostPad

pub struct GhostPad { /* private fields */ }

GhostPads are useful when organizing pipelines with Bin like elements. The idea here is to create hierarchical element graphs. The bin element contains a sub-graph. Now one would like to treat the bin-element like any other Element. This is where GhostPads come into play. A GhostPad acts as a proxy for another pad. Thus the bin can have sink and source ghost-pads that are associated with sink and source pads of the child elements.

If the target pad is known at creation time, with_target() is the function to use to get a ghost-pad. Otherwise one can use new() to create the ghost-pad and use GhostPadExt::set_target() to establish the association later on.

Note that GhostPads add overhead to the data processing of a pipeline.

Implements

GhostPadExt, ProxyPadExt, PadExt, GstObjectExt, [trait@glib::ObjectExt], [ProxyPadExtManual][trait@crate::prelude::ProxyPadExtManual], PadExtManual

Implementations

impl GhostPad

pub const NONE: Option<&'static GhostPad> = None

impl GhostPad

pub fn activate_mode_default<P: IsA<GhostPad>>( pad: &P, parent: Option<&impl IsA<Object>>, mode: PadMode, active: bool ) -> Result<(), BoolError>

Invoke the default activate mode function of a ghost pad.

pad

the Pad to activate or deactivate.

parent

the parent of pad or None

mode

the requested activation mode

active

whether the pad should be active or not.

Returns

true if the operation was successful.

pub fn internal_activate_mode_default<P: IsA<GhostPad>>( pad: &P, parent: Option<&impl IsA<Object>>, mode: PadMode, active: bool ) -> Result<(), BoolError>

Invoke the default activate mode function of a proxy pad that is owned by a ghost pad.

pad

the Pad to activate or deactivate.

parent

the parent of pad or None

mode

the requested activation mode

active

whether the pad should be active or not.

Returns

true if the operation was successful.

pub fn new(direction: PadDirection) -> Self

Creates a new GhostPad with an automatically generated name.

Use GhostPad::builder_from_template() to get a PadBuilder and define options. Create a new ghostpad without a target with the given direction. A target can be set on the ghostpad later with the GhostPadExt::set_target() function.

The created ghostpad will not have a padtemplate.

name

the name of the new pad, or None to assign a default name.

dir

the direction of the ghostpad

Returns

a new Pad, or None in case of an error.

pub fn builder(direction: PadDirection) -> PadBuilder<Self>

Creates a PadBuilder for a PadBuilder with an automatically generated name.

Use PadBuilder::name or PadBuilder::maybe_name to specify a different name.

pub fn from_static_template(templ: &StaticPadTemplate) -> Self

Creates a new GhostPad from the StaticPadTemplate.

If the StaticPadTemplate has a specific name_template, i.e. if it’s not a wildcard-name containing %u, %s or %d, the GhostPad will automatically be named after the name_template.

Panics

Panics if the name_template is a wildcard-name.

Use GhostPad::builder_from_template() to get a PadBuilder and define options.

pub fn builder_from_static_template( templ: &StaticPadTemplate ) -> PadBuilder<Self>

Creates a new PadBuilder for a GhostPad from the StaticPadTemplate.

If the StaticPadTemplate has a specific name_template, i.e. if it’s not a wildcard-name containing %u, %s or %d, the GhostPad will automatically be named after the name_template.

Use PadBuilder::name or PadBuilder::maybe_name to specify a different name.

pub fn from_template(templ: &PadTemplate) -> Self

Creates a new GhostPad from the PadTemplate.

If the PadTemplate has a specific name_template, i.e. if it’s not a wildcard-name containing %u, %s or %d, the GhostPad will automatically be named after the name_template.

Panics

Panics if the name_template is a wildcard-name.

Use GhostPad::builder_from_template() to get a PadBuilder and define options. Create a new ghostpad based on templ, without setting a target. The direction will be taken from the templ.

name

the name of the new pad, or None to assign a default name

templ

the PadTemplate to create the ghostpad from.

Returns

a new Pad, or None in case of an error.

pub fn builder_from_template(templ: &PadTemplate) -> PadBuilder<Self>

Creates a new PadBuilder for a GhostPad from the PadTemplate.

If the PadTemplate has a specific name_template, i.e. if it’s not a wildcard-name containing %u, %s or %d, the GhostPad will automatically be named after the name_template.

Use PadBuilder::name or PadBuilder::maybe_name to specify a different name.

pub fn with_target<P: IsA<Pad> + IsA<Object>>( target: &P ) -> Result<Self, BoolError>

Creates a new GhostPad from the specified target Pad.

The GhostPad will automatically be named after the target name.

Use GhostPad::builder_with_target() to get a PadBuilder and define options. Create a new ghostpad with target as the target. The direction will be taken from the target pad. target must be unlinked.

Will ref the target.

name

the name of the new pad, or None to assign a default name

target

the pad to ghost.

Returns

a new Pad, or None in case of an error.

pub fn builder_with_target<P: IsA<Pad> + IsA<Object>>( target: &P ) -> Result<PadBuilder<Self>, BoolError>

Creates a new PadBuilder for a GhostPad from the specified target Pad.

The GhostPad will automatically be named after the target name.

Use PadBuilder::name or PadBuilder::maybe_name to specify a different name.

pub fn from_template_with_target<P: IsA<Pad> + IsA<Object>>( templ: &PadTemplate, target: &P ) -> Result<Self, BoolError>

Creates a new GhostPad from the PadTemplate with the specified target Pad.

If the PadTemplate has a specific name_template, i.e. if it’s not a wildcard-name containing %u, %s or %d, the GhostPad will automatically be named after the name_template.

If the name_template is a wildcard-name, then the target name is used, if it is compatible. Otherwise, a specific name must be provided using PadBuilder::name or PadBuilder::maybe_name. Create a new ghostpad with target as the target. The direction will be taken from the target pad. The template used on the ghostpad will be template.

Will ref the target.

name

the name of the new pad, or None to assign a default name.

target

the pad to ghost.

templ

the PadTemplate to use on the ghostpad.

Returns

a new Pad, or None in case of an error.

pub fn builder_from_template_with_target<P: IsA<Pad> + IsA<Object>>( templ: &PadTemplate, target: &P ) -> Result<PadBuilder<Self>, BoolError>

Creates a new PadBuilder for a GhostPad from the PadTemplate with the specified target Pad.

If the PadTemplate has a specific name_template, i.e. if it’s not a wildcard-name containing %u, %s or %d, the GhostPad will automatically be named after the name_template.

If the name_template is a wildcard-name, then the target name is used, if it is compatible. Otherwise, a specific name must be provided using PadBuilder::name or PadBuilder::maybe_name.

Trait Implementations

impl Clone for GhostPad

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GhostPad

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

Formats the value using the given formatter.

impl HasParamSpec for GhostPad

type ParamSpec = ParamSpecObject

type SetValue = GhostPad

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, GhostPad>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GhostPad

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: GhostPadImpl> IsSubclassable<T> for GhostPad

fn class_init(class: &mut Class<Self>)

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

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

Instance specific initialization.

impl Ord for GhostPad

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for GhostPad

type Parent = ProxyPad

impl<OT: ObjectType> PartialEq<OT> for GhostPad

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for GhostPad

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for GhostPad

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GhostPad

impl IsA<Object> for GhostPad

impl IsA<Pad> for GhostPad

impl IsA<ProxyPad> for GhostPad

impl Send for GhostPad

impl Sync for GhostPad