Copyright © 2008-2018 MultiMedia Soft

SoundComposer.ItemSoundFileVolumeSlidingGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains parameters of a specific linear volume sliding, previously added through the SoundComposer.ItemSoundFileVolumeSlidingAdd method, from the given sound file item.

 

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

 

 

Syntax

 

[Visual Basic]

Public Function ItemSoundFileVolumeSlidingGet (

nUniqueId as Int32,

nVolumeSlidingUniqueId as Int32,

ByRef nSlideStartPosMs as Int32,

ByRef nSlideLengthMs as Int32,

ByRef fVolumeAmpltudeStart as Single,

ByRef fVolumeAmpltudeEnd as Single

) as enumErrorCodes


 

[C#]

public enumErrorCodes ItemSoundFileVolumeSlidingGet (

Int32 nUniqueId,

Int32 nVolumeSlidingUniqueId,

ref Int32 nSlideStartPosMs,

ref Int32 nSlideLengthMs,

ref float fVolumeAmpltudeStart,

ref float fVolumeAmpltudeEnd

);


 

[C++]

public: enumErrorCodes ItemSoundFileVolumeSlidingGet (

Int32 nUniqueId,

Int32 nVolumeSlidingUniqueId,

Int32 __gc *nSlideStartPosMs,

Int32 __gc *nSlideLengthMs,

float __gc *fVolumeAmpltudeStart,

float __gc *fVolumeAmpltudeEnd

);


 

Parameter

Description

 

 

nUniqueId

The unique identifier of the sound file item previously returned by the call to one of the following methods: SoundComposer.ItemSoundFileAdd, SoundComposer.ItemSoundFileMemoryAdd, SoundComposer.ItemSoundFileRawAdd, SoundComposer.ItemSoundFileMemoryRawAdd, SoundComposer.ItemSoundFileFromEditorAdd,or SoundComposer.ItemSoundFileFromRecorderAdd.

nVolumeSlidingUniqueId

The unique identifier of the linear volume sliding returned by the SoundComposer.ItemSoundFileVolumeSlidingAdd method or by the SoundComposer.ItemSoundFileVolumeSlidingUniqueIdGet method.

nSlideStartPosMs

Reference to a value that, on return from the method call, will contain the initial position of the sliding expressed in milliseconds

nSlideLengthMs

Reference to a value that, on return from the method call, will contain the length of the sliding expressed in milliseconds

fVolumeAmpltudeStart

Reference to a value that, on return from the method call, will contain the initial volume amplitude of the sliding.

- 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

fVolumeAmpltudeEnd

Reference to a value that, on return from the method call, will contain the final volume amplitude of the sliding.

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