ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

MusicPluginObject Class Reference

A MusicPluginObject is essentially a factory for MidiDriver instances with the added ability of listing the available devices and their capabilities. More...

#include <musicplugin.h>

Inheritance diagram for MusicPluginObject:
Collaboration diagram for MusicPluginObject:

List of all members.

Public Member Functions

virtual ~MusicPluginObject ()
virtual const char * getId () const =0
 Returns a unique string identifier which will be used to save the selected MIDI driver to the config file.
virtual MusicDevices getDevices () const =0
 Returns a list of the available devices.
virtual bool checkDevice (MidiDriver::DeviceHandle) const
 Checks whether a device can actually be used.
virtual Common::Error createInstance (MidiDriver **mididriver, MidiDriver::DeviceHandle=0) const =0
 Tries to instantiate a MIDI Driver instance based on the device previously detected via MidiDriver::detectDevice().

Detailed Description

A MusicPluginObject is essentially a factory for MidiDriver instances with the added ability of listing the available devices and their capabilities.

Definition at line 78 of file musicplugin.h.


Constructor & Destructor Documentation

virtual MusicPluginObject::~MusicPluginObject (  )  [inline, virtual]

Definition at line 80 of file musicplugin.h.


Member Function Documentation

virtual bool MusicPluginObject::checkDevice ( MidiDriver::DeviceHandle   )  const [inline, virtual]

Checks whether a device can actually be used.

Currently this is only implemented for the MT-32 emulator to check whether the required rom files are present.

Definition at line 98 of file musicplugin.h.

virtual Common::Error MusicPluginObject::createInstance ( MidiDriver **  mididriver,
MidiDriver::DeviceHandle  = 0 
) const [pure virtual]

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

Parameters:
mididriver Pointer to a pointer which the MusicPluginObject sets to the newly create MidiDriver, or 0 in case of an error
dev Pointer 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

Implemented in AlsaMusicPlugin, AdLibEmuMusicPlugin, and NullMusicPlugin.

virtual MusicDevices MusicPluginObject::getDevices (  )  const [pure virtual]

Returns a list of the available devices.

Implemented in AlsaMusicPlugin, AdLibEmuMusicPlugin, AutoMusicPlugin, NullMusicPlugin, and CMSMusicPlugin.

virtual const char* MusicPluginObject::getId (  )  const [pure virtual]

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

Implemented in AlsaMusicPlugin, AdLibEmuMusicPlugin, AutoMusicPlugin, NullMusicPlugin, and CMSMusicPlugin.


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


Generated on Sat Jan 12 2019 05:03:22 for ResidualVM by doxygen 1.7.1
curved edge   curved edge