SoundComposer.ItemSoundFileLoopGet method |
|
Remarks
Obtains the number of times a specific sound file item is applied to the audio stream. The number of loops applied to the item can be modified through the SoundComposer.ItemSoundFileLoopSet method.
For further details about sound composing see the the SoundComposer object and the How to compose a sound tutorial.
Syntax
[Visual Basic] control.SoundComposer.ItemSoundFileLoopGet ( nUniqueId as Long, ByRef nLoops as Integer ) as enumErrorCodes |
[C++] short control.SoundComposer.ItemSoundFileLoopGet ( long nUniqueId, short *nLoops ); |
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. |
nLoops |
Reference that, on return from the method call, will contain the current number of times the sound file item is applied to the audio stream. |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred, check the LastError property value in order to get the error code |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful |