Firelight Technologies FMOD Studio API

FMOD_OUTPUT_GETDRIVERINFO_CALLBACK

Called when the user calls System::getDriverInfo.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_OUTPUT_GETDRIVERINFO_CALLBACK(
  FMOD_OUTPUT_STATE *output_state,
  int id,
  char *name,
  int namelen,
  FMOD_GUID *guid,
  int *systemrate,
  FMOD_SPEAKERMODE *speakermode,
  int *speakermodechannels
);

Parameters

output_state

Pointer to the plugin state. The user can use this variable to access runtime plugin specific variables and plugin writer user data.

id

Index into the total number of outputs possible, provided by the FMOD_OUTPUT_GETNUMDRIVERS_CALLBACK callback.

name

Address of a variable to receive the driver name, encoded as a UTF-8 string, relevant to the index passed in. Fill this in.

namelen

Length of name buffer being passed in by the user.

guid

Pointer to a GUID structure for the user to fill in. A unique indentifier here can be used to identify a driver rather than the string.

systemrate

The rate the output device prefers. Leave 0 to remain flexible.

speakermode

The speaker mode the output device prefers. Leave FMOD_SPEAKERMODE_DEFAULT to remain flexible.

speakermodechannels

The speaker mode associated channels the output device prefers. Leave at 0 to remain flexible. More relevant with FMOD_SPEAKERMODE_RAW. This will be ignored with other speaker modes.

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.

Remarks

Remember to return FMOD_OK at the bottom of the function, or an appropriate error code from FMOD_RESULT.

See Also

• FMOD_OUTPUT_DESCRIPTION
• FMOD_OUTPUT_STATE
• System::getDriverInfo
• System::getNumDrivers
• FMOD_OUTPUT_GETNUMDRIVERS_CALLBACK

Version 1.10.03 Built on Feb 1, 2018