neuray API Programmer's Manual

mi::neuraylib::IVideo_plugin Class Reference

[Extensions and Plugins]

Description

Abstract interface for video encoder plugins. Video plugins need to return MI_NEURAY_VIDEO_PLUGIN_TYPE in mi::base::Plugin::get_type().

Public Member Functions

virtual IVideo_decodercreate_video_decoder() const =0
Creates a new decoder for a video stream.
virtual IVideo_encodercreate_video_encoder() const =0
Creates a new encoder for a video stream.
virtual bool  exit( IPlugin_api* plugin_api) =0
De-initializes the plugin. More...
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...

Member Functions

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

Creates a new decoder for a video stream.

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

Creates a new encoder for a video stream.

virtual bool mi::​neuraylib::​IVideo_plugin::exit( IPlugin_api* plugin_api) [pure virtual]

De-initializes the plugin.

Parameters

plugin_api
Provides access to API components available for plugins.

Returns

true in case of success, and false otherwise.

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.

virtual bool mi::​neuraylib::​IVideo_plugin::init( IPlugin_api* plugin_api) [pure virtual]

Initializes the plugin.

Parameters

plugin_api
Provides access to API components available for plugins.

Returns

true in case of success, and false otherwise.