[Visual Basic]

control.VideoMixer.OSDItemOutlineTextAdd (

nMixerUniqueId as Long,

strText as String,

fLeftPos as Single,

fTopPos as Single,

nAlpha as Integer,

nZOrder as Long,

bShow as enumBoolean,

pLogFont as Long,

strFacename as String,

color as OLE_COLOR,

colorOutline as OLE_COLOR,

nAlignment as enumTextAlignment,

nOutlineWidth as Integer

) as Long

[C++]

long control.VideoMixer.OSDItemOutlineTextAdd (

long nMixerUniqueId,

LPCTSTR strText,

float fLeftPos,

float fTopPos,

short nAlpha,

long nZOrder,

short bShow,

long pLogFont,

LPCTSTR strFacename,

OLE_COLOR color,

OLE_COLOR colorOutline,

short nAlignment,

short nOutlineWidth

);

Parameter

Description

nMixerUniqueId

Unique identifier of the video mixer returned by a previous call to the VideoMixer.Create method

strText

Text string.

The text string can can be modified at a later time through the VideoMixer.OSDItemOutlineTextChange 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 VideoMixer.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 VideoMixer.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 VideoMixer.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 VideoMixer.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 VideoMixer.OSDItemShow method.

pLogFont

Address in memory of the the 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 VideoMixer.OSDItemOutlineTextChange 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 VideoMixer.OSDItemOutlineTextChange method.

color

Color used to render this item.

This setting can can be modified at a later time through the VideoMixer.OSDItemOutlineTextChange method.

colorOutline

Color used to render the outline of the text.

This setting can can be modified at a later time through the VideoMixer.OSDItemOutlineTextChange method.

nAlignment

Text alignment respect to the item's rectangle.

Supported values are the following:

This setting can can be modified at a later time through the VideoMixer.OSDItemOutlineTextChange method.

nOutlineWidth

Width of the outline expressed in pixels.

This setting can can be modified at a later time through the VideoMixer.OSDItemOutlineTextChange 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