Copyright © 2005-2018 MultiMedia Soft

VideoPlayer.FullscreenMonitorPredispose method

Previous pageReturn to chapter overviewNext page

Remarks

 

Predisposes full screen management for the given player over a specific monitor. This call is mandatory in order to allow going full screen at a later time through a call to the VideoPlayer.FullscreenMonitorActivate method.

 

When a monitor is no more needed for going full screen, it can be removed from the list of predisposed monitors through the VideoPlayer.FullscreenMonitorRemove method.

 

For details about full screen management refer to the How to render video clips in full screen tutorial.

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

nPlayerIndex as Int16,

nMonitorIndex as Int32,

hWndTarget as IntPtr

) as enumErrorCodes


 

[C#]

public enumErrorCodes FullscreenMonitorPredispose (

Int16 nPlayerIndex,

Int32 nMonitorIndex,

IntPtr hWndTarget

);


 

[C++]

public: enumErrorCodes FullscreenMonitorPredispose (

Int16 nPlayerIndex,

Int32 nMonitorIndex,

IntPtr hWndTarget

);


 

 

Parameter

Description

 

 

nPlayerIndex

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

nMonitorIndex

Number representing the zero-based index of the monitor that will be predisposed for going full screen. The total number of installed monitors can be obtained using the VideoPlayer.FullscreenMonitorCountGet method.

hWndTarget

The Windows handle (HWND) of the target form that will be used to render the video clip in full screen over the given monitor. Creating this target form is responsibility of the container application. This form should be without border and caption bar and, if needed, may optionally contain the custom code used to manage the hiding of the form when full screen is no more needed or, as a further example, the possibility to display a context menu when the surface of the video window is clicked with one of the mouse's buttons.

 

 

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.