Copyright © 2005-2018 MultiMedia Soft

SoundGenerator.StreamElementSlidingToneTypeGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

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

Public Function StreamElementSlidingToneTypeGet (

nPlayerIndex as Int16,

nUniqueId as Int32,

ByRef nType as enumSoundGenSlidingWaveTypes

) as enumErrorCodes


 

[C#]

public enumErrorCodes StreamElementSlidingToneTypeGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

ref enumSoundGenSlidingWaveTypes nType

);


 

[C++]

public: enumErrorCodes StreamElementSlidingToneTypeGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

enumSoundGenSlidingWaveTypes __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.StreamChannelAddSlidingTone

- SoundGenerator.StreamChannelElementUniqueIdGet

nType

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

Supported values are the following:

Mnemonic Value

Value

Meaning

SOUNDGEN_SLIDING_WAVE_TYPE_SINE

0

Sine wave

SOUNDGEN_SLIDING_WAVE_TYPE_SQUARE

1

Square wave

SOUNDGEN_SLIDING_WAVE_TYPE_SAWTOOTH

2

Sawtooth wave

SOUNDGEN_SLIDING_WAVE_TYPE_SQUARE_NO_ALIAS

3

Square wave without aliasing

 

 

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.