Struct RtmpHandler

pub struct RtmpHandler<RW: AsyncRead + AsyncWrite + Unpin>(/* private fields */);

The default RTMP handler.

This handles the raw RTMP by well-known communication steps. That is, this performs just following steps.

As a publisher

1. Specifies the application name via the Connect command.
2. Specifies the topic path via the ReleaseStream/FcPublish command.
3. Requests a message ID via the CreateStream command.
4. Specifies publication informations via the Publish command.
5. Then sends FLV media data.

If some error occurs in any step, sends commands which are FcUnpublish and DeleteStream to its server, then terminates its connection. These perform to delete the topic path and a message ID from its context. However also these can be sent from servers.

As a subscriber

1. Specifies the application name via the Connect command.
2. Tells the size of receiving bandwidth via the WindowAcknowledgementSize message.
3. Requests a message ID via the CreateStream command.
4. Specified the topic path via the FcSubscribe command.
5. Following additional command may be required.
   • Requests the duration of its topic via the GetStreamLength command. (in FFmpeg)
   • Requests a list of topics as a playlist via the SetPlaylist command. (in OBS)
6. Specifies subscription information via the Play command.
7. Specifies a time range to buffer its topic via the SetBufferLength event.
8. Then receives FLV media data.

If receiving data size exceeds client’s bandwidth, this reports its thing via the Acknowledgement message to its server.

Examples

use std::marker::PhantomData;
use sheave_core::handlers::{
    RtmpContext,
    VecStream
};
use sheave_client::{
    Client,
    handlers::RtmpHandler,
};

let stream = VecStream::default();
let rtmp_context = RtmpContext::default();
let client = Client::new(stream, rtmp_context, PhantomData::<RtmpHandler<VecStream>>);

Trait Implementations

impl<RW: AsyncRead + AsyncWrite + Unpin> AsyncHandler for RtmpHandler<RW>

fn poll_handle( self: Pin<&mut Self>, cx: &mut FutureContext<'_>, rtmp_context: &mut RtmpContext, ) -> Poll<IOResult<()>>

impl<RW: Debug + AsyncRead + AsyncWrite + Unpin> Debug for RtmpHandler<RW>

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

Formats the value using the given formatter.

impl<RW: AsyncRead + AsyncWrite + Unpin> HandlerConstructor<StreamWrapper<RW>> for RtmpHandler<RW>

fn new(stream: Arc<StreamWrapper<RW>>) -> Self