Copyright © 2001-2019 MultiMedia Soft

SoundComposer.ItemPlaybackPositionGet method

Previous pageReturn to chapter overviewNext page

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 SoundComposer object and the How to compose a sound tutorial.

 

 

Syntax

 

[Visual Basic]

control.SoundGenerator.ItemPlaybackPositionGet (

nPlayer as Integer,

nUniqueId as Long,

ByRef nPositionInMs as Long

) as enumErrorCodes


 

[C++]

short control.SoundGenerator.ItemPlaybackPositionGet (

short nPlayer,

long nUniqueId,

long *nPositionInMs

);


 

Parameter

Description

 

 

nPlayer

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.