|
SoundComposer.ItemChannelSet method |
  
|
|
SoundComposer.ItemChannelSet method |
|
Remarks
Modifies the channel of the audio stream that will reproduce the item. The current channel can be obtained through the SoundComposer.ItemInfoGet 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 ItemChannelSet ( nPlayerIndex as Int16, nUniqueId as Int32, nChannel as Int32, bDownMixToMono as bool ) as enumErrorCodes |
[C#] public enumErrorCodes ItemChannelSet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 nChannel, bool bDownMixToMono ); |
[C++] public: enumErrorCodes ItemChannelSet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 nChannel, bool 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 |
Channel of the audio stream that will reproduce the item |
||||||
bDownMixToMono |
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:
|
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. |
