|
SoundGenerator.StreamElementDurationGet method |
  
|
|
SoundGenerator.StreamElementDurationGet method |
|
Remarks
Obtains the duration of the given sound 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] control.SoundGenerator.StreamElementDurationGet ( nPlayer as Integer, nUniqueId as Long, ByRef nDurationMs as Long ) as enumErrorCodes |
[C++] short control.SoundGenerator.StreamElementDurationGet ( short nPlayer, long nUniqueId, long *nDurationMs ); |
Parameter |
Description |
|
|
nPlayer |
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: - SoundGenerator.StreamChannelAddTone - SoundGenerator.StreamChannelAddNoise - SoundGenerator.StreamChannelAddDtmfString - SoundGenerator.StreamChannelAddSlidingTone - SoundGenerator.StreamChannelAddSpeechFromFile |
nDurationMs |
Reference to a value that, on return from the method call, will contain the duration of the sound element, expressed in milliseconds |
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 |
