Struct gstreamer::Pipeline

pub struct Pipeline { /* private fields */ }

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.

new() is used to create a pipeline. when you are done with the pipeline, use gst_object_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 should be retrieved with gst_pipeline_get_bus(). This Bus should then be used to receive Message from the elements in the pipeline. Listening to the Bus is necessary for retrieving error messages from the Pipeline and otherwise the Pipeline might stop without any indication, why. Furthermore, the Pipeline posts messages even if nobody listens on the Bus, which will pile up and use up memory.

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 ElementExt::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.

Properties

auto-flush-bus

Whether or not to automatically flush all messages on the pipeline’s bus when going from READY to NULL state. Please see PipelineExt::set_auto_flush_bus() for more information on this option.

Readable | Writeable

delay

The expected delay needed for elements to spin up to the PLAYING state expressed in nanoseconds. see PipelineExt::set_delay() for more information on this option.

Readable | Writeable

latency

Latency to configure on the pipeline. See PipelineExt::set_latency().

Readable | Writeable

Bin

async-handling

If set to true, the bin will handle asynchronous state changes. This should be used only if the bin subclass is modifying the state of its children on its own.

Readable | Writeable

message-forward

Forward all children messages, even those that would normally be filtered by the bin. This can be interesting when one wants to be notified of the EOS state of individual elements, for example.

The messages are converted to an ELEMENT message with the bin as the source. The structure of the message is named GstBinForwarded and contains a field named message that contains the original forwarded Message.

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 signals due to locking issues. In some cases one can use element-added or element-removed signals on the parent to achieve a similar effect.

Readable | Writeable

Implements

PipelineExt, GstBinExt, ElementExt, GstObjectExt, [trait@glib::ObjectExt], ChildProxyExt, ElementExtManual, ChildProxyExtManual

Implementations

impl Pipeline

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

impl Pipeline

pub fn new() -> Pipeline

Creates a new Pipeline object with a default name.

Use Pipeline::with_name() to create a Pipeline with a specific name. Use Pipeline::builder() to get a PipelineBuilder and then define a specific name. Create a new pipeline with the given name.

name

name of new pipeline

Returns

newly created GstPipeline

MT safe.

pub fn with_name(name: &str) -> Pipeline

Creates a new Pipeline object with the specified name.

Use Pipeline::builder() for additional configuration.

pub fn builder() -> PipelineBuilder

Creates a new builder-pattern struct instance to construct Pipeline objects.

This method returns an instance of PipelineBuilder which can be used to create Pipeline objects.

Trait Implementations

impl Clone for Pipeline

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 Pipeline

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

Formats the value using the given formatter.

impl Default for Pipeline

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Pipeline

type ParamSpec = ParamSpecObject

type SetValue = Pipeline

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Pipeline

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: PipelineImpl> IsSubclassable<T> for Pipeline

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 Pipeline

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 Pipeline

type Parent = Bin

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

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 Pipeline

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 Pipeline

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Pipeline

impl IsA<Bin> for Pipeline

impl IsA<ChildProxy> for Pipeline

impl IsA<Element> for Pipeline

impl IsA<Object> for Pipeline

impl Send for Pipeline

impl Sync for Pipeline