Skip to main content

ClientSession

Struct ClientSession 

Source
pub struct ClientSession { /* private fields */ }
Expand description

Sans-IO RTMP client publish session.

Implementations§

Source§

impl ClientSession

Source

pub fn new(config: ClientConfig) -> Self

Create a new client session.

Source

pub fn start(&mut self) -> Vec<u8>

Produce C0+C1 handshake bytes. Call once at session start.

Source

pub fn handle_data( &mut self, input: &[u8], ) -> Result<(Vec<u8>, Vec<ClientEvent>), RtmpError>

Feed inbound bytes. Returns (outbound bytes, events).

Source

pub fn send_audio( &mut self, timestamp: u32, data: &[u8], ) -> Result<Vec<u8>, RtmpError>

Encode an audio message (type 8). Only valid in Publishing state.

Source

pub fn send_video( &mut self, timestamp: u32, data: &[u8], ) -> Result<Vec<u8>, RtmpError>

Encode a video message (type 9). Only valid in Publishing state.

Source

pub fn send_metadata( &mut self, metadata: &[(String, Amf0Value)], ) -> Result<Vec<u8>, RtmpError>

Encode a metadata message (@setDataFrame/onMetaData, type 18).

Source

pub fn is_publishing(&self) -> bool

Whether the session has reached Publishing state.

Trait Implementations§

Source§

impl Debug for ClientSession

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.