Struct Stream

pub struct Stream {
    pub client: LivepeerClient,
    pub urls: LivepeerUrls,
}

Fields

client: LivepeerClient

urls: LivepeerUrls

Implementations

impl Stream

pub fn new(client: &LivepeerClient) -> Self

Create a new Stream instance

Parameters

• client - A reference to the LivepeerClient

Returns

• Self - A new instance of Stream

pub fn list_streams(self) -> Result<Streams, Error>

List all streams

Returns

• Result<crate::data::stream::Streams, errors::Error> - A list of streams or an error

pub fn get_stream_by_id(self, stream_id: String) -> Result<Value, Error>

Get stream by ID

Parameters

• stream_id - The ID of the stream

Returns

• Result<serde_json::Value, errors::Error> - A JSON value containing the stream or an error

pub fn get_stream_by_playback_id( self, playback_id: String, admin: bool, ) -> Result<Value, Error>

Get stream by playback ID

Parameters

• playback_id - The ID of the playback
• admin - A boolean indicating if the request is made by an admin

Returns

• Result<serde_json::Value, errors::Error> - A JSON value containing the stream or an error

pub fn get_streams_by_user_id(self, user_id: String) -> Result<Streams, Error>

Get streams by user ID

Parameters

• user_id - The ID of the user

Returns

• Result<crate::data::stream::Streams, errors::Error> - A list of streams or an error

pub fn create_stream( self, name: &String, profiles: &Vec<Profile>, playback_policy: Option<Value>, ) -> Result<String, Error>

Create a stream

Parameters

• name - The name of the stream
• profiles - A list of profiles for the stream
• playback_policy - An optional playback policy

Returns

• Result<String, errors::Error> - The ID of the created stream or an error

Trait Implementations

impl Clone for Stream

fn clone(&self) -> Stream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stream

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

Formats the value using the given formatter.

impl Stream for Stream

fn list_streams(&self) -> Result<Streams, Error>

List all streams

Returns

• Result<crate::data::stream::Streams, errors::Error> - A list of streams or an error

fn get_stream_by_id(&self, stream_id: String) -> Result<Value, Error>

Get stream by ID

Parameters

• stream_id - The ID of the stream

Returns

• Result<serde_json::Value, errors::Error> - A JSON value containing the stream or an error

fn get_streams_by_user_id(&self, user_id: String) -> Result<Streams, Error>

Get streams by user ID

Parameters

• user_id - The ID of the user

Returns

• Result<crate::data::stream::Streams, errors::Error> - A list of streams or an error

fn get_stream_by_playback_id( &self, playback_id: String, admin: bool, ) -> Result<Value, Error>

Get stream by playback ID

Parameters

• playback_id - The ID of the playback
• admin - A boolean indicating if the request is made by an admin

Returns

• Result<serde_json::Value, crate::errors::Error> - A JSON value containing the stream or an error

fn create_stream( &self, name: &String, profiles: &Vec<Profile>, playback_policy: Option<Value>, ) -> Result<String, Error>

Create a stream

Parameters

• name - The name of the stream
• profiles - A list of profiles for the stream
• playback_policy - An optional playback policy

Returns

• Result<String, errors::Error> - The ID of the created stream or an error