SoundComposer.ItemEnable method |
|
Remarks
Enables/disables a specific item from being added during sound composition to the audio stream previously created through the SoundComposer.SessionInit method. You can know if a specific item is enabled or disabled through the SoundComposer.ItemIsEnabled 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 ItemEnable ( nUniqueId as Int32, bEnable as Boolean ) as enumErrorCodes |
[C#] public enumErrorCodes ItemEnable ( Int32 nUniqueId, bool bEnable ); |
[C++] public: enumErrorCodes ItemEnable ( Int32 nUniqueId, bool bEnable ); |
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. |
||||||
bEnable |
Boolean value indicating if the item becomes enabled or disabled. 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. |