Firelight Technologies FMOD Studio API

Channel::getCurrentSound

Retrieves the currently playing sound for this channel.

C++ Syntax

FMOD_RESULT Channel::getCurrentSound(
  FMOD::Sound **sound
);

C Syntax

FMOD_RESULT FMOD_Channel_GetCurrentSound(
  FMOD_CHANNEL *channel,
  FMOD_SOUND **sound
);

C# Syntax

RESULT Channel.getCurrentSound(
  out Sound sound
);

JavaScript Syntax

Channel.getCurrentSound(
  sound                            // writes value to sound.val
);

Parameters

sound

Address of a variable that receives a pointer to the currently playing sound for this channel.

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

If a sound is not playing the returned pointer will be 0 or NULL.

See Also

• System::playSound

Version 1.10.03 Built on Feb 1, 2018