|
SoundGenerator.StreamElementRemove method |
  
|
|
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] Public Function StreamElementRemove ( nPlayerIndex as Int16, nUniqueId as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes StreamElementRemove ( Int16 nPlayerIndex, Int32 nUniqueId ); |
[C++] public: enumErrorCodes StreamElementRemove ( Int16 nPlayerIndex, Int32 nUniqueId ); |
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 |
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. |
