Classes > VideoPlayer class > Methods > VideoPlayer.SeekToFrame method

Remarks

Seeks to a given playback position expressed in frames. Note that not all of the video formats support seeking: you can know if a certain format is seekable through a call to the VideoPlayer.IsSeekable method.

A call to this method is ignored if the embedded fader, through a call to the Fader.Init method, has been set to work with a single playlist (FADE_SINGLE_PLAYLIST).

If the status of the given player is "stopped" or "paused", a call to this method will move the playback position but will not cause the playback to start while, if the status of the given player is "playing", a call to this method will move the playback position and will continue playback without interruptions. In case the player should be "stopped", a call to this method will move the playback position and will automatically put the player in "paused" state.

If the seek operation brings the playback position beyond the end of the file, the SoundDone event is generated.

For further details about the use of the embedded video player see the VideoPlayer class section.

For details about video clips rendering refer to the How to play video files through DirectShow tutorial.

Syntax

[Visual Basic]

Public Function SeekToFrame (

nPlayerIndex as Int16,

nFrame as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes SeekToFrame (

Int16 nPlayerIndex,

Int32 nFrame

);

[C++]

public: enumErrorCodes SeekToFrame (

Int16 nPlayerIndex,

Int32 nFrame

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the player that will play the sound range
nFrame	New position expressed in frames

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.