ScummVM API documentation
MIDI drivers

Description

API for managing MIDI drivers.

Classes

class  MidiDriver_BASE
 
class  MidiDriver
 
class  MidiChannel
 

Enumerations

enum  MusicType {
  MT_INVALID = -1 , MT_AUTO = 0 , MT_NULL , MT_PCSPK ,
  MT_PCJR , MT_CMS , MT_ADLIB , MT_C64 ,
  MT_AMIGA , MT_APPLEIIGS , MT_TOWNS , MT_PC98 ,
  MT_SEGACD , MT_MACINTOSH , MT_GM , MT_MT32 ,
  MT_GS , MT_MT540 , MT_CT460
}
 
enum  MidiDriverFlags {
  MDT_NONE = 0 , MDT_PCSPK = 1 << 0 , MDT_CMS = 1 << 1 , MDT_PCJR = 1 << 2 ,
  MDT_ADLIB = 1 << 3 , MDT_C64 = 1 << 4 , MDT_AMIGA = 1 << 5 , MDT_APPLEIIGS = 1 << 6 ,
  MDT_TOWNS = 1 << 7 , MDT_PC98 = 1 << 8 , MDT_SEGACD = 1 << 9 , MDT_MIDI = 1 << 10 ,
  MDT_PREFER_MT32 = 1 << 11 , MDT_PREFER_GM = 1 << 12 , MDT_PREFER_FLUID = 1 << 13 , MDT_MACINTOSH = 1 << 14 ,
  MDT_SUPPLIED_SOUND_FONT = 1 << 15
}
 
enum  MidiDriverCheckFlags { MDCK_NONE = 0 , MDCK_SUPPLIED_SOUND_FONT = 1 << 0 , MDCK_AUTO = 1 << 1 }
 

Enumeration Type Documentation

◆ MusicType

enum MusicType

Music types that music drivers can implement and engines can rely on.

◆ MidiDriverFlags

A set of flags to be passed to detectDevice() which can be used to specify what kind of music driver is preferred / accepted.

The flags (except for MDT_PREFER_MT32 and MDT_PREFER_GM) indicate whether a given driver type is acceptable. E.g. the TOWNS music driver could be returned by detectDevice if and only if MDT_TOWNS is specified.

MDT_PREFER_MT32 and MDT_PREFER_GM indicate the MIDI device type to use when no device is selected in the music options, or when the MIDI device selected does not match the requirements of a game engine. With these flags, more priority is given to an MT-32 device, or a GM device respectively.