NNS_SndPlayerPause*

C Specification

#include <nnsys/snd.h>
void NNS_SndPlayerPause( NNSSndHandle* handle, BOOL flag );
void NNS_SndPlayerPauseByPlayerNo( int playerNo, BOOL flag );
void NNS_SndPlayerPauseAll( BOOL flag );

Arguments

handle The sound handle pointer.
playerNo The Player number.
flag Pauses when TRUE, restarts when FALSE.

Return Values

None.

Description

Pauses sequence or re-starts sequence.

The sequence that is bound to the Sound Handle is paused or restarted. This function does not perform any action if the stream handle is invalid.

NNS_SndPlayerPauseByPlayerNo pauses or restarts the sequence that is being played and specifies the playerNo.

NNS_SndPlayerPauseAll pauses or restarts all sequences being played.

flag specifies whether to pause or restart. If the status does not change, such as when a sequence is paused while it is already paused, this function will not perform any action.

Note

Be aware that when you pause the sequence, the channel that is playing sound is forcibly stopped (i.e., not paused, but stopped). Thus, when you release the pause on the sequence, the sound channel will not resume from where it left off. (The hardware specifications do not allow you to pause the channel.)

See Also

None.

Revision History

2005/09/12 Revised the precaution note.
2004/08/10 Corrected the argument of the NNS_SndPlayerPauseAll function. 2004/06/01 NNS_SndPlayerPauseByNumber was changed to NNS_SndPlayerPauseByPlayerNo. 2004/04/19 Combined the manuals for NNS_SndPlayerPause, NNS_SndPlayerPauseByNumber, and NNS_SndPlayerPauseAll.
2004/04/01 Initial version


CONFIDENTIAL