Classes > SoundComposerMan class > Methods > SoundComposer.ItemChannelGet method

Remarks

Obtains the channel of the audio stream that will reproduce the item. The channel can be modified through the SoundComposer.ItemChannelSet method.

For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.

Syntax

[Visual Basic]

Public Function ItemChannelGet (

nPlayerIndex as Int16,

nUniqueId as Int32,

ByRef nChannel as Int32,

ByRef bDownMixToMono as bool

) as enumErrorCodes

[C#]

public enumErrorCodes ItemChannelGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

ref Int32 nChannel,

ref bool bDownMixToMono

);

[C++]

public: enumErrorCodes ItemChannelGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

Int32 __gc *nChannel,

bool __gc *bDownMixToMono

);

Parameter

Description

nPlayerIndex

Number representing the zero-based index of the player that owns the sound composer session

nUniqueId

The unique identifier of the element previously returned by the call to one of the following methods:

- SoundComposer.ItemSoundFileAdd, SoundComposer.ItemSoundFileMemoryAdd, SoundComposer.ItemSoundFileRawAdd, SoundComposer.ItemSoundFileMemoryRawAdd for sound file items.

- SoundComposer.ItemSpeechFromStringAdd and SoundComposer.ItemSpeechFromFileAdd for text to speech items.

nChannel

Reference that, on return from the method call, will contain the channel of the audio stream that will reproduce the item

bDownMixToMono

Reference that, on return from the method call, will contain the boolean flag specifying if there is the need of a downmix in order to store a stereo sound file into a mono channel of the stream.

Supported values are the following:

Mnemonic Value	Meaning
false	Keep stereo channels separated
true	Downmix stereo channels to mono

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The method call was successful.