Copyright © 2001-2018 MultiMedia Soft

SoundGenerator.StreamElementToneTypeGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the type of wave tone for the given wave tone 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]

control.SoundGenerator.StreamElementToneTypeGet (

nPlayer as Integer,

nUniqueId as Long,

ByRef nType as enumSoundGenWaveTypes

) as enumErrorCodes


 

[C++]

short control.SoundGenerator.StreamElementToneTypeGet (

short nPlayer,

long nUniqueId,

short *nType

);


 

Parameter

Description

 

 

nPlayer

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

- SoundGenerator.StreamChannelElementUniqueIdGet

nType

Reference to a value 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, check the LastError property value in order to get the error code

enumErrorCodes.ERR_NOERROR (0)

The method call was successful