Struct Pipeline

pub struct Pipeline {
    pub name: String,
    /* private fields */
}

Performs requests to pipelines/ endpoint

Fields

name: String

name of the pipeline

Implementations

impl Pipeline

pub async fn create<S: Into<String>>( &self, description: S, ) -> Result<SuccessResponse, Error>

Creates a new pipeline .

Performs POST pipelines?name={name}&description={description} API request, returning the parsed gstd_types::SuccessResponse

Arguments

• description - pipeline with gst-launch syntax

Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn graph(&self) -> Result<SuccessResponse, Error>

Performs GET /pipelines/{name}/graph API request, returning the parsed gstd_types::SuccessResponse

Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn elements(&self) -> Result<SuccessResponse, Error>

Performs GET /pipelines/{name}/elements API request, returning the parsed gstd_types::SuccessResponse

Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn properties(&self) -> Result<SuccessResponse, Error>

Performs GET /pipelines/{name}/properties API request, returning the parsed gstd_types::SuccessResponse

Errors

If API request cannot be performed, or fails. See Error for details.

pub fn element<S: Into<String>>(&self, name: S) -> PipelineElement

Operate with GStreamer Daemon pipeline element.

Arguments

• name - name of the element in the pipeline

pub fn bus(&self) -> PipelineBus

Operate with GStreamer Daemon pipeline bus.

pub async fn emit_event<S: Into<String> + Display>( &self, name: S, ) -> Result<SuccessResponse, Error>

Performs POST pipelines/{name}/event?name={event_name} API request, returning the parsed gstd_types::SuccessResponse

Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn emit_event_eos(&self) -> Result<SuccessResponse, Error>

Performs POST pipelines/{name}/event?name=eos API request, returning the parsed gstd_types::SuccessResponse

Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn emit_event_flush_start(&self) -> Result<SuccessResponse, Error>

Performs POST pipelines/{name}/event?name=flush_start API request, returning the parsed gstd_types::SuccessResponse

Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn emit_event_flush_stop(&self) -> Result<SuccessResponse, Error>

Performs POST pipelines/{name}/event?name=flush_stop API request, returning the parsed gstd_types::SuccessResponse

Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn play(&self) -> Result<SuccessResponse, Error>

Performs PUT pipelines/{name}/state?name=playing API request, returning the parsed gstd_types::SuccessResponse

Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn pause(&self) -> Result<SuccessResponse, Error>

Performs PUT pipelines/{name}/state?name=paused API request, returning the parsed gstd_types::SuccessResponse

Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn stop(&self) -> Result<SuccessResponse, Error>

Performs PUT pipelines/{name}/state?name=null API request, returning the parsed gstd_types::SuccessResponse

Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn set_verbose(&self, value: bool) -> Result<SuccessResponse, Error>

Performs PUT pipelines/{name}/verbose?name={value} API request, returning the parsed gstd_types::SuccessResponse

Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn delete(&self) -> Result<SuccessResponse, Error>

Performs DELETE pipelines/{name}/ API request, returning the parsed gstd_types::SuccessResponse

Errors

If API request cannot be performed, or fails. See Error for details.

Trait Implementations

impl Clone for Pipeline

fn clone(&self) -> Pipeline

Returns a duplicate 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.