NNS_SndArcStrmAllocChannel

Syntax

#include <nnsys/snd.h>
BOOL NNS_SndArcStrmAllocChannel( int playerNo );

Arguments

playerNo The stream player number. Takes a value between 0 and 3.

Return Values

Returns whether the channel was successfully allocated.

Description

Allocates the channels used when a stream is played.

The allocated channel is connected to the specified stream player. Thereafter, streams that are played with the stream player are played back using the allocated channel.

To playback streams without allocating a channel with this function, automatically allocate a channel using either the NNS_SndArcStrmStart or the NNS_SndArcStrmPrepare function. These functions are used to control the timing by which channels are allocated.

Use the NNS_SndArcStrmFreeChannel function to release channels that are allocated with this function.

Note

The function will fail if you call it for a stream player that is playing.

See Also

NNS_SndArcStrmStart, NNS_SndArcStrmPrepare, NNS_SndArcStrmFreeChannel

Revision History

2004/11/25 Added a cautionary note concerning calling this function when a player is playing.
2004/08/10 Initial version.


CONFIDENTIAL