OpenViBE Documentation 3.6.0
OpenViBE::Plugins::StreamCodecs::CEBMLBaseEncoderDesc Class Reference
+ Inheritance diagram for OpenViBE::Plugins::StreamCodecs::CEBMLBaseEncoderDesc:

Public Member Functions

bool getAlgorithmPrototype (Kernel::IAlgorithmProto &prototype) const override
 Gets the prototype for this algorithm. More...
 
- Public Member Functions inherited from OpenViBE::Plugins::IPluginObjectDesc
virtual void release ()=0
 Informs the plugin description it won't be used any more. More...
 
virtual CIdentifier getCreatedClass () const =0
 Gives a tip on what this plugin descriptor is able to create. More...
 
virtual CIdentifier getCreatedClassIdentifier () const
 
virtual IPluginObjectcreate ()=0
 Creates the plugin object itself. More...
 
virtual CString getName () const
 Gets the plugin name. More...
 
virtual CString getAuthorName () const
 Gets the author name for this plugin. More...
 
virtual CString getAuthorCompanyName () const
 Gets the author company name for this plugin. More...
 
virtual CString getShortDescription () const
 Gets a short description of the plugin. More...
 
virtual CString getDetailedDescription () const
 Gets a detailed description of the plugin. More...
 
virtual CString getCategory () const
 Gets a basic category of the plugin. More...
 
virtual CString getVersion () const
 Gets the version of the plugin. More...
 
virtual bool hasFunctionality (const EPluginFunctionality functionality) const
 Tests whether the plugin has a given functionality. More...
 
- Public Member Functions inherited from OpenViBE::IObject
virtual CIdentifier getClassIdentifier () const =0
 Returns the final class identifier of the concrete class. More...
 
virtual bool isDerivedFromClass (const CIdentifier &classId) const
 Checks if this object is compatible with a class identifier. More...
 
virtual bool acceptVisitor (IObjectVisitor &visitor)
 Requests this object to accept a visitor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from OpenViBE::IObject
virtual ~IObject ()
 

Member Function Documentation

◆ getAlgorithmPrototype()

bool OpenViBE::Plugins::StreamCodecs::CEBMLBaseEncoderDesc::getAlgorithmPrototype ( Kernel::IAlgorithmProto prototype) const
inlineoverridevirtual

Gets the prototype for this algorithm.

Parameters
prototype[out] : the prototype to fill
Returns
true in case of success false in other cases.

When this function is called by the OpenViBE platform, the plugin descriptor should fill in the structure to let the OpenViBE platform know what the algorithm should look like (inputs/outputs/triggers).

See also
IAlgorithmProto

Implements OpenViBE::Plugins::IAlgorithmDesc.

Reimplemented in OpenViBE::Plugins::StreamCodecs::CExperimentInfoEncoderDesc, OpenViBE::Plugins::StreamCodecs::CFeatureVectorEncoderDesc, OpenViBE::Plugins::StreamCodecs::CSignalEncoderDesc, OpenViBE::Plugins::StreamCodecs::CSpectrumEncoderDesc, OpenViBE::Plugins::StreamCodecs::CStimulationEncoderDesc, and OpenViBE::Plugins::StreamCodecs::CStreamedMatrixEncoderDesc.