RealityServer Web Services API Programmer's Manual

mi::rswservices::IRtmp_render_context Class Reference

[RTMP]

Description

RTMP render context. This class is supplied to an rtmp render handler to allow it to perform a render.

Public Member Functions

virtual const IConfiguration* get_configuration() const =0
Returns the RealityServer Web Services configuration. More...
virtual nservices::IConverter* get_converter() const =0
Returns a type converter. More...
virtual nservices::IEvent_context* get_event_context() const =0
Gets an event context. More...
virtual nservices::IFactory* get_factory() const =0
Returns a factory, may be used to create neuray services data or other required classes. More...
virtual neuraylib::IPlugin_api* get_plugin_api() const =0
Get the neuray IPlugin_api. More...
virtual nservices::IScene* get_scene() const =0
Returns the scene to be rendered.
virtual neuraylib::ITransaction* get_transaction() =0
Returns a transaction into the render scope.
virtual neuraylib::ITransaction* get_user_state() =0
Gets a transaction into the user state. More...

Member Functions

virtual const IConfiguration* mi::​rswservices::​IRtmp_render_context::get_configuration() const [pure virtual]

Returns the RealityServer Web Services configuration.

Returns

the configuration

virtual nservices::IConverter* mi::​rswservices::​IRtmp_render_context::get_converter() const [pure virtual]

Returns a type converter. If an argument is not the expected data type then the converter can be used to try and convert it to the expected type. It can also be used to convert array and object elements to their expected types.

Returns

the type converter

virtual nservices::IEvent_context* mi::​rswservices::​IRtmp_render_context::get_event_context() const [pure virtual]

Gets an event context. The command can use this to trigger any necessary events. In particular pre and post render events should be triggered, this is not done by the services core.

Note:

the "rtmp_context" attachment will not be available on the attachments exposed by the returned event context.

Returns

an event context

virtual nservices::IFactory* mi::​rswservices::​IRtmp_render_context::get_factory() const [pure virtual]

Returns a factory, may be used to create neuray services data or other required classes.

Returns

a factory

virtual neuraylib::IPlugin_api* mi::​rswservices::​IRtmp_render_context::get_plugin_api() const [pure virtual]

Get the neuray IPlugin_api. Provides direct access to the neuray library.

Returns

the plugin api

virtual nservices::IScene* mi::​rswservices::​IRtmp_render_context::get_scene() const [pure virtual]

Returns the scene to be rendered.

virtual neuraylib::ITransaction* mi::​rswservices::​IRtmp_render_context::get_transaction() [pure virtual]

Returns a transaction into the render scope.

virtual neuraylib::ITransaction* mi::​rswservices::​IRtmp_render_context::get_user_state() [pure virtual]

Gets a transaction into the user state.

Returns

the state transaction or NULL if no state exists