|
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] Public Function StreamElementDurationGet ( nPlayerIndex as Int16, nUniqueId as Int32, ByRef nDurationMs as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes StreamElementDurationGet ( Int16 nPlayerIndex, Int32 nUniqueId, ref Int32 nDurationMs ); |
[C++] public: enumErrorCodes StreamElementDurationGet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 __gc *nDurationMs ); |
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: - 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 (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |
