|
SoundComposer.ItemOffsetSet method |
  
|
|
SoundComposer.ItemOffsetSet method |
|
Remarks
Modifies the offset of the item respect to the beginning of the audio stream. The current offset of the item can be obtained through the The current channel can be obtained through the SoundComposer.ItemOffsetGet 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 ItemOffsetSet ( nPlayerIndex as Int16, nUniqueId as Int32, nOffset as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemOffsetSet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 nOffset ); |
[C++] public: enumErrorCodes ItemOffsetSet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 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 |
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. |
