Copyright © 2005-2018 MultiMedia Soft

VideoPlayer.OSDItemTextAdd method

Previous pageReturn to chapter overviewNext page

Remarks

 

Adds a string of text as a new graphical item on the On-Screen-Display (OSD).

 

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

nPlayerIndex as Int16,

strText as String,

fLeftPos as Single,

fTopPos as Single,

nAlpha as Int16,

nZOrder as Int32,

bShow as Boolean,

LogFont as ADJ_LOGFONT,

strFacename as String,

color as Color,

nAlignment as enumTextAlignment

) as Int32


 

[C#]

public Int32 OSDItemTextAdd (

Int16 nPlayerIndex,

string strText,

float fLeftPos,

float fTopPos,

Int16 nAlpha,

Int32 nZOrder,

bool bShow,

ADJ_LOGFONT LogFont,

string strFacename,

Color color,

enumTextAlignment nAlignment

);


 

[C++]

public: Int32 OSDItemTextAdd (

Int16 nPlayerIndex,

string strText,

float fLeftPos,

float fTopPos,

Int16 nAlpha,

Int32 nZOrder,

bool bShow,

ADJ_LOGFONT LogFont,

string strFacename,

Color color,

enumTextAlignment nAlignment

);


 

Parameter

Description

 

 

nPlayerIndex

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

strText

Text string.

The text string can can be modified at a later time through the VideoPlayer.OSDItemTextChange method.

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:

Mnemonic constant

Meaning

false

The item is initially kept hidden

true

The item is immediately shown

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

LogFont

LOGFONT structure containing the font settings used to render this item.

Refer to the Microsoft documentation for details about the LOGFONT structure. The lfFaceName member of the LOGFONT structure is currently ignored: use the strFacename parameter below for passing the typeface of the font.

This setting can can be modified at a later time through the VideoPlayer.OSDItemTextChange method.

strFacename

String containing the typeface of the font, for example "Arial" or "Times New Roman".

This setting can can be modified at a later time through the VideoPlayer.OSDItemTextChange method.

color

Color used to render this item.

This setting can can be modified at a later time through the VideoPlayer.OSDItemTextChange method.

nAlignment

Text alignment respect to the item's rectangle.

Supported values are the following:

Mnemonic constant

Value

Meaning

TEXT_ALIGN_LEFT

0

Text is left aligned

TEXT_ALIGN_CENTER

1

Text is centered

TEXT_ALIGN_RIGHT

2

Text is right aligned

This setting can can be modified at a later time through the VideoPlayer.OSDItemTextChange method.

 

 

 

Return value

 

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