Struct RtmpPacketSource 

pub struct RtmpPacketSource { /* private fields */ }

PacketSource wrapping an RtmpSession.

Constructed by open_rtmp (the registry opener) or directly from a session via RtmpPacketSource::from_session — the latter is useful for callers driving their own RtmpServer::accept loop who want the typed-packet conversion without the listen-and-validate flow.

Implementations

impl RtmpPacketSource

pub fn from_session(session: RtmpSession) -> Self

Wrap a freshly-accepted RtmpSession without any probing — streams() will be empty until the first audio / video packet flows. Suitable for callers who already know the stream shape (e.g. they are also the publisher).

pub fn from_session_with_probe( session: RtmpSession, read_timeout: Option<Duration>, ) -> RtmpResult<Self>

Wrap a session and run the probing loop now: read up to PROBE_LIMIT packets, populate streams() with the observed audio + video codec ids, and buffer those packets for later next_packet calls.

read_timeout bounds individual reads so a publisher that only ever sends one stream-type doesn’t stall probing indefinitely. None keeps the socket blocking with no timeout — only safe when the caller knows the publisher will eventually send both kinds.

pub fn session(&self) -> &RtmpSession

Borrow the wrapped session for advanced operations (set_read_timeout, peer_addr, …). Reading directly would interfere with the PacketSource machinery; prefer inspection-only methods.

Trait Implementations

impl PacketSource for RtmpPacketSource

fn streams(&self) -> &[StreamInfo]

Streams advertised by this source. Stable across the lifetime of the source.

fn next_packet(&mut self) -> CoreResult<Packet>

Read the next packet from any stream. Returns Error::Eof at end of stream.

fn metadata(&self) -> &[(String, String)]

Source-level metadata as ordered (key, value) pairs. Default is empty.

fn duration_micros(&self) -> Option<i64>

Source-level duration in microseconds, if known. Default is None. Live sources (RTMP push, etc.) typically return None.