|
SoundGenerator.StreamCreateTone method |
  
|
|
SoundGenerator.StreamCreateTone method |
|
Remarks
Creates a wave tone audio stream and loads it inside the given player.
Once created, the audio stream can be played through the PlaySound method, paused through the PauseSound method and stopped through the StopSound method. Once no more needed, the audio stream can be discarded from memory through the CloseSound 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.StreamCreateTone ( nPlayer as Integer, nSampleRate as Long, bMono as enumBoolean, nWaveType as enumSoundGenWaveTypes, fFrequency as Single, fAmplitude as Single, nDurationMs as Long, nFadeInMs as Long, nFadeOutMs as Long ) as enumErrorCodes |
[C++] short control.SoundGenerator.StreamCreateTone ( short nPlayer, long nSampleRate, short bMono, short nWaveType, float fFrequency, float fAmplitude, long nDurationMs, long nFadeInMs, long nFadeOutMs ); |
Parameter |
Description |
||||||||||||||||||
|
|
||||||||||||||||||
nPlayer |
Number representing the zero-based index of the involved player |
||||||||||||||||||
nSampleRate |
Sample rate of the stream, e.g. 44100 |
||||||||||||||||||
bMono |
Boolean value specifying if the audio stream is in mono or stereo. Supported values are the following:
|
||||||||||||||||||
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 smaller 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. In case you should need to create an endless tone, use the SoundGenerator.StreamCreateMultiChannelEmpty method in combination with the SoundGenerator.StreamChannelAddTone method having the nDurationMs parameter set to 0. |
||||||||||||||||||
nFadeInMs |
Duration of the fade-in at the beginning of the tone expressed in milliseconds. Set this value to 0 if you don't need to apply a fade-in at the beginning of the audio stream. |
||||||||||||||||||
nFadeOutMs |
Duration of the fade-out at the end of the tone expressed in milliseconds. Set this value to 0 if you don't need to apply a fade-out at the end of the audio stream. |
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 |
