|
SoundComposer.ItemSoundFileLoopGet method |
  
|
|
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 SoundComposerMan class and the How to compose a sound tutorial.
Syntax
[Visual Basic] Public Function ItemSoundFileLoopGet ( nUniqueId as Int32, ByRef nLoops as Int16 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemSoundFileLoopGet ( Int32 nUniqueId, ref Int16 nLoops ); |
[C++] public: enumErrorCodes ItemSoundFileLoopGet ( Int32 nUniqueId, Int16 __gc *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 (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |
