|
SoundGenerator.StreamChannelEmpty method |
  
|
|
SoundGenerator.StreamChannelEmpty method |
|
Remarks
Removes any existing sound element from the given channel of the multi-channel audio stream previously created through the SoundGenerator.StreamCreateMultiChannelEmpty method.
You can know if a specific channel is already empty through the SoundGenerator.StreamChannelIsEmpty method; in case the channel should contain one or more elements, they could be enumerated through the SoundGenerator.StreamChannelElementsCountGet method and the unique identifier of each single element could be obtained through the SoundGenerator.StreamChannelElementUniqueIdGet method; after obtaining the unique identifier, each single element could be removed through the SoundGenerator.StreamElementRemove 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.StreamChannelEmpty ( nPlayer as Integer, nChannel as Integer ) as enumErrorCodes |
[C++] short control.SoundGenerator.StreamChannelEmpty ( short nPlayer, short nChannel ); |
Parameter |
Description |
|
|
nPlayer |
Number representing the zero-based index of the involved player |
nChannel |
Channel of the audio stream: can be a value between 0 and the number of channels of the audio stream created through the SoundGenerator.StreamCreateMultiChannelEmpty method. |
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 |
