Member Functions

virtual void mi::​rswservices::​IRtmp_render_loop::cancel_render( Sint32 cancel_level) [pure virtual]

Allows to cancel the render currently being performed by this this render loop. 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 const IData* mi::​rswservices::​IRtmp_render_loop::get_argument( const char* name) const [pure virtual]

Gets the value for argument called name. If returns NULL then this either indicates that the argument name does not exist or that it's value has been supplied as NULL. Use the iterative version of get_argument to distinguish the two conditions.

Parameters

name

the argument name.

Returns

the value.

template< class T>

const T* mi::​rswservices::​IRtmp_render_loop::get_argument( const char* name) const [inline]

Gets the value for argument called name. If returns NULL then this either indicates that the argument name does not exist or that it's value has been supplied as NULL. Use the iterative version of get_argument to distinguish the two conditions.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface(const Uuid&) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.

Parameters

name

the argument name

Returns

the value or NULL if the argument doesn't exists or is not of type T.

virtual Sint32 mi::​rswservices::​IRtmp_render_loop::get_argument( Uint32 index, const char** name, const IData** value) const [pure virtual]

Gets the argument name and value at index.

Parameters

index

the index of the argument, start at 0 and increment until returns mi::nservices::NRS_ERROR_NOT_FOUND

name

receives the name of the argument

value

receives the value of the argument

Returns

• NRS_ERROR_NONE success, name and value contains the argument name and it's value.
• NRS_ERROR_NOT_FOUND index is greater than the number of supplied arguments.
• NRS_ERROR_FAILED general error

virtual const char* mi::​rswservices::​IRtmp_render_loop::get_name() const [pure virtual]

Returns the name of this render loop.

virtual Uint32 mi::​rswservices::​IRtmp_render_loop::get_num_arguments() const [pure virtual]

the number of arguments provided to the loop

Returns

number of arguments

virtual const char* mi::​rswservices::​IRtmp_render_loop::get_render_handler_name() const [pure virtual]

Returns the name of the render handler used by this render loop.

virtual const char* mi::​rswservices::​IRtmp_render_loop::get_scene_name() const [pure virtual]

Returns the name of the scene rendered by this render loop.

virtual const char* mi::​rswservices::​IRtmp_render_loop::get_scope_name() const [pure virtual]

Returns the name of the scope used by this render loop. If NULL then uses the global scope.

virtual Sint32 mi::​rswservices::​IRtmp_render_loop::set_argument( const char* name, const IData* value) [pure virtual]

Sets an argument on this render loop.

Parameters

name

the name of the argument to set.

value

the value of the argument.

Returns

• NRS_ERROR_NONE success
• NRS_ERROR_INVALID_PARAMETERS name is NULL or an empty string.
• NRS_ERROR_INVALID_OPERATION name is a documented parameter however value cannot be converted to the described type.
• NRS_ERROR_FAILED general error