Enum rml_rtmp::messages::RtmpMessage

pub enum RtmpMessage {
    Unknown {
        type_id: u8,
        data: Bytes,
    },
    Abort {
        stream_id: u32,
    },
    Acknowledgement {
        sequence_number: u32,
    },
    Amf0Command {
        command_name: String,
        transaction_id: f64,
        command_object: Amf0Value,
        additional_arguments: Vec<Amf0Value>,
    },
    Amf0Data {
        values: Vec<Amf0Value>,
    },
    AudioData {
        data: Bytes,
    },
    SetChunkSize {
        size: u32,
    },
    SetPeerBandwidth {
        size: u32,
        limit_type: PeerBandwidthLimitType,
    },
    UserControl {
        event_type: UserControlEventType,
        stream_id: Option<u32>,
        buffer_length: Option<u32>,
        timestamp: Option<RtmpTimestamp>,
    },
    VideoData {
        data: Bytes,
    },
    WindowAcknowledgement {
        size: u32,
    },
}

An enumeration of all types of RTMP messages that are supported

Variants

Unknown

This type of message is used when an RTMP message is encountered with a type id that we do not know about

Fields of Unknown

type_id: u8data: Bytes

Abort

Notifies the peer that if it is waiting for chunks to complete a message that it should discard the chunks it has already received.

Fields of Abort

stream_id: u32

Acknowledgement

An acknowledgement sent to confirm how many bytes that has been received since the prevoius acknowledgement.

Fields of Acknowledgement

sequence_number: u32

Amf0Command

A command being sent, encoded with amf0 values

Fields of Amf0Command

command_name: Stringtransaction_id: f64command_object: Amf0Valueadditional_arguments: Vec<Amf0Value>

Amf0Data

A message containing an array of data encoded as amf0 values

Fields of Amf0Data

values: Vec<Amf0Value>

AudioData

A message containing audio data

Fields of AudioData

data: Bytes

SetChunkSize

Tells the peer that the maximum chunk size for RTMP chunks it will be sending is changing to the specified size.

Fields of SetChunkSize

size: u32

SetPeerBandwidth

Indicates that the peer should limit its output bandwidth

Fields of SetPeerBandwidth

size: u32limit_type: PeerBandwidthLimitType

UserControl

Notifies the peer of an event, such as a stream being created or telling the peer how much of a buffer it should have.

Fields of UserControl

event_type: UserControlEventTypestream_id: Option<u32>buffer_length: Option<u32>timestamp: Option<RtmpTimestamp>

VideoData

A message containing video data

Fields of VideoData

data: Bytes

WindowAcknowledgement

Notifies the peer how many bytes should be received before sending an Acknowledgement message

Fields of WindowAcknowledgement

size: u32

Implementations

impl RtmpMessage

pub fn into_message_payload(
    self,
    timestamp: RtmpTimestamp,
    message_stream_id: u32
) -> Result<MessagePayload, MessageSerializationError>

pub fn get_message_type_id(&self) -> u8

Trait Implementations

impl Clone for RtmpMessage

fn clone(&self) -> RtmpMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RtmpMessage

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

Formats the value using the given formatter.

impl PartialEq<RtmpMessage> for RtmpMessage

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for RtmpMessage