neuray API Programmer's Manual

mi::rtmp::IPause_event_handler Class Reference

[RTMP server]

Description

Superclass of all handlers of pause events. A subclass gets registered via mi::rtmp::IStream::register_pause_event_handler() and will be called in the case of a pause event which can be either pause or resume.

Public Member Functions

virtual bool  handle( bool is_pause, IStream* stream) =0
Called on a pause or resume event. More...

Member Functions

virtual bool mi::​rtmp::​IPause_event_handler::handle( bool is_pause, IStream* stream) [pure virtual]

Called on a pause or resume event. The event handler allows to filter pause or resume events. If it returns true the render loop for the corresponding stream is affected as follows. If is_pause is true the render event handler will not be called anymore. If is_pause is false the render event handler will again be called as often as indicated by the maximum render rate for the stream. If the pause event handler returns false nothing changes.

Pause/resume events are similar to play/stop events but are less 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).

Parameters

is_pause
true indicates a pause event, false indicates a resume event.
stream
The stream on which to pause or resume playing.

Returns

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