SoundGenerator.StreamElementDtmfStringGet method |
|
Remarks
Obtains the string of DTMF tones and related settings for the given DTMF element.
For further details about sound generation see the SoundGenerator object and the How to generate wave tones, noises, DTMF tones and text to speech tutorial..
Syntax
[Visual Basic] Public Function StreamElementDtmfStringGet ( nPlayerIndex as Int16, nUniqueId as Int32, ByRef nToneDurationMs as Int32, ByRef nSilenceDurationMs as Int32, ByRef nFadeInMs as Int32, ByRef nFadeOutMs as Int32 ) as String |
[C#] public string StreamElementDtmfStringGet ( Int16 nPlayerIndex, Int32 nUniqueId, ref Int32 nToneDurationMs, ref Int32 nSilenceDurationMs, ref Int32 nFadeInMs, ref Int32 nFadeOutMs ); |
[C++] public: string StreamElementDtmfStringGet ( Int16 nPlayerIndex,, Int32 nUniqueId, Int32 __gc *nToneDurationMs, Int32 __gc *nSilenceDurationMs Int32 __gc *nFadeInMs, Int32 __gc *nFadeOutMs ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
nUniqueId |
The unique identifier of the element previously returned by one of the following calls: |
nToneDurationMs |
Reference to a value that, on return from the method call, will contain the duration of each DTMF tone expressed in milliseconds |
nSilenceDurationMs |
Reference to a value that, on return from the method call, will contain the duration of silence between each DTMF tone expressed in milliseconds |
nFadeInMs |
Reference to a value 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 to a value 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 characters of DTMF tones |