[Visual Basic]

short control.SoundGenerator.ItemChannelGet (

nPlayer as Integer,

nUniqueId as Long,

ByRef nChannel as Long,

ByRef bDownMixToMono as enumBoolean

) as enumErrorCodes

[C++]

short control.SoundGenerator.ItemChannelGet (

short nPlayer,

long nUniqueId,

long *nChannel,

short *bDownMixToMono

);

Parameter

Description

nPlayer

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:

Value

Meaning

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.