Copyright © 2005-2018 MultiMedia Soft

VideoPlayer.OSDItemAlphaGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the current alpha channel transparency applied to the graphical item on the On-Screen-Display (OSD). The value can be modified through the VideoPlayer.OSDItemAlphaSet 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 OSDItemAlphaGet (

nPlayerIndex as Int16,

nItemUniqueId as Int32,

ByRef nAlpha as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDItemAlphaGet (

Int16 nPlayerIndex,

Int32 nItemUniqueId,

ref Int16 nAlpha

);


 

[C++]

public: enumErrorCodes OSDItemAlphaGet (

Int16 nPlayerIndex,

Int32 nItemUniqueId,

Int16 __gc *nAlpha

);


 

Parameter

Description

 

 

nPlayerIndex

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

nItemUniqueId

Unique identifier of the item returned by a previous call to one between the following methods: VideoPlayer.OSDItemPictureFileAdd, VideoPlayer.OSDItemBitmapAdd, VideoPlayer.OSDItemTextAdd, VideoPlayer.OSDItemOutlineTextAdd or VideoPlayer.OSDItemRectangleAdd

nAlpha

Reference that, on return from the method call, will contain the alpha channel transparency expressed in percentage. Values can range from 0 (total opacity) to 100 (total transparency).

 

 

 

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.