FSOUND_GetNumSubChannels

##### [API function]

## FSOUND_GetNumSubChannels

This function returns the number of sub-channels stored in a multi-channel channel handle, which is only possible when playing back a multichannel .FSB file.

int F_API FSOUND_GetNumSubChannels(
int channel
);

### Parameters

channel | The value returned by FSOUND_Stream_Play, FSOUND_Stream_PlayEx, FSOUND_PlaySound, FSOUND_PlaySoundEx.

### Return Value

On success, the number of subchannels is returned
On failure, 0 is returned.

### Remarks

A multichannel sound, only possible with the .FSB format, can contain multiple subchannels. When a multichannel sound is played, multiple channels are allocated at the same time.
For example, a 8 sounds/streams can be interleaved into a multichannel FSB. This function would return 8, as 8 real hardware/software voices are used during playback.
FSOUND_GetSubChannel can be used to get access to the secondary channels.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FSOUND_GetSubChannel , FSOUND_PlaySound , FSOUND_PlaySoundEx , FSOUND_Stream_Play , FSOUND_Stream_PlayEx

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Thu Dec 15 17:31:30 2005 by SourceDoc v0.10, the automated source code documenter.