SoundComposer.ItemDtmfStringSet method |
|
Remarks
Modifies an existing string of DTMF tones and related parameters for a specific item. The current string of DTMF tones and related parameters can be obtained through the SoundComposer.ItemDtmfStringGet 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.ItemDtmfStringSet ( nUniqueId as Long, strDtmf as String, nToneDurationMs as Long, nSilenceDurationMs as Long, nFadeInMs as Long, nFadeOutMs as Long ) as enumErrorCodes |
[C++] short control.SoundComposer.ItemDtmfStringSet ( long nUniqueId, LPCTSTR strDtmf, long nToneDurationMs, long nSilenceDurationMs, long nFadeInMs, long nFadeOutMs ); |
Parameter |
Description |
|
|
nUniqueId |
The unique identifier of the element previously returned by the call to the SoundComposer.ItemDtmfStringAdd method. |
strDtmf |
String containing DTMF characters that will dial the phone number |
nToneDurationMs |
Duration of each DTMF tone expressed in milliseconds |
nSilenceDurationMs |
Duration of silence between each DTMF tone expressed in milliseconds |
nFadeInMs |
Duration of the fade-in at the beginning of each DTMF tone expressed in milliseconds. Set this value to 0 if you don't need to apply a fade-in at the beginning of each DTMF tone. |
nFadeOutMs |
Duration of the fade-out at the end of each DTMF tone expressed in milliseconds. Set this value to 0 if you don't need to apply a fade-out at the end of each DTMF tone. |
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 |