Sound::release

FMOD Studio API

Firelight Technologies FMOD Studio API

Sound::release

Frees a sound object.

C++ Syntax

FMOD_RESULT Sound::release();

C Syntax

FMOD_RESULT FMOD_Sound_Release(FMOD_SOUND *sound);

C# Syntax

RESULT Sound.release();

JavaScript Syntax

Sound.release();

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

This will free the sound object and everything created under it.

If this is a stream that is playing as a subsound of another parent stream, then if this is the currently playing subsound, the whole stream will stop.

Note - This function will block if it was opened with FMOD_NONBLOCKING and hasn't finished opening yet.

See Also




Version 1.10.03 Built on Feb 1, 2018