alCSPGetVol, n_alCSPGetVol

Returns the overall sequence volume

Syntax

#include <libaudio.h>     /* libaudio.h */
s16 alCSPGetVol(    ALCSPlayer *seqp);

#include <n_libaudio.h>     /* n_libaudio.h */
s16 n_alCSPGetVol(N_ALCSPlayer *seqp);

Arguments

seqp

Pointer to the compressed MIDI sequence player

Description

alCSPGetVol returns the overall sequence volume at the end of the last call to alAudioFrame. A value of 0x7fff indicates full volume and a value of 0 indicates off. Negative values are not allowed.

Because messages generated by alCSPSetVol are not processed until the next call of alAudioFrame, multiple calls to alCSPGetVol within the same frame will not reflect the new value.

For details on n_audio library, see "Chapter 28: n_audio library" in the N64 Programming Manual.

Note

Individual channels also have volume levels that you can obtain by using the alCSPGetChlVol function.

See Also

alCSPSetVol, alCSPGetChlVol, and alCSeqPlayer

Revision History

1999/04/30 Changed Format