Struct MediaStream

#[non_exhaustive]
pub struct MediaStream {
    pub attributes: Option<MediaStreamAttributes>,
    pub clock_rate: Option<i32>,
    pub description: Option<String>,
    pub fmt: Option<i32>,
    pub media_stream_id: Option<i32>,
    pub media_stream_name: Option<String>,
    pub media_stream_type: Option<MediaStreamType>,
    pub video_format: Option<String>,
}

A media stream represents one component of your content, such as video, audio, or ancillary data. After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

attributes: Option<MediaStreamAttributes>

Attributes that are related to the media stream.

clock_rate: Option<i32>

The sample rate for the stream. This value is measured in Hz.

description: Option<String>

A description that can help you quickly identify what your media stream is used for.

fmt: Option<i32>

The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.

media_stream_id: Option<i32>

A unique identifier for the media stream.

media_stream_name: Option<String>

A name that helps you distinguish one media stream from another.

media_stream_type: Option<MediaStreamType>

The type of media stream.

video_format: Option<String>

The resolution of the video.

Implementations

impl MediaStream

pub fn attributes(&self) -> Option<&MediaStreamAttributes>

Attributes that are related to the media stream.

pub fn clock_rate(&self) -> Option<i32>

The sample rate for the stream. This value is measured in Hz.

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

A description that can help you quickly identify what your media stream is used for.

pub fn fmt(&self) -> Option<i32>

The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.

pub fn media_stream_id(&self) -> Option<i32>

A unique identifier for the media stream.

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

A name that helps you distinguish one media stream from another.

pub fn media_stream_type(&self) -> Option<&MediaStreamType>

The type of media stream.

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

The resolution of the video.

impl MediaStream

pub fn builder() -> MediaStreamBuilder

Creates a new builder-style object to manufacture MediaStream.

Trait Implementations

impl Clone for MediaStream

fn clone(&self) -> MediaStream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MediaStream

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

Formats the value using the given formatter.

impl PartialEq for MediaStream

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

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

const 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 StructuralPartialEq for MediaStream