rtmp v0.2.0 API Reference

Modules

Behaviour for modules receiving session events

Behaviour for modules that can serialize and deserialize RTMP messages

Behaviour for modules that can act as session handlers

Indicates that audio or video data has been received

Indicates that the server has accepted or rejcted the connection request

Event indicating the total number of bytes sent or received from the server has changed in value

Indicates that the server has accepted or rejected our request for playback of a stream key

Indicates that the server has accepted or rejected our request for publishing on a specific stream key

Indicates that the server is reporting a change in the incoming stream’s metadata

This module controls the process that processes the busines logic of a client in an RTMP connection

Provides functionality to handle the RTMP handshake process

Functions to parse and validate RTMP handshakes based on flash client versions and SHA digests. This handshake is required for supporting H.264 video

Resulting information after processing a handshake operation

Functions to parse and validate RTMP handshakes as specified in the official RTMP specification

Represents the current results from a parse operation

This module provides an API for performing the conversion between raw binary and RTMP messages based on the RTMP chunk specifications

Represents the details of a deserialized RTMP message

This module controls the process that is responsible for serializing and deserializing RTMP chunk streams for a single peer in an RTMP connection. Input bytes come in, get deserialized into RTMP messages, and then get sent off to the specified session handling process. It can receive outbound RTMP messages that will then be serialized and sent off to the peer

Message used to notify the peer that if it is waiting for chunks to complete a message, then discard the partially received message

Sent when the client or the server receives bytes equal to the window size

Message used to denote an amf0 encoded command (or resposne to a command)

Data structure containing metadata or user data, encoded in Amf0

Data structure containing audio data

Represents a message that the sender is changing their maximum chunk size

Sender is requesting the receiver limit its output bandwidth by limiting the amount of sent but unacknowledged data to the specified window size

Message to notify the peer about user control events

Data structure containing video data

Sent to inform the peer of a change in how much data the receiver should receive before the sender expects and acknowledgement message sent back

Module that represents a raw RTMP message, and functions to unpack and repack them for handling and serialization

Provides utilities to work with timestamps in an RTMP context

Represents configuration options that governs how an RTMP server session should operate

Event indicating that the client has sent an acknowledgement that they have received the specified number of bytes

Event indicating that audio or video data was received

Event indicating that the peer is requesting a ConnectionRequested on the specified application name

Event indicating the total number of bytes sent or received from the client has changed in value

Event indicating that the peer is changing the maximum size of the RTMP chunks they will be sending

Event indicating that the server has sent a ping request to the client

Event indicating that the client has responded to a ping request

Event indicating that they are finished with playback of the specified stream

Event indicating that the peer is requesting playback of the specified stream

Event indicating that the peer is requesting the ability to publish on the specified stream key

Event indicating that the peer is finished publishing on the specified stream key

Event indicating that the peer is requesting a stream key be released for use

Event indicating that the peer is changing metadata properties of the stream being published

Event indicating that an Amf0 command was received that was not able to be handled

This module controls the process that processes the business logic of a server in an RTMP connection