Enum mmids_core::endpoints::rtmp_server::RtmpEndpointRequest

pub enum RtmpEndpointRequest {
    ListenForPublishers {
        port: u16,
        rtmp_app: String,
        rtmp_stream_key: StreamKeyRegistration,
        message_channel: UnboundedSender<RtmpEndpointPublisherMessage>,
        stream_id: Option<StreamId>,
        ip_restrictions: IpRestriction,
        use_tls: bool,
        requires_registrant_approval: bool,
    },
    ListenForWatchers {
        port: u16,
        rtmp_app: String,
        rtmp_stream_key: StreamKeyRegistration,
        notification_channel: UnboundedSender<RtmpEndpointWatcherNotification>,
        media_channel: UnboundedReceiver<RtmpEndpointMediaMessage>,
        ip_restrictions: IpRestriction,
        use_tls: bool,
        requires_registrant_approval: bool,
    },
    RemoveRegistration {
        registration_type: RegistrationType,
        port: u16,
        rtmp_app: String,
        rtmp_stream_key: StreamKeyRegistration,
    },
}

Operations the rtmp server endpoint is being requested to make

Variants

ListenForPublishers

Fields

port: u16

Port to listen for RTMP publisher connections on

rtmp_app: String

Name of the RTMP application publishers will connect to

rtmp_stream_key: StreamKeyRegistration

What stream key publishers should be using

message_channel: UnboundedSender<RtmpEndpointPublisherMessage>

Channel that the rtmp server endpoint should respond with

stream_id: Option<StreamId>

If specified, new media streams being published from this registration will be given the stream id specified. If no id is given than one will be generated. This is useful to correlate media streams that may have been pulled, processed externally, then brought back in for later workflow steps (e.g. an external transcoding workflow).

ip_restrictions: IpRestriction

What IP restriction rules should be in place for this registration

use_tls: bool

If true, this port should be on a TLS socket (i.e. RTMPS)

requires_registrant_approval: bool

If true, then publishers will not be automatically accepted even if they connect to the correct app/stream key combination and pass ip restrictions. Instead the registrant should be asked for final verification if the publisher should be allowed or not.

Requests the RTMP server to allow publishers on the given port, app, and stream key combinations.

ListenForWatchers

Fields

port: u16

Port to listen on

rtmp_app: String

Name of the RTMP application playback clients will connect to

rtmp_stream_key: StreamKeyRegistration

Stream keys clients can receive video on

notification_channel: UnboundedSender<RtmpEndpointWatcherNotification>

The channel that the rtmp server endpoint will send notifications to

media_channel: UnboundedReceiver<RtmpEndpointMediaMessage>

The channel that the registrant will send updated media data to the rtmp endpoint on

ip_restrictions: IpRestriction

What IP restriction rules should be in place for this registration

use_tls: bool

If true, this port should be on a TLS socket (i.e. RTMPS)

requires_registrant_approval: bool

If true, then watchers will not be automatically accepted even if they connect to the correct app/stream key combination and pass ip restrictions. Instead the registrant should be asked for final verification if the watcher should be allowed or not.

Requests the RTMP server to allow clients to receive video on the given port, app, and stream key combinations

RemoveRegistration

Fields

registration_type: RegistrationType

The type of registration that is being removed

port: u16

Port the removed registrant was listening on

rtmp_app: String

The RTMP application name that the registrant was listening on

rtmp_stream_key: StreamKeyRegistration

The stream key the registrant had registered for

Requests the specified registration should be removed

Trait Implementations

impl Debug for RtmpEndpointRequest

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

Formats the value using the given formatter.