|
SoundComposer.ItemSoundFileLoadRangeGet method |
  
|
|
SoundComposer.ItemSoundFileLoadRangeGet method |
|
Remarks
Obtains the sound file loading range used when the sound file was added to the session's stream.
For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.
Syntax
[Visual Basic] Public Function ItemSoundFileLoadRangeGet ( nPlayerIndex as Int16, nUniqueId as Int32, ByRef nStartPositionMs as Int32, ByRef nEndPositionMs as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemSoundFileLoadRangeGet ( Int16 nPlayerIndex, Int32 nUniqueId, ref Int32 nStartPositionMs, ref Int32 nEndPositionMs ); |
[C++] public: enumErrorCodes ItemSoundFileLoadRangeGet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 __gc *nStartPositionMs, Int32 __gc *nEndPositionMs ); |
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. |
nStartPositionMs |
Reference that, on return from the method call, will contain the start position, expressed in milliseconds, where the sound file loading will occur |
nEndPositionMs |
Reference that, on return from the method call, will contain the end position, expressed in milliseconds, where the sound file loading will occur |
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. |
