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,
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,
int namelen,
FMOD_GUID *guid,
int *systemrate,
FMOD_SPEAKERMODE *speakermode,
int *speakermodechannels
);
C# Syntax
RESULT System.getDriverInfo(
int id,
StringBuilder name,
int namelen,
out Guid guid,
out int systemrate,
out SPEAKERMODE speakermode,
out int speakermodechannels
);
JavaScript Syntax
System.getDriverInfo(
id,
name, // writes value to name.val
guid, // writes value to guid.val
systemrate, // writes value to systemrate.val
speakermode, // writes value to speakermode.val
speakermodechannels // writes value to speakermodechannels.val
);
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 encoded in a UTF-8 string. Optional. Specify 0 or NULL to ignore.
- namelen
- Length in bytes of the target buffer to receive 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
- 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.
Remarks
JavaScript only :
Note: For the "name" parameter, the maximum string length is 512.
See Also
Version 1.10.03 Built on Feb 1, 2018