Copyright © 2001-2018 MultiMedia Soft

VideoMixer.OSDItemOutlineTextChange method

Previous pageReturn to chapter overviewNext page

Remarks

 

Changes the string and settings of the given outlined text item on the On-Screen-Display (OSD).

 

For further details about the use of the embedded video mixer see the VideoMixer object section.

For details about video mixing/blending refer to the How to use the video mixer tutorial.

 

 

Syntax

 

[Visual Basic]

control.VideoMixer.OSDItemOutlineTextChange (

nMixerUniqueId as Long,

nItemUniqueId as Long,

strText as String,

pLogFont as long,

strFacename as String,

color as OLE_COLOR,

colorOutline as OLE_COLOR,

nAlignment as enumTextAlignment,

nOutlineWidth as Integer

) as enumErrorCodes


 

[C++]

short control.VideoMixer.OSDItemOutlineTextChange (

long nMixerUniqueId,

long nItemUniqueId,

LPCTSTR strText,

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

nItemUniqueId

Unique identifier of item returned by a previous call to the VideoMixer.OSDItemOutlineTextAdd method

strText

Text string

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.

strFacename

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

color

Color used to render this item

colorOutline

Color used to render the outline of the text.

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

nOutlineWidth

Width of the outline expressed in pixels.

 

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred, check the LastError property value in order to get the error code

enumErrorCodes.ERR_NOERROR (0)

The method call was successful