[Visual Basic]

Public Function OSDItemPictureFileAdd (

nPlayerIndex as Int16,

strPathname as String,

fLeftPos as Single,

fTopPos as Single,

nAlpha as Int16,

nZOrder as Int32,

bShow as enumBoolean

) as Int32

[C#]

public Int32 OSDItemPictureFileAdd (

Int16 nPlayerIndex,

string strPathname,

float fLeftPos,

float fTopPos,

Int16 nAlpha,

Int16 nZOrder,

bool bShow

);

[C++]

public: Int32 OSDItemPictureFileAdd (

Int16 nPlayerIndex,

string strPathname,

float fLeftPos,

float fTopPos,

Int16 nAlpha,

Int16 nZOrder,

bool bShow

);

Parameter

Description

nPlayerIndex

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

strPathname

Absolute pathname of the picture file. The picture file can be modified at a later time through the VideoPlayer.OSDItemPictureFileChange method.

Accepted picture formats are BMP, GIF, JPEG and PNG.

fLeftPos

Horizontal position, expressed in percentage of the On-Screen-Display (OSD) area, where the item will be rendered.

Position can be moved at a later time through the VideoPlayer.OSDItemMove method.

fTopPos

Vertical position, expressed in percentage of the On-Screen-Display (OSD) area, where the item will be rendered.

Position can be moved at a later time through the VideoPlayer.OSDItemMove method.

nAlpha

Alpha channel transparency, expressed in percentage, applied to the item when rendered. Values can range from 0 (total opacity) to 100 (total transparency).

The alpha channel transparency of the item can be modified at a later time through the VideoPlayer.OSDItemAlphaSet method.

nZOrder

Z-Order of the item.

Items with a lower Z-Order value will stay on top respect to other Items having a higher Z-Order value; for example, an Item with Z-Order 0 will stay on top of any other Item but, in case two Items should be assigned the same Z-Order, the latest one having got the same Z-Order will be placed on top of the previous one.

The Z-Order of the item can be modified at a later time through the VideoPlayer.OSDItemZOrderSet method.

bShow

Boolean flag that specifies if the item must be initially visible or hidden.

Supported values are the following:

Visibility can be modified at a later time through the VideoPlayer.OSDItemShow method.

Value

Meaning

0

An error occurred (see the LastError property for further error details)

Other values

Unique identifier of the graphical item: this unique identifier will be used in order to invoke further methods related to the use of this specific item