[Visual Basic]

Public Function StreamChannelAddSlidingTone (

nPlayerIndex as Int16,

nChannel as Int16,

nWaveType as enumSoundGenSlidingWaveTypes,

fFrequencyStart as Single,

fFrequencyEnd as Single,

fAmplitudeStart as Single,

fAmplitudeEnd as Single,

bLogInterpolation as bool,

nDurationMs as Int32,

nOffsetMs as Int32,

nFadeInMs as Int32,

nFadeOutMs as Int32,

ByRef nUniqueId as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes StreamChannelAddSlidingTone (

Int16 nPlayerIndex,

Int16 nChannel,

enumSoundGenSlidingWaveTypes nWaveType,

float fFrequencyStart,

float fFrequencyEnd,

float fAmplitudeStart,

float fAmplitudeEnd,

bool bLogInterpolation,

Int32 nDurationMs,

Int32 nOffsetMs,

Int32 nFadeInMs,

Int32 nFadeOutMs,

ref Int32 nUniqueId

);

[C++]

public: enumErrorCodes StreamChannelAddSlidingTone (

Int16 nPlayerIndex,

Int16 nChannel,

enumSoundGenSlidingWaveTypes nWaveType,

float fFrequencyStart,

float fFrequencyEnd,

float fAmplitudeStart,

float fAmplitudeEnd,

bool bLogInterpolation,

Int32 nDurationMs,

Int32 nOffsetMs,

Int32 nFadeInMs,

Int32 nFadeOutMs,

Int32 __gc  *nUniqueId

);

Parameter

Description

nPlayerIndex

Number representing the zero-based index of the involved player

nChannel

Channel of the audio stream that will reproduce the sliding wave tone: can be a value between 0 and the number of channels of the audio stream created through the SoundGenerator.StreamCreateMultiChannelEmpty method.

nWaveType

Type of wave tone.

Supported values are the following:

fFrequencyStart

Initial wave tone frequency expressed in Hertz, e.g. 700

fFrequencyEnd

Final wave tone frequency expressed in Hertz, e.g. 1000

fAmplitudeStart

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

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

bLogInterpolation

Boolean value indicating if the sliding should use linear or logarithmic interpolation.

Supported values are the following:

nDurationMs

Duration of the wave tone expressed in milliseconds

nOffsetMs

Offset of the sliding wave tone, expressed in milliseconds, respect to the beginning of the audio stream.

nFadeInMs

Duration of the fade-in at the beginning of the tone expressed in milliseconds. Set this value to 0 if you don't need to apply a fade-in at the beginning of the audio stream.

nFadeOutMs

Duration of the fade-out at the end of the tone expressed in milliseconds. Set this value to 0 if you don't need to apply a fade-out at the end of the audio stream.

nUniqueId

Reference to a value that, on return from the method call, will contain the unique identifier of the newly added element: this unique identifier will be used in order to invoke further methods related to the use of this specific element.

- SoundGenerator.StreamElementSlidingToneLimitsGet to retrieve frequencies and amplitudes used to render the sliding wave tone element.

- SoundGenerator.StreamElementSlidingToneTypeGet to obtain the type of sliding wave tone.

- SoundGenerator.StreamElementRemove to remove the wave tone element from the audio stream.

- SoundGenerator.StreamElementDurationGet to obtain the duration of the wave tone element.

- SoundGenerator.StreamElementOffsetGet to obtain the offset of the wave tone element.

Value

Meaning

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.