Module rtmp_server

Source
Expand description

This endpoint acts as a server for RTMP clients that want to publish or watch RTMP live streams. Workflow steps send a message requesting to allow RTMP publishers or watchers for specific port, RTMP application and stream key combinations. The RTMP server endpoint will register the specified port with the networking infrastructure for listening for connections, and any networked traffic over that port will be forwarded to this endpoint.

It will then perform handshaking and all other RTMP protocol actions, disconnecting clients if they don’t conform to the RTMP protocol correctly, or if they attempt to publish or watch an application name and stream key combination that isn’t actively registered.

Incoming publish actions (such as new metadata, media packets, etc…) are passed to the workflow steps that were registered for that application/stream key combination. Likewise, when the endpoint receives media from workflow steps it will route that media to the correct RTMP watcher clients

Structs§

RtmpEndpointMediaMessage
Message watcher registrants send to announce new media data that should be sent to watchers

Enums§

IpRestriction
Specifies if there are any IP address restrictions as part of an RTMP server registration
RegistrationType
Type of registration the request is related to
RtmpEndpointMediaData
New media data that should be sent to watchers
RtmpEndpointPublisherMessage
Messages the rtmp server endpoint will send to publisher registrants.
RtmpEndpointRequest
Operations the rtmp server endpoint is being requested to make
RtmpEndpointWatcherNotification
Messages the rtmp server endpoint will send to watcher registrants
StreamKeyRegistration
Specifies how a stream key should be registered for playback or publishing
ValidationResponse
Response to approval/validation requests

Functions§

start_rtmp_server_endpoint
Starts a new RTMP server endpoint, returning a channel that can be used to send notifications and requests to it.