Firelight Technologies FMOD Studio API

Sound::getMusicChannelVolume

Retrieves the volume of a MOD/S3M/XM/IT/MIDI music channel volume.

C++ Syntax

FMOD_RESULT Sound::getMusicChannelVolume(
  int channel,
  float *volume
);

C Syntax

FMOD_RESULT FMOD_Sound_GetMusicChannelVolume(
  FMOD_SOUND *sound,
  int channel,
  float *volume
);

Parameters

channel

MOD/S3M/XM/IT/MIDI music subchannel to retrieve the volume for.

volume

Address of a variable to receive the volume of the channel from 0.0 to 1.0. Default = 1.0.

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

Use Sound::getMusicNumChannels to get the maximum number of music channels in the song.

See Also

• Sound::getMusicNumChannels
• Sound::setMusicChannelVolume

Version 1.03.06 Built on Apr 17, 2014