Struct PublishSession 

pub struct PublishSession { /* private fields */ }

An RAII publish session — a protocol worker’s exclusive token for one live stream.

Wraps the engine’s StreamHandle: every publish_frame lands in the broadcast fan-out, GOP cache, and live QoS counters. Dropping the session releases the publish slot (best-effort, on the current Tokio runtime), so a worker that returns early or panics never leaks a stream. Prefer finish for deterministic, awaited teardown.

Implementations

impl PublishSession

pub fn key(&self) -> &StreamKey

The stream key this session publishes to.

pub fn handle(&self) -> &StreamHandle

The underlying engine StreamHandle — GOP cache, QoS, subscriber count, metadata, and direct subscribe/replay access.

pub fn publish_frame(&self, frame: MediaFrame) -> Result<usize>

Publish one decoded frame to all subscribers; returns the live subscriber count (0 when nobody is watching yet).

pub async fn finish(self) -> Result<()>

Release the publish slot deterministically. Prefer this over relying on Drop whenever you can await — it surfaces the teardown error and completes before the next stream can reuse the key.

Trait Implementations

impl Drop for PublishSession

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.