Classes > VideoPlayer class > Methods > VideoPlayer.Pause method

Remarks

Pauses the playing video.

A successful call to this method will fire the SoundPaused event.

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 Pause (

nPlayerIndex as Int16

[C#]

public enumErrorCodes Pause (

Int16 nPlayerIndex

);

[C++]

public: enumErrorCodes Pause (

Int16 nPlayerIndex

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the player that will use the video player.

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.