Firelight Technologies FMOD Studio API

System::getSpeakerModeChannels

Gets the a speaker mode's channel count.

C++ Syntax

FMOD_RESULT System::getSpeakerModeChannels(
  FMOD_SPEAKERMODE mode,
  int *channels
);

C Syntax

FMOD_RESULT FMOD_System_GetSpeakerModeChannels(
  FMOD_SYSTEM *system,
  FMOD_SPEAKERMODE mode,
  int *channels
);

C# Syntax

RESULT System.getSpeakerModeChannels(
  SPEAKERMODE mode,
  out int channels
);

JavaScript Syntax

System.getSpeakerModeChannels(
  mode,                            
  channels                         // writes value to channels.val
);

Parameters

mode

channels

Address of a variable that receives the number of channels.

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.

Version 1.10.03 Built on Feb 1, 2018