Copyright © 2005-2018 MultiMedia Soft

SoundGenerator.StreamElementSlidingToneLimitsGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains current frequencies and amplitudes of the sliding wave tone element identified by a specific unique identifier.

 

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 StreamElementSlidingToneLimitsGet (

nPlayerIndex as Int16,

nUniqueId as Int32,

ByRef fFrequencyStart as Single,

ByRef fFrequencyEnd as Single,

ByRef fAmplitudeStart as Single,

ByRef fAmplitudeEnd as Single

) as enumErrorCodes


 

[C#]

public enumErrorCodes StreamElementSlidingToneLimitsGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

ref float fFrequencyStart,

ref float fFrequencyEnd,

ref float fAmplitudeStart,

ref float fAmplitudeEnd

);


 

[C++]

public: enumErrorCodes StreamElementSlidingToneLimitsGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

float __gc *fFrequencyStart,

float __gc *fFrequencyEnd,

float __gc *fAmplitudeStart,

float __gc *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

 

 

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.