# 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

When a pause occurs, the sound that is being played will be stopped. Be aware that even if the pause is restarted, the sound that is played will not begin to play again. After a restart, the next note will begin to play.

## See Also

None.

## Revision History

08/10/2004 Corrected the argument of the NNS_SndPlayerPauseAll function. 06/01/2004 `NNS_SndPlayerPauseByNumber` was changed to `NNS_SndPlayerPauseByPlayerNo`. 04/19/2004 Combined the manuals for `NNS_SndPlayerPause`, `NNS_SndPlayerPauseByNumber`, and `NNS_SndPlayerPauseAll`.

04/01/2004 Initial version.