|
SoundComposer.ItemOffsetGet method |
  
|
|
SoundComposer.ItemOffsetGet method |
|
Remarks
Obtains the offset of the item respect to the beginning of the audio stream. The offset of the item can be modified through the SoundComposer.ItemOffsetSet 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 ItemOffsetGet ( nPlayerIndex as Int16, nUniqueId as Int32, ByRef nOffset as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemOffsetGet ( Int16 nPlayerIndex, Int32 nUniqueId, ref Int32 nOffset ); |
[C++] public: enumErrorCodes ItemOffsetGet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 __gc *nOffset ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the player that owns the sound composer session |
nUniqueId |
The unique identifier of the element previously returned by the call to one of the following methods: - SoundComposer.ItemSoundFileAdd, SoundComposer.ItemSoundFileMemoryAdd, SoundComposer.ItemSoundFileRawAdd, SoundComposer.ItemSoundFileMemoryRawAdd for sound file items. - SoundComposer.ItemSpeechFromStringAdd and SoundComposer.ItemSpeechFromFileAdd for text to speech items. |
nOffset |
Reference that, on return from the method call, will contain the offset of the item expressed in milliseconds. |
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. |
