Module rtmpmsg

RTMP messages and exported types.

Description

RTMP messages and exported types

Data Types

byte_size()

byte_size() = non_neg_integer()

chunk()

chunk() = #chunk{id = rtmpmsg:chunk_stream_id(), msg_stream_id = rtmpmsg:message_stream_id(), msg_type_id = rtmpmsg:message_type_id(), timestamp = rtmpmsg:message_timestamp(), payload = binary()}

chunk_size()

chunk_size() = 1..65536

chunk_stream_id()

chunk_stream_id() = 2..65599

event_buffer_empty()

event_buffer_empty() = #rtmpmsg_event_buffer_empty{stream_id = rtmpmsg:message_stream_id()}

event_buffer_ready()

event_buffer_ready() = #rtmpmsg_event_buffer_ready{stream_id = rtmpmsg:message_stream_id()}

event_ping_request()

event_ping_request() = #rtmpmsg_event_ping_request{timestamp = rtmpmsg:message_timestamp()}

event_ping_response()

event_ping_response() = #rtmpmsg_event_ping_response{timestamp = rtmpmsg:message_timestamp()}

event_set_buffer_length()

event_set_buffer_length() = #rtmpmsg_event_set_buffer_length{stream_id = rtmpmsg:message_stream_id(), length = rtmpmsg:milliseconds()}

event_stream_begin()

event_stream_begin() = #rtmpmsg_event_stream_begin{stream_id = rtmpmsg:message_stream_id()}

event_stream_dry()

event_stream_dry() = #rtmpmsg_event_stream_dry{stream_id = rtmpmsg:message_stream_id()}

event_stream_eof()

event_stream_eof() = #rtmpmsg_event_stream_eof{stream_id = rtmpmsg:message_stream_id()}

event_stream_is_recorded()

event_stream_is_recorded() = #rtmpmsg_event_stream_is_recorded{stream_id = rtmpmsg:message_stream_id()}

event_unknown()

event_unknown() = #rtmpmsg_event_unknown{type_id = non_neg_integer(), payload = binary()}

message()

message() = #rtmpmsg{stream_id = rtmpmsg:message_stream_id(), type_id = rtmpmsg:message_type_id(), timestamp = rtmpmsg:message_timestamp(), body = undefined | rtmpmsg:message_body()}

message_body()

message_body() = message_body_protocol_control() | message_body_audio() | message_body_video() | message_body_command() | message_body_data() | message_body_shared_object() | message_body_aggregate() | message_body_unknown()

message_body_abort()

message_body_abort() = #rtmpmsg_abort{chunk_stream_id = rtmpmsg:chunk_stream_id()}

message_body_ack()

message_body_ack() = #rtmpmsg_ack{sequence_number = non_neg_integer()}

message_body_aggregate()

message_body_aggregate() = #rtmpmsg_aggregate{messages = [rtmpmsg:message()]}

message_body_audio()

message_body_audio() = #rtmpmsg_audio{data = undefined | binary()}

message_body_command()

message_body_command() = #rtmpmsg_command{amf_version = amf:amf_version(), name = amf:amf_string(), transaction_id = amf:amf_number(), object = amf:amf_value(), args = [amf:amf_value()]}

message_body_data()

message_body_data() = #rtmpmsg_data{amf_version = amf:amf_version(), values = [amf:amf_value()]}

message_body_protocol_control()

message_body_protocol_control() = message_body_set_chunk_size() | message_body_abort() | message_body_ack() | message_body_win_ack_size() | message_body_set_peer_bandwidth() | message_body_user_control()

message_body_set_chunk_size()

message_body_set_chunk_size() = #rtmpmsg_set_chunk_size{size = non_neg_integer()}

message_body_set_peer_bandwidth()

message_body_set_peer_bandwidth() = #rtmpmsg_set_peer_bandwidth{size = non_neg_integer(), limit_type = rtmpmsg:set_peer_bandwidth_limit_type()}

message_body_shared_object()

message_body_shared_object() = #rtmpmsg_shared_object{amf_version = amf:amf_version(), payload = binary()}

message_body_unknown()

message_body_unknown() = #rtmpmsg_unknown{type_id = rtmpmsg:message_type_id(), payload = binary()}

message_body_user_control()

message_body_user_control() = #rtmpmsg_user_control{event = undefined | rtmpmsg:user_control_event()}

message_body_video()

message_body_video() = #rtmpmsg_video{data = undefined | binary()}

message_body_win_ack_size()

message_body_win_ack_size() = #rtmpmsg_win_ack_size{size = non_neg_integer()}

message_stream_id()

message_stream_id() = non_neg_integer()

message_timestamp()

message_timestamp() = milliseconds()

message_type_id()

message_type_id() = byte()

milliseconds()

milliseconds() = non_neg_integer()

set_peer_bandwidth_limit_type()

set_peer_bandwidth_limit_type() = hard | soft | dynamic

user_control_event()

user_control_event() = event_stream_begin() | event_stream_eof() | event_stream_dry() | event_set_buffer_length() | event_stream_is_recorded() | event_ping_request() | event_ping_response() | event_buffer_empty() | event_buffer_ready() | event_unknown()

Function Index

