Copyright © 2011-2018 MultiMedia Soft

SoundComposer.ItemWaveToneTypeGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the current type of a specific wave tone item. The type of wave tone can be modified through the SoundComposer.ItemWaveToneTypeSet method.

 

For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function ItemWaveToneTypeGet (

nUniqueId as Int32,

ByRef nWaveType as enumSoundGenWaveTypes

) as enumErrorCodes


 

[C#]

public enumErrorCodes ItemWaveToneTypeGet (

Int32 nUniqueId,

ref enumSoundGenWaveTypes nWaveType

);


 

[C++]

public: enumErrorCodes ItemWaveToneTypeGet (

Int32 nUniqueId,

enumSoundGenWaveTypes __gc  *nWaveType

);


 

Parameter

Description

 

 

nUniqueId

The unique identifier of the element previously returned by the call to the SoundComposer.ItemWaveToneAdd method.

nWaveType

Reference that, on return from the method call, will contain the type of wave tone.

Supported values are the following:

Mnemonic Value

Value

Meaning

SOUNDGEN_WAVE_TYPE_SINE

0

Sine wave

SOUNDGEN_WAVE_TYPE_SQUARE

1

Square wave

SOUNDGEN_WAVE_TYPE_SAWTOOTH

2

Sawtooth wave

SOUNDGEN_WAVE_TYPE_SAWTOOTH_NEGATIVE

3

Negative sawtooth wave

SOUNDGEN_WAVE_TYPE_TRIANGLE

4

Triangle wave

 

 

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.