SoundComposer.ItemDtmfStringGet method |
|
Remarks
Obtains the string of DTMF tones and related parameters for a specific item. The string of DTMF tones and related parameters can be modified through the SoundComposer.ItemDtmfStringSet 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 ItemDtmfStringGet ( nUniqueId as Int32, ByRef nToneDurationMs as Int32, ByRef nSilenceDurationMs as Int32, ByRef nFadeInMs as Int32, ByRef nFadeOutMs as Int32 ) as String |
[C#] public string ItemDtmfStringGet ( Int32 nUniqueId, ref Int32 nToneDurationMs, ref Int32 nSilenceDurationMs, ref Int32 nFadeInMs, ref Int32 nFadeOutMs ); |
[C++] public: string ItemDtmfStringGet ( Int32 nUniqueId, Int32 __gc *nToneDurationMs, Int32 __gc *nSilenceDurationMs, Int32 __gc *nFadeInMs, Int32 __gc *nFadeOutMs ); |
Parameter |
Description |
|
|
nUniqueId |
The unique identifier of the element previously returned by the call to the SoundComposer.ItemDtmfStringAdd method. |
nToneDurationMs |
Reference that, on return from the method call, will contain the duration of each DTMF tone expressed in milliseconds |
nSilenceDurationMs |
Reference that, on return from the method call, will contain the duration of silence between each DTMF tone expressed in milliseconds |
nFadeInMs |
Reference that, on return from the method call, will contain the duration of the fade-in at the beginning of each DTMF tone expressed in milliseconds. |
nFadeOutMs |
Reference that, on return from the method call, will contain the duration of the fade-out at the end of each DTMF tone expressed in milliseconds. |
Return value
Value |
Meaning |
|
|
Empty string |
The information is not available or an error occurred (see the LastError property for further error details) |
Valid string |
String containing DTMF characters that will dial the phone number. |