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
);
C# Syntax
RESULT Sound.getMusicChannelVolume(
int channel,
out float volume
);
JavaScript Syntax
Sound.getMusicChannelVolume(
channel,
volume // writes value to volume.val
);
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
Version 1.10.03 Built on Feb 1, 2018