mi::rswservices::IRtmp_render_handler_factory Class Reference
[RTMP]
Description
Factory class for creating render handlers. Each render loop requires it's own instance of a render handler so a factory class is required to create them. The factory also has documentation methods to describe itself.
Public Member Functions
- virtual IRtmp_render_handler* create_render_handler() const =0
- Creates a render handler.
- virtual Sint32 get_argument_description( nservices::IFactory* factory, const char* argument_name, nservices::IArgument_description* argument) const =0
- Get the description for a particular argument. More...
- virtual Sint32 get_argument_description( nservices::IFactory* factory, Uint32 index, nservices::IArgument_description* argument) const =0
- Get the description for a particular argument by index. More...
- virtual const char* get_description() const =0
- Returns a description of the render handler which this factory creates. More...
- virtual const char* get_name() const =0
- returns the name of the render handler which this factory creates.
Member Functions
- virtual IRtmp_render_handler* mi::rswservices::IRtmp_render_handler_factory::create_render_handler() const [pure virtual]
-
Creates a render handler.
- virtual Sint32 mi::rswservices::IRtmp_render_handler_factory::get_argument_description( nservices::IFactory* factory, const char* argument_name, nservices::IArgument_description* argument) const [pure virtual]
-
Get the description for a particular argument.
Parameters
- factory
- a factory which can be used to create default values
- argument_name
- the name of the argument whose description should be fetched
- argument
- the argument description to fill out
Returns
- NRS_ERROR_NONE success, argument contains a description of argument_name.
- NRS_ERROR_NOT_FOUND argument_name is not a supported argument.
- NRS_ERROR_FAILED general error
- virtual Sint32 mi::rswservices::IRtmp_render_handler_factory::get_argument_description( nservices::IFactory* factory, Uint32 index, nservices::IArgument_description* argument) const [pure virtual]
-
Get the description for a particular argument by index. The command should fill out the argument parameter describing each argument that the command accepts. The method should return NRS_ERROR_NONE if there are more arguments to describe, NRS_ERROR_NOT_FOUND if this is the last argument.
Parameters
- factory
- a factory which can be used to create default values
- index
- argument index
- argument
- the argument description to fill out
Returns
- NRS_ERROR_NONE success, argument contains a description of argument index.
- NRS_ERROR_NOT_FOUND index is greater than the number of supported arguments.
- NRS_ERROR_FAILED general error
- virtual const char* mi::rswservices::IRtmp_render_handler_factory::get_description() const [pure virtual]
-
Returns a description of the render handler which this factory creates.
Returns
description
- virtual const char* mi::rswservices::IRtmp_render_handler_factory::get_name() const [pure virtual]
-
returns the name of the render handler which this factory creates.