Sound::getMusicNumChannels

FMOD Studio API

Firelight Technologies FMOD Studio API

Sound::getMusicNumChannels

Gets the number of music channels inside a MOD/S3M/XM/IT/MIDI file.

C++ Syntax

FMOD_RESULT Sound::getMusicNumChannels(
  int *numchannels
);

C Syntax

FMOD_RESULT FMOD_Sound_GetMusicNumChannels(
  FMOD_SOUND *sound,
  int *numchannels
);

C# Syntax

RESULT Sound.getMusicNumChannels(
  out int numchannels
);

JavaScript Syntax

Sound.getMusicNumChannels(
  numchannels                      // writes value to numchannels.val
);

Parameters

numchannels
Number of music channels used in the song.

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