nw::snd::SoundArchivePlayer::GetFreeStreamSoundCount Member Function

Syntax

#include <nw/snd/snd_SoundArchivePlayer.h>

int GetFreeStreamSoundCount() const;

Arguments

None.

Return Values

Returns the remaining number of playable stream sounds.

Description

Retrieves the remaining number of playable stream sounds.

If an attempt is made to play a new stream sound when the remaining number is zero, the sound with the lowest player priority among the sounds already playing stops. If the player priority of the new sound is lower, the playback fails.

The total number of playable stream sounds is included in the sound archive, which is configured with the sound archive player using Initialize.

See Also

Initialize

Revision History

2010/02/01
Corrected text in line with function name change from Setup to Initialize.
2010/01/15
Initial version.

CONFIDENTIAL