abort/1Make Abort Message.
ack/1Make Acknowledgement Message.
aggregate/2Make Aggregate Message.
audio/3Make Audio Message.
command/6Make Command Message.
data/3Make Data Message.
data/4Make Data Message.
event_buffer_empty/1Make BufferEmptyEvent Message.
event_buffer_ready/1Make BufferReadyEvent Message.
event_ping_request/1Make PingRequestEvent Message.
event_ping_response/1Make PingResponseEvent Message.
event_set_buffer_length/2Make SetBufferLengthEvent Message.
event_stream_begin/1Make StreamBeginEvent Message.
event_stream_dry/1Make StreamDryEvent Message.
event_stream_eof/1Make StreamEofEvent Message.
event_stream_is_recorded/1Make StreamIsRecordedEvent Message.
message/3Make RTMP message.
notify_command/4Make Command Message (for notify).
notify_command/5Make Command Message (for notify).
protocol_control_message/1Make RTMP Protocol Control Message.
response_command/4Make Command Message (for response).
set_chunk_size/1Make SetChunkSize Message.
set_peer_bandwidth/2Make SetPeerBandwidth Message.
shared_object/3Make SharedObject Message (experimental).
user_control_message/1Make RTMP User Control Message.
video/3Make Video Message.
win_ack_size/1Make WindowAcknowledgementSize Message.

Function Details

abort/1

abort(ChunkStreamId::chunk_stream_id()) -> message()

Make Abort Message

ack/1

ack(SequenceNumber::byte_size()) -> message()

Make Acknowledgement Message

aggregate/2

aggregate(StreamId::message_stream_id(), Messages::[message()]) -> message()

Make Aggregate Message

audio/3

audio(StreamId::message_stream_id(), Timestamp::milliseconds(), X3::binary()) -> message()

Make Audio Message

command/6

command(StreamId::message_stream_id(), AmfVersion::amf:amf_version(), Name::amf:amf_string(), TransactionId::amf:amf_number(), Object::amf:amf_value(), Args::[amf:amf_value()]) -> message()

Make Command Message

data/3

data(StreamId::message_stream_id(), AmfVersion::amf:amf_version(), Values::[amf:amf_value()]) -> message()

Make Data Message

XXX: deprecated

data/4

data(StreamId::message_stream_id(), Timestamp::milliseconds(), AmfVersion::amf:amf_version(), Values::[amf:amf_value()]) -> message()

Make Data Message

event_buffer_empty/1

event_buffer_empty(StreamId::message_stream_id()) -> message()

Make BufferEmptyEvent Message

event_buffer_ready/1

event_buffer_ready(StreamId::message_stream_id()) -> message()

Make BufferReadyEvent Message

event_ping_request/1

event_ping_request(Timestamp::milliseconds()) -> message()

Make PingRequestEvent Message

event_ping_response/1

event_ping_response(Timestamp::milliseconds()) -> message()

Make PingResponseEvent Message

event_set_buffer_length/2

event_set_buffer_length(StreamId::message_stream_id(), Length::milliseconds()) -> message()

Make SetBufferLengthEvent Message

event_stream_begin/1

event_stream_begin(StreamId::message_stream_id()) -> message()

Make StreamBeginEvent Message

event_stream_dry/1

event_stream_dry(StreamId::message_stream_id()) -> message()

Make StreamDryEvent Message

event_stream_eof/1

event_stream_eof(StreamId::message_stream_id()) -> message()

Make StreamEofEvent Message

event_stream_is_recorded/1

event_stream_is_recorded(StreamId::message_stream_id()) -> message()

Make StreamIsRecordedEvent Message

message/3

message(StreamId::message_stream_id(), Timestamp::message_timestamp(), Body::message_body()) -> message()

Make RTMP message

notify_command/4

notify_command(RequestMessage::message(), Name::amf:amf_string(), Object::amf:amf_value(), Args::[amf:amf_value()]) -> message()

Make Command Message (for notify)

notify_command/5

notify_command(StreamId::message_stream_id(), AmfVersion::amf:amf_version(), Name::amf:amf_string(), Object::amf:amf_value(), Args::[amf:amf_value()]) -> message()

Make Command Message (for notify)

protocol_control_message/1

protocol_control_message(Body::message_body_protocol_control()) -> message()

Make RTMP Protocol Control Message

response_command/4

response_command(RequestMessage::message(), Name::amf:amf_string(), Object::amf:amf_value(), Args::[amf:amf_value()]) -> message()

Make Command Message (for response)

set_chunk_size/1

set_chunk_size(ChunkSize::chunk_size()) -> message()

Make SetChunkSize Message

set_peer_bandwidth/2

set_peer_bandwidth(WindowSize::byte_size(), LimitType::set_peer_bandwidth_limit_type()) -> message()

Make SetPeerBandwidth Message

shared_object/3

shared_object(StreamId::message_stream_id(), AmfVersion::amf:amf_version(), Payload::binary()) -> message()

Make SharedObject Message (experimental)

user_control_message/1

user_control_message(Event::user_control_event()) -> message()

Make RTMP User Control Message

video/3

video(StreamId::message_stream_id(), Timestamp::milliseconds(), X3::binary()) -> message()

Make Video Message

win_ack_size/1

win_ack_size(WindowSize::byte_size()) -> message()

Make WindowAcknowledgementSize Message


Generated by EDoc, Mar 11 2018, 19:50:31.