Struct ClientSession 

pub struct ClientSession { /* private fields */ }

A driveable RTSP client session (RFC 2326 §A.1).

Implementations

impl ClientSession

pub fn new() -> Self

Creates a fresh client session in the Init state with CSeq starting at 1.

pub fn with_credentials(self, credentials: Credentials) -> Self

Attaches credentials so the engine can answer 401 challenges (§14).

pub fn with_user_agent(self, ua: impl Into<String>) -> Self

Overrides the User-Agent header value sent on requests.

pub fn state(&self) -> SessionState

The current session state.

pub fn session_id(&self) -> Option<&str>

The negotiated session id, once a SETUP response has been processed.

pub fn session_timeout(&self) -> Option<u64>

The session timeout in seconds, if the SETUP response declared one.

pub fn negotiated_transport(&self) -> Option<&Transport>

The transport negotiated in the SETUP response, if any.

pub fn options(&mut self, uri: &str) -> Result<Vec<u8>>

Builds an OPTIONS request (state-neutral).

pub fn describe(&mut self, uri: &str) -> Result<Vec<u8>>

Builds a DESCRIBE request with Accept: application/sdp (state-neutral).

pub fn setup(&mut self, uri: &str, transport: &Transport) -> Result<Vec<u8>>

Builds a SETUP request carrying the given Transport (Init/Ready/…).

pub fn play(&mut self, uri: &str) -> Result<Vec<u8>>

Builds a PLAY request (valid in Ready/Playing).

pub fn pause(&mut self, uri: &str) -> Result<Vec<u8>>

Builds a PAUSE request (valid in Playing/Recording).

pub fn teardown(&mut self, uri: &str) -> Result<Vec<u8>>

Builds a TEARDOWN request (valid in any non-Init state, and Init).

pub fn get_parameter(&mut self, uri: &str, body: &[u8]) -> Result<Vec<u8>>

Builds a GET_PARAMETER request, optionally with a body (state-neutral; an empty body is the liveness ping).

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

Feeds inbound bytes and returns the events produced. Retains any partial trailing message or frame internally for the next call.

Trait Implementations

impl Debug for ClientSession

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

Formats the value using the given formatter.

impl Default for ClientSession

fn default() -> Self

Returns the “default value” for a type.