NNS_SndPlayerSetInitialVolume

Syntax

#include <nnsys/snd.h>
void NNS_SndPlayerSetInitialVolume(
        NNSSndHandle* handle,
        int volume );

Arguments

handle The sound handle pointer.
volume Initial volume value. Takes a value between 0 and 127.

Return Values

None.

Description

Sets the initial volume value of the sequence.

This function sets the initial volume value of the sequence bound to the sound handle, handle. This function does not perform any action if the stream handle is invalid.

The default value for volume is the maximum of 127. This value affects all sequence tracks.

Note

This function is called inside of the NNS_SndArcPlayerStartSeq* function and the NNS_SndArcPlayerStartSeqArc* function. If this function is called again, the set values will be overwritten. To avoid overwriting these values, use a function such as NNS_SndPlayerSetVolume.

See Also

NNS_SndArcPlayerStartSeq*, NNS_SndArcPlayerStartSeqArc*, NNS_SndPlayerSetVolume

Revision History

2004/06/01 Initial version.


CONFIDENTIAL