Firelight Technologies FMOD Studio API

System::getChannelsPlaying

Retrieves the number of currently playing channels.

C++ Syntax

FMOD_RESULT System::getChannelsPlaying(
  int *channels,
  int *realchannels
);

C Syntax

FMOD_RESULT FMOD_System_GetChannelsPlaying(
  FMOD_SYSTEM *system,
  int *channels,
  int *realchannels
);

C# Syntax

RESULT System.getChannelsPlaying(
  out int channels,
  out int realchannels
);

JavaScript Syntax

System.getChannelsPlaying(
  channels,                        // writes value to channels.val
  realchannels                     // writes value to realchannels.val
);

Parameters

channels

Address of a variable that receives the number of playing channels (both real and virtual). Specify 0 or NULL to ignore.

realchannels

Address of a variable that receives the number of playing non-virtual channels. 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

• Channel::isPlaying
• Channel::isVirtual

Version 1.10.03 Built on Feb 1, 2018