Copyright © 2005-2018 MultiMedia Soft

SoundGenerator.StreamElementNoiseTypeGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the type of noise for the given noise element.

 

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]

Public Function StreamElementNoiseTypeGet (

nPlayerIndex as Int16,

nUniqueId as Int32,

ByRef nType as enumSoundGenNoiseTypes

) as enumErrorCodes


 

[C#]

public enumErrorCodes StreamElementNoiseTypeGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

ref enumSoundGenNoiseTypes nType

);


 

[C++]

public: enumErrorCodes StreamElementNoiseTypeGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

enumSoundGenNoiseTypes __gc *nType

);


 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

nUniqueId

The unique identifier of the element previously returned by one of the following calls:

- SoundGenerator.StreamChannelAddNoise

- SoundGenerator.StreamChannelElementUniqueIdGet

nType

Reference to a value that, on return from the method call, will contain the 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

 

 

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.