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 SoundComposer object and the How to compose a sound tutorial.
Syntax
[Visual Basic] control.SoundComposer.ItemChannelGet ( nUniqueId as Long, ByRef nChannel as Long ) as enumErrorCodes |
[C++] short control.SoundComposer.ItemChannelGet ( long nUniqueId, long *nChannel ); |
Parameter |
Description |
|
|
nUniqueId |
The unique identifier of the element previously returned by the call to one of the following methods: - SoundComposer.ItemDtmfStringAdd for DTMF items. - SoundComposer.ItemNoiseAdd for noise tone items. - SoundComposer.ItemSlidingWaveToneAdd for sliding wave tone items. - SoundComposer.ItemSoundFileAdd, SoundComposer.ItemSoundFileMemoryAdd, SoundComposer.ItemSoundFileRawAdd, SoundComposer.ItemSoundFileMemoryRawAdd, SoundComposer.ItemSoundFileFromEditorAdd,and SoundComposer.ItemSoundFileFromRecorderAdd for sound file items - SoundComposer.ItemWaveToneAdd for wave tone 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 |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred, check the LastError property value in order to get the error code |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful |