SoundGenerator.StreamElementRemove method |
|
Remarks
Removes an element previously added to the audio stream created through the SoundGenerator.StreamCreateMultiChannelEmpty method.
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.StreamElementRemove ( nPlayer as Integer, nUniqueId as Long ) as enumErrorCodes |
[C++] short control.SoundGenerator.StreamElementRemove ( short nPlayer, long nUniqueId ); |
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 |
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 |