Copyright © 2005-2018 MultiMedia Soft

VideoPlayer.OSDKeyColorSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets the key color that will be rendered as transparent on the On-Screen-Display (OSD). The current key color can be obtained through the VideoPlayer.OSDKeyColorGet method.

 

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

nPlayerIndex as Int16,

colorKey as Color

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDKeyColorSet (

Int16 nPlayerIndex,

Color colorKey

);


 

[C++]

public: enumErrorCodes OSDKeyColorSet (

Int16 nPlayerIndex,

Color colorKey

);


 

Parameter

Description

 

 

nPlayerIndex

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

colorKey

Key color rendered as transparent

 

 

 

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.