Struct rml_rtmp::messages::MessagePayload

pub struct MessagePayload {
    pub timestamp: RtmpTimestamp,
    pub type_id: u8,
    pub message_stream_id: u32,
    pub data: Bytes,
}

Represents a raw RTMP message

Fields

timestamp: RtmpTimestamp

type_id: u8

message_stream_id: u32

data: Bytes

Methods

impl MessagePayload

pub fn new() -> MessagePayload

Creates a new message payload with default values.

This is mostly used when all information about a message is not known at creation time but instead is built up over time (e.g. RTMP chunk deserialization process).

pub fn to_rtmp_message(     &self ) -> Result<RtmpMessage, MessageDeserializationError>

Deserializes the message data in the specified payload into its corresponding RtmpMessage.

Note that flash clients (like Wowza's test client) lie and mark amf0 data and commands as amf3 values. It is unknown why this happens, but any Amf3 command/data messages that are seen are deserialized as amf0. So far this has not caused any issues.

pub fn from_rtmp_message(     message: RtmpMessage,     timestamp: RtmpTimestamp,     message_stream_id: u32 ) -> Result<MessagePayload, MessageSerializationError>

This creates a MessagePayload from an RtmpMessage.

Since RTMP messages do not contain timestamp or the conversation stream id these must be provided at the time of creation.

Trait Implementations

impl PartialEq<MessagePayload> for MessagePayload

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

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

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

This method tests for !=.

impl Debug for MessagePayload

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

Formats the value using the given formatter.