Firelight Technologies FMOD Studio API

System::getDriverInfo

Retrieves identification information about a sound device specified by its index, and specific to the output mode set with System::setOutput.

C++ Syntax

FMOD_RESULT System::getDriverInfo(
  int id,
  char *name,
  short *nameW,
  int namelen,
  FMOD_GUID *guid,
  int *systemrate,
  FMOD_SPEAKERMODE *speakermode,
  int *speakermodechannels
);

C Syntax

FMOD_RESULT FMOD_System_GetDriverInfo(
  FMOD_SYSTEM *system,
  int id,
  char *name,
  short *nameW,
  int namelen,
  FMOD_GUID *guid,
  int *systemrate,
  FMOD_SPEAKERMODE *speakermode,
  int *speakermodechannels
);

Parameters

id

Index of the sound driver device. The total number of devices can be found with System::getNumDrivers.

name

Address of a variable that receives the name of the device. Optional. Specify 0 or NULL to ignore.

nameW

Address of a variable that receives the name of the device in wide char format. Specify 0 or NULL to ignore.

namelen

Length in bytes (shorts for wide char) of the target buffer to receieve the string. Required if name or nameW parameter is not NULL.

guid

Address of a variable that receives the GUID that uniquely identifies the device. Optional. Specify 0 or NULL to ignore.

systemrate

Address of a variable that receives the sample rate this device operates at. Optional. Specify 0 or NULL to ignore.

speakermode

Address of a variable that receives the speaker setup this device is currently using. Optional. Specify 0 or NULL to ignore.

speakermodechannels

Address of a variable that receives the number of channels in the current speaker setup. Optional. Specify 0 or NULL to ignore.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

See Also

• System::getNumDrivers
• System::setOutput

Version 1.03.06 Built on Apr 17, 2014