Struct VideoChunk

pub struct VideoChunk {
    pub session_id: u64,
    pub attachment_id: u64,
    pub stream_seq: u64,
    pub seq: u64,
    pub chunk: u32,
    pub num_chunks: u32,
    pub hierarchical_layer: u32,
    pub fec_metadata: Option<FecMetadata>,
    pub timestamp: u64,
    pub data: Bytes,
}

051 - Video Chunk

This message, which must originate from the server as a datagram or on the same stream as the original 030 - Attach message, contains a part of a video packet.

Much of the metadata associated with the chunk applies to all chunks of a given packet, but must be repeated on each chunk such that a client receiving the first (potentially out-of-order) chunk has sufficient information to deal with it.

Fields

session_id: u64

Required unless sent on the same stream as the original attach message.

attachment_id: u64

stream_seq: u64

Required. Represents the ordering of packets in a stream and the association of packets to a video stream.

seq: u64

chunk: u32

Required unless an FEC scheme is used. Taken together, these represent the placement of a chunk within a packet.

If fec_metadata is set, both these fields must be unset.

num_chunks: u32

hierarchical_layer: u32

If the encoder is using hierarchical coding (sometimes called SVC), this field indicates the layer that the packet belongs to.

fec_metadata: Option<FecMetadata>

Contains FEC metadata to locate the chunk within the overall packet.

timestamp: u64

Required. A millisecond timestamp with an arbitrary epoch, used to synchronize audio and video streams.

data: Bytes

Required. The chunk of the video packet, or, if an FEC scheme is used, a single symbol from the stream of symbols.

Trait Implementations

impl Clone for VideoChunk

fn clone(&self) -> VideoChunk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VideoChunk

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

Formats the value using the given formatter.

impl Default for VideoChunk

fn default() -> Self

Returns the “default value” for a type.

impl From<VideoChunk> for MessageType

fn from(v: VideoChunk) -> Self

Converts to this type from the input type.

impl Message for VideoChunk

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for VideoChunk

fn eq(&self, other: &VideoChunk) -> 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 StructuralPartialEq for VideoChunk