Copyright © 2011-2018 MultiMedia Soft

SoundComposer.ItemIsEnabled method

Previous pageReturn to chapter overviewNext page



Obtains the enabled status of an item during composition of the audio stream previously created through the SoundComposer.SessionInit method. You can enable or disable a specific item through the SoundComposer.ItemEnable method.


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





[Visual Basic]

Public Function ItemIsEnabled (

nUniqueId as Int32,

ByRef bEnable as bool

) as enumErrorCodes



public enumErrorCodes ItemIsEnabled (

Int32 nUniqueId,

ref bool bEnable




public: enumErrorCodes ItemIsEnabled (

Int32 nUniqueId,

bool __gc *bEnable








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.


Reference that, on return from the method call, will contain the boolean value indicating if the item is enabled or disabled.

Supported values are the following:

Mnemonic Value



Item is disabled

true (default)

Item is enabled



Return value






Negative value

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

enumErrorCodes.NOERROR (0)

The method call was successful.