Struct StreamKey 

pub struct StreamKey {
    pub app: AppName,
    pub stream_id: StreamId,
}

Composite key uniquely identifying a stream: (app_name, stream_id).

Fields

app: AppName

Application the stream belongs to.

stream_id: StreamId

Stream identifier within the application.

Implementations

impl StreamKey

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

Build a key from an application name and stream id.

pub fn layer(&self, variant: &str) -> StreamKey

The key for an adaptive-bitrate layer of this stream: <stream>~<variant> in the same application.

This is the one convention shared across the media plane — the WebRTC simulcast demux (one key per RID), an ABR transcoder (one per rendition rung), and the WHEP layer selector that discovers and switches between them all agree on it, so a transcoded rung and a simulcast layer are interchangeable to a viewer.

pub fn layer_base(&self) -> &str

The base stream id of a layer key (everything before the first ~), i.e. the inverse of layer. Returns the whole id when it carries no ~ (already a base stream).

Trait Implementations

impl Clone for StreamKey

fn clone(&self) -> StreamKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StreamKey

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

Formats the value using the given formatter.

impl Eq for StreamKey

impl Hash for StreamKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StreamKey

fn eq(&self, other: &StreamKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StreamKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamKey