NNS_SndArcStrmStop

Syntax

#include <nnsys/snd.h>
void NNS_SndArcStrmStop( NNSSndStrmHandle* handle, int fadeFrame );

Arguments

handle Pointer to a stream handle.
fadeFrame Fade-out frames. Takes a value between 0 and 65535.

Return Values

None.

Description

This function stops the stream that is bound to the stream handle handle. It does not do anything if the stream handle handle is invalid.

The sound fades out gradually over the time for the number of frames that are specified in fadeFrame and then the stream stops completely. When fadeFrame is 0, the stream stops immediately. The priority during a fade-out is 0 (the lowest priority).

See Also

None.

Revision History

2004/08/10 Initial version.


CONFIDENTIAL