|
SoundGenerator.CompositeWaveToneAddNewWaveTone method |
  
|
|
SoundGenerator.CompositeWaveToneAddNewWaveTone method |
|
Remarks
Adds a single wave tone to a composite audio stream previously created through a previous call to the SoundGenerator.CompositeWaveTonePrepare 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.CompositeWaveToneAddNewWaveTone ( nWaveType as enumSoundGenWaveTypes, fFrequency as Single, fAmplitude as Single, nDurationMs as Long, nOffsetMs as Long, nChannels as Integer ) as enumErrorCodes |
[C++] short control.SoundGenerator.CompositeWaveToneAddNewWaveTone ( short nWaveType, float fFrequency, float fAmplitude, long nDurationMs, long nOffsetMs, short nChannels ); |
Parameter |
Description |
||||||||||||||||||
|
|
||||||||||||||||||
nWaveType |
Type of wave tone. Supported values are the following:
|
||||||||||||||||||
fFrequency |
Wave tone frequency expressed in Hertz |
||||||||||||||||||
fAmplitude |
Wave tone amplitude. - value 0.0 means that sound volume is muted - values higher than 0.0 and lower than 1.0 attenuate the sound volume - value 1.0 sets the sound at full volume - values higher than 1.0 amplify the sound volume |
||||||||||||||||||
nDurationMs |
Duration of the wave tone expressed in milliseconds. |
||||||||||||||||||
nOffsetMs |
Offset of the wave tone, expressed in milliseconds, respect to the beginning of the audio stream. |
||||||||||||||||||
nChannel |
Destination channel of the audio stream, created through a previous call to the SoundGenerator.CompositeWaveTonePrepare method, were the wave tone will be placed. Set this parameter to -1 for adding the wave tone to all of the available channels. |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred, check the LastError property value in order to see the error code meaning |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful. |
