|
SoundComposer.ItemPlaybackPositionGet method |
  
|
|
SoundComposer.ItemPlaybackPositionGet method |
|
Remarks
Obtains the current playback position of the given item. Before invoking this method you may check if the item is effectively in playback state through the SoundComposer.ItemIsPlaying 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 ItemPlaybackPositionGet ( nPlayerIndex as Int16, nUniqueId as Int32, ByRef nPositionInMs as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemPlaybackPositionGet ( Int16 nPlayerIndex, Int32 nUniqueId, ref Int32 nPositionInMs ); |
[C++] public: enumErrorCodes ItemPlaybackPositionGet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 __gc *nPositionInMs ); |
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 for sound file items. - SoundComposer.ItemSpeechFromStringAdd and SoundComposer.ItemSpeechFromFileAdd for text to speech items. |
nPositionInMs |
Value representing the current playback position 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. |
