mi::rswservices::IRtmp_render_handler Class Reference
[RTMP]
Description
Implements an RTMP render handler. These handlers are called at the core of the RTMP render loop and allow users to provide their own rendering capabilities.
Public Member Functions
- virtual void cancel_render( Sint32 cancel_level) =0
- Allows to cancel the render currently being performed by this this render handler. More...
- virtual mi::neuraylib::ICanvas* render( IRtmp_render_context* context) =0
- Called whenever a render is required by the RTMP server. More...
Member Functions
- virtual void mi::rswservices::IRtmp_render_handler::cancel_render( Sint32 cancel_level) [pure virtual]
-
Allows to cancel the render currently being performed by this this render handler. Note that the render method should still return a canvas on cancel otherwise the current render loop will exit.
It is not guaranteed how much time it takes until the rendering is actually finished. Note, that this function can be called by a different thread than the one currently doing the rendering.
Parameters
- cancel_level
- The intention of the cancel level is to specify how fast the rendering should be finished, but currently this value is not yet taken into account.
- virtual mi::neuraylib::ICanvas* mi::rswservices::IRtmp_render_handler::render( IRtmp_render_context* context) [pure virtual]
-
Called whenever a render is required by the RTMP server.
Parameters
- context
- the context in which the render should occur
Returns
an ICanvas containing the render result. If NULL is returned then all streams that are using this render handler are terminated.