Copyright © 2008-2014 MultiMedia Soft

SoundComposer.ItemIsEnabled method

Previous pageReturn to chapter overviewNext page

Remarks

 

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 SoundComposer object and the How to compose a sound tutorial.

 

 

Syntax

 

[Visual Basic]

control.SoundComposer.ItemIsEnabled (

nUniqueId as Long

ByRef bEnable as enumBoolean

) as enumErrorCodes


 

[C++]

short control.SoundComposer.ItemIsEnabled (

long *nUniqueId,

long *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

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

Meaning

BOOL_FALSE

Item is disabled

BOOL_TRUE (default)

Item is enabled

 

 

 

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