Sound::getMode

FMOD Studio API

Firelight Technologies FMOD Studio API

Sound::getMode

Retrieves the mode bits set by the codec and the user when opening the sound.

C++ Syntax

FMOD_RESULT Sound::getMode(
  FMOD_MODE *mode
);

C Syntax

FMOD_RESULT FMOD_Sound_GetMode(
  FMOD_SOUND *sound,
  FMOD_MODE *mode
);

C# Syntax

RESULT Sound.getMode(
  out MODE mode
);

JavaScript Syntax

Sound.getMode(
  mode                             // writes value to mode.val
);

Parameters

mode
Address of a variable that receives the current mode for this sound.

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