ExRTMP.Message (RTMP Server and Client v0.4.1)

@type t() :: %ExRTMP.Message{
  current_size: non_neg_integer() | nil,
  payload: iodata() | struct() | non_neg_integer(),
  size: non_neg_integer() | nil,
  stream_id: stream_id(),
  timestamp: non_neg_integer(),
  type: non_neg_integer()
}

Functions

abort(stream_id)

@spec abort(non_neg_integer()) :: t()

Builds an Abort message.

aknowledgment(received_bytes)

@spec aknowledgment(non_neg_integer()) :: t()

Builds an Acknowledgment message.

chunk_size(chunk_size)

@spec chunk_size(non_neg_integer()) :: t()

Builds a Set Chunk Size message.

command(command, stream_id \\ 0)

@spec command(any(), non_neg_integer()) :: t()

Builds a Command message.

metadata(metadata, stream_id)

@spec metadata(map(), non_neg_integer()) :: t()

Builds a Metadata message.

new(payload, opts)

@spec new(
  iodata() | struct(),
  keyword()
) :: t()

Creates a new Message.

peer_bandwidth(size, limit_type \\ 2)

@spec peer_bandwidth(non_neg_integer(), 0..2) :: t()

Builds a Peer Bandwidth message.

ping_response(timestamp)

@spec ping_response(non_neg_integer()) :: t()

Builds a User Control message.

serialize(message, opts \\ [])

@spec serialize(
  t(),
  keyword()
) :: binary()

Serializes the message.

The following options may be provided:

:chunk_size - The size of each chunk (default: 128)
:chunk_stream_id - The chunk stream id to use (default: 2)

stream_begin(stream_id)

@spec stream_begin(non_neg_integer()) :: t()

Builds a User Control message.

window_acknowledgment_size(size)

@spec window_acknowledgment_size(non_neg_integer()) :: t()

Builds a Window Acknowledgment Size message.