System::getDriver

FMOD Studio API

Firelight Technologies FMOD Studio API

System::getDriver

Returns the currently selected driver number. Drivers are enumerated when selecting a driver with System::setDriver or other driver related functions such as System::getNumDrivers or System::getDriverInfo.

C++ Syntax

FMOD_RESULT System::getDriver(
  int *driver
);

C Syntax

FMOD_RESULT FMOD_System_GetDriver(
  FMOD_SYSTEM *system,
  int *driver
);

C# Syntax

RESULT System.getDriver(
  out int driver
);

JavaScript Syntax

System.getDriver(
  driver                           // writes value to driver.val
);

Parameters

driver
Address of a variable that receives the currently selected driver ID. 0 = primary or main sound device as selected by the operating system settings.

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




Version 1.10.03 Built on Feb 1, 2018