Struct StreamMetadata 

pub struct StreamMetadata {
    pub key: StreamKey,
    pub publisher_addr: Option<SocketAddr>,
    pub width: u32,
    pub height: u32,
    pub fps: f64,
    pub video_bitrate_bps: u64,
    pub audio_bitrate_bps: u64,
    pub started_at_ms: u64,
    pub ingest_protocol: String,
}

Runtime metadata about a stream, updated continuously while publishing.

Resolution and the ingest protocol are set by the protocol handler (e.g. via StreamHandle::update_metadata after parsing the codec config), while the fps and *_bitrate_bps fields are overlaid live from measured throughput by StreamHandle::metadata_snapshot.

Fields

key: StreamKey

The (app, stream_id) this metadata describes.

publisher_addr: Option<SocketAddr>

Publisher remote address.

width: u32

Video width in pixels (0 = unknown).

height: u32

Video height in pixels (0 = unknown).

fps: f64

Video frames per second (0 = unknown). Overlaid from measured throughput.

video_bitrate_bps: u64

Measured video ingest bitrate in bits-per-second.

audio_bitrate_bps: u64

Measured audio ingest bitrate in bits-per-second.

started_at_ms: u64

Timestamp of the first frame received (Unix ms).

ingest_protocol: String

Protocol used for ingest (e.g. "rtmp").

Implementations

impl StreamMetadata

pub fn new(app: AppName, stream_id: StreamId) -> Self

Create zeroed metadata for (app, stream_id).

Trait Implementations

impl Clone for StreamMetadata

fn clone(&self) -> StreamMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamMetadata

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

Formats the value using the given formatter.