[Visual Basic]

control.SoundGenerator.NoiseGenerate (

nNoiseType as enumSoundGenNoiseTypes,

nSampleRate as Long,

nChannels as Integer,

fReserved as Single,

fAmplitude as Single,

nDurationMs as Long,

nFadeInMs as Long,

nFadeOutMs as Long

) as enumErrorCodes

[C++]

short control.SoundGenerator.NoiseGenerate (

short nNoiseType,

long nSampleRate,

short nChannels,

float fReserved,

float fAmplitude,

long nDurationMs,

long nFadeInMs,

long nFadeOutMs

);

Parameter

Description

nNoiseType

Type of noise.

Supported values are the following:

nSampleRate

Sample rate of the stream, e.g. 44100

nChannels

Number of channels of the audio stream.

Supported values are the following:

fReserved

Reserved for future uses, set this parameter to 0

fAmplitude

Noise 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 noise expressed in milliseconds.

nFadeInMs

Duration of the fade-in at the beginning of the noise 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 noise 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.

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.