NNS_SndPlayerPause*

Syntax

#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 Sound handle pointer.
playerNo Player number.
flag Pauses when TRUE, restarts when FALSE.

Return Values

None.

Description

Pauses or restarts the sequence.

With the NNS_SndPlayerPause function, the sequence that is bound to the sound handle handle is paused or restarted. This function does not perform any action if the sound handle is invalid.

The NNS_SndPlayerPauseByPlayerNo function specifies the player number playerNo and pauses or restarts the sequence that is currently being played.

The NNS_SndPlayerPauseAll function pauses or restarts all sequences being played.

The flag argument 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

When you pause the sequence, the channel that is playing sound is forcibly stopped (not paused). Thus, when you release the pause on the sequence, the sound channel does 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 Changed NNS_SndPlayerPauseByNumber to NNS_SndPlayerPauseByPlayerNo.
2004/04/19 Combined the manuals for NNS_SndPlayerPause, NNS_SndPlayerPauseByNumber, and NNS_SndPlayerPauseAll.
2004/04/01 Initial version.

CONFIDENTIAL