SoundComposer.ItemSoundFileVolumeSmoothingGet method |
|
Remarks
Obtains the eventual volume smoothing at the beginning and at the end of the given sound file item. The volume smoothing can be modified or removed through the SoundComposer.ItemSoundFileVolumeSmoothingSet 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 ItemSoundFileVolumeSmoothingGet ( nPlayerIndex as Int16, nUniqueId as Int32, ByRef nSlideDurationStartMs as Int32, ByRef nSlideDurationEndMs as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemSoundFileVolumeSmoothingGet ( Int16 nPlayerIndex, Int32 nUniqueId, ref Int32 nSlideDurationStartMs, ref Int32 nSlideDurationEndMs ); |
[C++] public: enumErrorCodes ItemSoundFileVolumeSmoothingGet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 __gc *nSlideDurationStartMs, Int32 __gc *nSlideDurationEndMs ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the player that owns the sound composer session |
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. |
nSlideDurationStartMs |
Reference to a value that, on return from the method call, will contain the duration of the volume fade-in, expressed in milliseconds, at the beginning of the item |
nSlideDurationEndMs |
Reference to a value that, on return from the method call, will contain the duration of the volume fade-out, expressed in milliseconds, at the end of the item |
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. |