Struct gstreamer::Pipeline

[+] Show declaration

pub struct Pipeline(_, _);

[−] Expand description

A Pipeline is a special Bin used as the toplevel container for the filter graph. The Pipeline will manage the selection and distribution of a global Clock as well as provide a Bus to the application.

Pipeline::new is used to create a pipeline. when you are done with the pipeline, use GstObjectExt::unref to free its resources including all added Element objects (if not otherwise referenced).

Elements are added and removed from the pipeline using the Bin methods like GstBinExt::add and GstBinExt::remove (see Bin).

Before changing the state of the Pipeline (see Element) a Bus can be retrieved with Pipeline::get_bus. This bus can then be used to receive Message from the elements in the pipeline.

By default, a Pipeline will automatically flush the pending Bus messages when going to the NULL state to ensure that no circular references exist when no messages are read from the Bus. This behaviour can be changed with PipelineExt::set_auto_flush_bus.

When the Pipeline performs the PAUSED to PLAYING state change it will select a clock for the elements. The clock selection algorithm will by default select a clock provided by an element that is most upstream (closest to the source). For live pipelines (ones that return StateChangeReturn::NoPreroll from the Element::set_state call) this will select the clock provided by the live source. For normal pipelines this will select a clock provided by the sinks (most likely the audio sink). If no element provides a clock, a default SystemClock is used.

The clock selection can be controlled with the PipelineExt::use_clock method, which will enforce a given clock on the pipeline. With PipelineExt::auto_clock the default clock selection algorithm can be restored.

A Pipeline maintains a running time for the elements. The running time is defined as the difference between the current clock time and the base time. When the pipeline goes to READY or a flushing seek is performed on it, the running time is reset to 0. When the pipeline is set from PLAYING to PAUSED, the current clock time is sampled and used to configure the base time for the elements when the pipeline is set to PLAYING again. The effect is that the running time (as the difference between the clock time and the base time) will count how much time was spent in the PLAYING state. This default behaviour can be changed with the ElementExt::set_start_time method.

Implements

PipelineExt, GstBinExt, ElementExt, GstObjectExt, glib::object::ObjectExt, ChildProxyExt, ElementExtManual, ChildProxyExtManual

Implementations

impl Pipeline[−]

pub fn new(name: Option<&str>) -> Pipeline[−]

Create a new pipeline with the given name.

name

name of new pipeline

Returns

newly created GstPipeline

MT safe.

Trait Implementations

impl Clone for Pipeline[+]

[+] Show hidden undocumented items

fn clone(&self) -> Pipeline[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for Pipeline[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for Pipeline

impl Hash for Pipeline[+]

[+] Show hidden undocumented items

fn hash<__H: Hasher>(&self, state: &mut __H)[−]

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl IsA<Bin> for Pipeline

impl IsA<ChildProxy> for Pipeline

impl IsA<Element> for Pipeline

impl IsA<Object> for Pipeline

impl Ord for Pipeline[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &Pipeline) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

#[must_use]fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use]fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use]fn clamp(self, min: Self, max: Self) -> Self[−]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for Pipeline[+]

[+] Show hidden undocumented items

fn eq(&self, other: &T) -> bool[−]

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

[+] Expand attributes

#[must_use]fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for Pipeline[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &T) -> Option<Ordering>[−]

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

[+] Expand attributes

#[must_use]fn lt(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[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.

[+] Expand attributes

#[must_use]fn gt(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[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.

impl Send for Pipeline

impl StaticType for Pipeline[+]

[+] Show hidden undocumented items

fn static_type() -> Type[−]

Returns the type identifier of Self.

impl Sync for Pipeline