Trait RtmpHandler 

pub trait RtmpHandler:
    Send
    + Sync
    + 'static {
    // Provided methods
    fn on_connection<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 SessionContext,
    ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn on_handshake_complete<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 SessionContext,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn on_connect<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 SessionContext,
        _params: &'life2 ConnectParams,
    ) -> Pin<Box<dyn Future<Output = AuthResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait { ... }
    fn on_fc_publish<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 SessionContext,
        _stream_key: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = AuthResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait { ... }
    fn on_publish<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 SessionContext,
        _params: &'life2 PublishParams,
    ) -> Pin<Box<dyn Future<Output = AuthResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait { ... }
    fn on_play<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 SessionContext,
        _params: &'life2 PlayParams,
    ) -> Pin<Box<dyn Future<Output = AuthResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait { ... }
    fn on_metadata<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 StreamContext,
        _metadata: &'life2 HashMap<String, AmfValue>,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait { ... }
    fn on_media_tag<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 StreamContext,
        _tag: &'life2 FlvTag,
    ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait { ... }
    fn on_video_frame<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 StreamContext,
        _frame: &'life2 H264Data,
        _timestamp: u32,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait { ... }
    fn on_audio_frame<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 StreamContext,
        _frame: &'life2 AacData,
        _timestamp: u32,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait { ... }
    fn on_keyframe<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 StreamContext,
        _timestamp: u32,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn on_publish_stop<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 StreamContext,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn on_play_stop<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 StreamContext,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn on_pause<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 StreamContext,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn on_unpause<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 StreamContext,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn on_disconnect<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 SessionContext,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn media_delivery_mode(&self) -> MediaDeliveryMode { ... }
    fn on_stats_update<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 SessionContext,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
}

Handler trait for RTMP applications

Implement this trait to customize RTMP server behavior. All methods have default implementations that accept/allow everything.

Example

use rtmp_rs::{RtmpHandler, AuthResult};
use rtmp_rs::session::SessionContext;
use rtmp_rs::protocol::message::{ConnectParams, PublishParams};

struct MyHandler;

#[async_trait::async_trait]
impl RtmpHandler for MyHandler {
    async fn on_connect(&self, ctx: &SessionContext, params: &ConnectParams) -> AuthResult {
        // Validate application name
        if params.app == "live" {
            AuthResult::Accept
        } else {
            AuthResult::Reject("Unknown application".into())
        }
    }

    async fn on_publish(&self, ctx: &SessionContext, params: &PublishParams) -> AuthResult {
        // Validate stream key (e.g., check against database)
        if params.stream_key.starts_with("valid_") {
            AuthResult::Accept
        } else {
            AuthResult::Reject("Invalid stream key".into())
        }
    }
}

Provided Methods

fn on_connection<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 SessionContext, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when a new TCP connection is established

Return false to immediately close the connection. Use this for IP-based rate limiting or blocklists.

fn on_handshake_complete<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 SessionContext, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called after successful handshake, before connect command

fn on_connect<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _ctx: &'life1 SessionContext, _params: &'life2 ConnectParams, ) -> Pin<Box<dyn Future<Output = AuthResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called on RTMP ‘connect’ command

Validate the application name, auth tokens in tcUrl, etc.

fn on_fc_publish<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _ctx: &'life1 SessionContext, _stream_key: &'life2 str, ) -> Pin<Box<dyn Future<Output = AuthResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called on FCPublish command (OBS/Twitch compatibility)

This is called before ‘publish’ and can be used for early stream key validation.

fn on_publish<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _ctx: &'life1 SessionContext, _params: &'life2 PublishParams, ) -> Pin<Box<dyn Future<Output = AuthResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called on ‘publish’ command

Validate the stream key. This is the main authentication point for publishers.

fn on_play<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _ctx: &'life1 SessionContext, _params: &'life2 PlayParams, ) -> Pin<Box<dyn Future<Output = AuthResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called on ‘play’ command

Validate play access. Return Reject to deny playback.

fn on_metadata<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _ctx: &'life1 StreamContext, _metadata: &'life2 HashMap<String, AmfValue>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called when stream metadata is received (@setDataFrame/onMetaData)

fn on_media_tag<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _ctx: &'life1 StreamContext, _tag: &'life2 FlvTag, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for each raw FLV tag (when MediaDeliveryMode includes RawFlv)

Return true to continue processing, false to drop the tag.

fn on_video_frame<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _ctx: &'life1 StreamContext, _frame: &'life2 H264Data, _timestamp: u32, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for each video frame (when MediaDeliveryMode includes ParsedFrames)

fn on_audio_frame<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _ctx: &'life1 StreamContext, _frame: &'life2 AacData, _timestamp: u32, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for each audio frame (when MediaDeliveryMode includes ParsedFrames)

fn on_keyframe<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 StreamContext, _timestamp: u32, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when a keyframe is received

fn on_publish_stop<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 StreamContext, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when the publish stream ends

fn on_play_stop<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 StreamContext, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when the play stream ends

fn on_pause<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 StreamContext, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when a subscriber pauses playback

fn on_unpause<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 StreamContext, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when a subscriber resumes playback

fn on_disconnect<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 SessionContext, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when the connection closes

fn media_delivery_mode(&self) -> MediaDeliveryMode

Get the media delivery mode for this handler

fn on_stats_update<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 SessionContext, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called periodically with stats update

Implementors

impl RtmpHandler for LoggingHandler

impl<H1, H2> RtmpHandler for ChainedHandler<H1, H2>

where H1: RtmpHandler, H2: RtmpHandler,