mi::rtmp::IPlay_event_handler Class Reference

Superclass of all handlers of play events. More...

Inheritance diagram for mi::rtmp::IPlay_event_handler:

Public Member Functions
virtual bool	handle (bool is_start, IStream *stream, IVideo_data **out)=0
	Called on a play or stop event. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x59798950, 0x9a12, 0x48b3, 0x87, 0x14, 0x23, 0xb7, 0x2d, 0xd9, 0xaf, 0x71 >
typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface >	Self
	Own type. More...
typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 >	IID
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x59798950, 0x9a12, 0x48b3, 0x87, 0x14, 0x23, 0xb7, 0x2d, 0xd9, 0xaf, 0x71 >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...

Detailed Description

Superclass of all handlers of play events.

A subclass gets registered via mi::rtmp::IStream::register_play_event_handler() and will be called in the case of a play event which can be a play or stop event.

Member Function Documentation

virtual bool mi::rtmp::IPlay_event_handler::handle ( bool  is_start, IStream *  stream, IVideo_data **  out  )

pure virtual

Called on a play or stop event.

Play/stop events are similar to pause/resume events but are more expensive

The event handler allows to filter play or stop events. If it returns true the render loop for the corresponding stream is affected as follows. If is_start is true the render event handler will be called as often as indicated by the maximum render rate for this stream. If is_start is false the render event handler will not be called anymore. If the play event handler returns false nothing changes.

Play/stop events are similar to pause/resume events but are more expensive w.r.t. the internal state of the RTMP server.

Note

The stream parameter is only valid during the call of the handle() method and cannot be stored (even if proper reference counting is used).

A play handler is optional. If no handler is installed the play command from a video client will be allowed by default.

Parameters

	is_start	true indicates a play event, false indicates a stop event.
	stream	The stream on which to start or stop playing.
[out]	out	Potential initialization/close video frame data can be returned here.

Returns

true if the event should be honored, or false if should be ignored.