[Visual Basic]

control.SoundGenerator.StreamElementSlidingToneLimitsGet (

nPlayer as Integer,

nUniqueId as Long,

ByRef fFrequencyStart as Single,

ByRef fFrequencyEnd as Single,

ByRef fAmplitudeStart as Single,

ByRef fAmplitudeEnd as Single,

) as enumErrorCodes

[C++]

short control.SoundGenerator.StreamElementSlidingToneLimitsGet (

short nPlayer,

long nUniqueId,

float *fFrequencyStart,

float *fFrequencyEnd,

float *fAmplitudeStart,

float *fAmplitudeEnd

);

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

- SoundGenerator.StreamChannelElementUniqueIdGet

fFrequencyStart

Reference to a value that, on return from the method call, will contain the sliding wave tone start frequency expressed in Hertz

fFrequencyEnd

Reference to a value that, on return from the method call, will contain the sliding wave tone end frequency expressed in Hertz

fAmplitudeStart

Reference to a value that, on return from the method call, will contain the initial wave tone amplitude.

- value 0.0 means that sound volume is muted

- values higher than 0.0 and smaller than 1.0 attenuates the sound volume

- value 1.0 sets the sound at full volume

- values higher than 1.0 amplifies the sound volume

fAmplitudeEnd

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

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