mi::rtmp::IPlay_event_handler Class Reference
[RTMP server]
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.
Public Member Functions
- virtual bool handle( bool is_start, IStream* stream, neuraylib::IVideo_data** out) =0
- Called on a play or stop event. More...
Member Functions
- virtual bool mi::rtmp::IPlay_event_handler::handle( bool is_start, IStream* stream, neuraylib::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
- Potential initialization/close video frame data can be returned here.
Returns
true if the event should be honored, or false if should be ignored.
-