DiCE API nvidia_logo_transpbg.gif Up
mi::neuraylib::IVideo_plugin Class Referenceabstract

Abstract interface for video encoder plugins. More...

#include <ivideo_plugin.h>

Inheritance diagram for mi::neuraylib::IVideo_plugin:

Public Member Functions

virtual const char * get_name () const =0
 Returns the name of the plugin. More...
 
virtual bool init (IPlugin_api *plugin_api)=0
 Initializes the plugin. More...
 
virtual bool exit (IPlugin_api *plugin_api)=0
 De-initializes the plugin. More...
 
virtual IVideo_encodercreate_video_encoder () const =0
 Creates a new encoder for a video stream. More...
 
virtual IVideo_decodercreate_video_decoder () const =0
 Creates a new decoder for a video stream. More...
 
- Public Member Functions inherited from mi::base::Plugin
virtual Sint32 get_plugin_system_version () const
 Returns the version of the plugin system used to compile this. More...
 
virtual const char * get_name () const =0
 Returns the name of the plugin. More...
 
virtual const char * get_type () const =0
 Returns the type of the plugin. More...
 
virtual Sint32 get_version () const
 Returns the version number of the plugin. More...
 
virtual const char * get_compiler () const
 Returns the compiler used to compile the plugin. More...
 
virtual void release ()=0
 Destroys the plugin instance. More...
 
virtual const char * get_string_property (Sint32 index, const char **value)
 Returns a plugin property. More...
 

Detailed Description

Abstract interface for video encoder plugins.

Video plugins need to return MI_NEURAY_VIDEO_PLUGIN_TYPE in mi::base::Plugin::get_type().

Member Function Documentation

 create_video_decoder()

virtual IVideo_decoder * mi::neuraylib::IVideo_plugin::create_video_decoder ( ) const
pure virtual

Creates a new decoder for a video stream.

 create_video_encoder()

virtual IVideo_encoder * mi::neuraylib::IVideo_plugin::create_video_encoder ( ) const
pure virtual

Creates a new encoder for a video stream.

 exit()

virtual bool mi::neuraylib::IVideo_plugin::exit ( IPlugin_api plugin_api)
pure virtual

De-initializes the plugin.

Parameters
plugin_apiProvides access to API components available for plugins.
Returns
true in case of success, and false otherwise.

 get_name()

virtual const char * mi::neuraylib::IVideo_plugin::get_name ( ) const
pure virtual

Returns the name of the plugin.

For video plugins, typically the name of the video codec is used, for example, "x264".

Note
This method from mi::base::Plugin is repeated here only for documentation purposes.

Implements mi::base::Plugin.

 init()

virtual bool mi::neuraylib::IVideo_plugin::init ( IPlugin_api plugin_api)
pure virtual

Initializes the plugin.

Parameters
plugin_apiProvides access to API components available for plugins.
Returns
true in case of success, and false otherwise.