Copyright © 2011-2018 MultiMedia Soft

SoundGenerator.NoiseGenerate method

Previous pageReturn to chapter overviewNext page

Remarks

 

Generates a noise audio stream.

 

For further details about sound generation see the SoundGeneratorMan class and the How to generate wave tones, noises, DTMF tones and text to speech tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function NoiseGenerate (

nNoiseType as enumSoundGenNoiseTypes,

nSampleRate as Int32,

nChannels as Int32,

fReserved as Single,

fAmplitude as Single,

nDurationMs as Int32,

nFadeInMs as Int32,

nFadeOutMs as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes NoiseGenerate (

enumSoundGenNoiseTypes nNoiseType,

Int32 nSampleRate,

Int32 nChannels,

float fReserved,

float fAmplitude,

Int32 nDurationMs,

Int32 nFadeInMs,

Int32 nFadeOutMs

);


 

[C++]

public: enumErrorCodes NoiseGenerate (

enumSoundGenNoiseTypes nNoiseType,

Int32 nSampleRate,

Int32 nChannels,

float fReserved,

float fAmplitude,

Int32 nDurationMs,

Int32 nFadeInMs,

Int32 nFadeOutMs

);


 

Parameter

Description

 

 

nNoiseType

Type of noise.

Supported values are the following:

Mnemonic Value

Value

Meaning

SOUNDGEN_NOISE_TYPE_WHITE

0

White noise

SOUNDGEN_NOISE_TYPE_PINK

1

Pink noise

SOUNDGEN_NOISE_TYPE_BROWN

2

Brown noise

nSampleRate

Sample rate of the stream, e.g. 44100

nChannels

Number of channels of the audio stream.

Supported values are the following:

Value

Meaning

1

Mono audio stream

2

Stereo audio stream

4

3.1 audio stream

6

5.1 audio stream

8

7.1 audio stream

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 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 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.

 

 

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.