Copyright © 2001-2018 MultiMedia Soft

VideoPlayer.OSDEnable method

Previous pageReturn to chapter overviewNext page

Remarks

 

Enables/disables the On-Screen-Display (OSD) that will be used to show graphics over the video player rendering window. You can know if the OSD is enabled or disabled through a call to the VideoPlayer.OSDIsEnabled method.

 

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

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

 

 

Syntax

 

[Visual Basic]

control.VideoPlayer.OSDEnable (

nPlayer as Integer,

bEnable as enumBoolean

) as enumErrorCodes


 

[C++]

short control.VideoPlayer.OSDEnable (

short nPlayer,

short bEnable

);


 

Parameter

Description

 

 

nPlayer

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

bEnable

Boolean value that determines if the OSD is enabled or disabled.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE

0

Disable the OSD

BOOL_TRUE

1

Enable the OSD

 

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred, check the LastError property value in order to get the error code

enumErrorCodes.ERR_NOERROR (0)

The method call was successful