Copyright © 2008-2018 MultiMedia Soft

SoundComposer.ItemSlidingWaveToneLimitsGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains initial and final frequencies and amplitudes used to generate a specific sliding wave tone item. Frequencies and/or amplitudes can be modified through the SoundComposer.ItemSlidingWaveToneLimitsSet method.

 

For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function ItemSlidingWaveToneLimitsGet (

nUniqueId as Int32,

ByRef fFrequencyStart as Single,

ByRef fFrequencyEnd as Single,

ByRef fAmplitudeStart as Single,

ByRef fAmplitudeEnd as Single

) as enumErrorCodes


 

[C#]

public enumErrorCodes ItemSlidingWaveToneLimitsGet (

Int32 nUniqueId,

ref float fFrequencyStart,

ref float fFrequencyEnd,

ref float fAmplitudeStart,

ref float fAmplitudeEnd

);


 

[C++]

public: enumErrorCodes ItemSlidingWaveToneLimitsGet (

Int32 nUniqueId,

float __gc *fFrequencyStart,

float __gc *fFrequencyEnd,

float __gc *fAmplitudeStart,

float __gc *fAmplitudeEnd

);


 

Parameter

Description

 

 

nUniqueId

The unique identifier of the element previously returned by the call to the SoundComposer.ItemSlidingWaveToneAdd method.

fFrequencyStart

Reference that, on return from the method call, will contain the initial wave tone frequency expressed in Hertz, e.g. 700

fFrequencyEnd

Reference that, on return from the method call, will contain the final wave tone frequency expressed in Hertz, e.g. 1000

fAmplitudeStart

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