ScummVM API documentation
NullMusicPlugin Class Reference
Inheritance diagram for NullMusicPlugin:
MusicPluginObject PluginObject

Public Member Functions

virtual const char * getName () const
 
virtual const char * getId () const
 
virtual MusicDevices getDevices () const
 
Common::Error createInstance (MidiDriver **mididriver, MidiDriver::DeviceHandle=0) const
 
- Public Member Functions inherited from MusicPluginObject
virtual bool checkDevice (MidiDriver::DeviceHandle) const
 

Member Function Documentation

◆ getName()

virtual const char* NullMusicPlugin::getName ( ) const
virtual

Returns the name of the plugin.

Implements PluginObject.

◆ getId()

virtual const char* NullMusicPlugin::getId ( ) const
inlinevirtual

Returns a unique string identifier which will be used to save the selected MIDI driver to the config file.

Implements MusicPluginObject.

◆ getDevices()

virtual MusicDevices NullMusicPlugin::getDevices ( ) const
virtual

Returns a list of the available devices.

Implements MusicPluginObject.

◆ createInstance()

Common::Error NullMusicPlugin::createInstance ( MidiDriver **  mididriver,
MidiDriver::DeviceHandle  = 0 
) const
virtual

Tries to instantiate a MIDI Driver instance based on the device previously detected via MidiDriver::detectDevice()

Parameters
mididriverPointer to a pointer which the MusicPluginObject sets to the newly create MidiDriver, or 0 in case of an error
devPointer to a device to be used then creating the driver instance. Default value of zero for driver types without devices.
Returns
a Common::Error describing the error which occurred, or kNoError

Implements MusicPluginObject.


The documentation for this class was generated from the following file: