Firelight Technologies FMOD Studio API

System::getRecordDriverInfo

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::getRecordDriverInfo(
  int id,
  char *name,
  short *nameW,
  int namelen,
  FMOD_GUID *guid,
  int *systemrate,
  FMOD_SPEAKERMODE *speakermode,
  int *speakermodechannels
);

C Syntax

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

Parameters

id

Index into the enumerated list of record devices up to the value returned by System::getRecordNumDrivers.

name

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

nameW

Address of a variable that recieves the name of the recording device in Unicode. Optional. Specify 0 or NULL to ignore.

namelen

Length in bytes of the target buffer to receieve the string. Required if name 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

Default frequency in hz of the recording device. Optional. Specify 0 or NULL to ignore.

speakermode

Default speaker mode of the recording device. Optional. Specify 0 or NULL to ignore.

speakermodechannels

Default speaker count (that should match the speakermode) of the recording device. 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::setOutput
• System::getRecordNumDrivers

Version 1.03.06 Built on Apr 17, 2014