Enum RtmpEndpointPublisherMessage

pub enum RtmpEndpointPublisherMessage {
    PublisherRegistrationFailed,
    PublisherRegistrationSuccessful,
    PublisherRequiringApproval {
        connection_id: ConnectionId,
        stream_key: String,
        response_channel: Sender<ValidationResponse>,
    },
    NewPublisherConnected {
        connection_id: ConnectionId,
        stream_id: StreamId,
        stream_key: String,
        reactor_update_channel: Option<UnboundedReceiver<ReactorWorkflowUpdate>>,
    },
    PublishingStopped {
        connection_id: ConnectionId,
    },
    StreamMetadataChanged {
        publisher: ConnectionId,
        metadata: StreamMetadata,
    },
    NewVideoData {
        publisher: ConnectionId,
        codec: VideoCodec,
        is_keyframe: bool,
        is_sequence_header: bool,
        data: Bytes,
        timestamp: RtmpTimestamp,
        composition_time_offset: i32,
    },
    NewAudioData {
        publisher: ConnectionId,
        codec: AudioCodec,
        is_sequence_header: bool,
        data: Bytes,
        timestamp: RtmpTimestamp,
    },
}

Messages the rtmp server endpoint will send to publisher registrants.

Variants

PublisherRegistrationFailed

Notification that the publisher registration failed. No further messages will be sent if this is sent.

PublisherRegistrationSuccessful

Notification that the publisher registration succeeded.

PublisherRequiringApproval

Notification that a new RTMP connection has been made and they have requested to be a publisher on a stream key, but they require validation before being approved.

Fields

connection_id: ConnectionId

Unique identifier for the TCP connection that’s requesting to be a publisher

stream_key: String

The stream key that the connection is requesting to be a publisher to

response_channel: Sender<ValidationResponse>

Channel to send the approval or rejection response to

NewPublisherConnected

Notification that a new RTMP connection has been made and is publishing media

Fields

connection_id: ConnectionId

Unique identifier for the TCP connection that’s publishing

stream_id: StreamId

Unique identifier for the stream.

stream_key: String

Actual stream key that this stream is coming in from. Mostly used if the registrant specified that Any stream key would be allowed.

reactor_update_channel: Option<UnboundedReceiver<ReactorWorkflowUpdate>>

If provided, this is a channel which will receive workflow updates from a reactor tied to this publisher

PublishingStopped

Notification that a publisher has stopped publishing. It may still be connected to the server, but it is no longer in a publisher state.

Fields

connection_id: ConnectionId

Unique identifier for the TCP connection that stopped publishing

StreamMetadataChanged

An RTMP publisher has sent in new stream metadata information

Fields

publisher: ConnectionId

metadata: StreamMetadata

NewVideoData

An RTMP publisher has sent in new video data

Fields

publisher: ConnectionId

codec: VideoCodec

is_keyframe: bool

is_sequence_header: bool

data: Bytes

timestamp: RtmpTimestamp

composition_time_offset: i32

NewAudioData

An RTMP publisher has sent in new audio data

Fields

publisher: ConnectionId

codec: AudioCodec

is_sequence_header: bool

data: Bytes

timestamp: RtmpTimestamp

Trait Implementations

impl Debug for RtmpEndpointPublisherMessage

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

Formats the value using the given formatter.