Copyright © 2005-2018 MultiMedia Soft

VideoMixer.OSDItemTextChange method

Previous pageReturn to chapter overviewNext page

Remarks

 

Changes the string and settings of the given 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]

Public Function OSDItemTextChange (

nMixerUniqueId as Int32,

nItemUniqueId as Int32,

strText as String,

LogFont as ADJ_LOGFONT,

strFacename as String,

color as Color,

nAlignment as enumTextAlignment

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDItemTextChange (

Int32 nMixerUniqueId,

Int32 nItemUniqueId,

string strText,

ADJ_LOGFONT LogFont,

string strFacename,

Color color,

enumTextAlignment nAlignment

);


 

[C++]

public: enumErrorCodes OSDItemTextChange (

Int32 nMixerUniqueId,

Int32 nItemUniqueId,

string strText,

ADJ_LOGFONT LogFont,

string strFacename,

Color color,

enumTextAlignment nAlignment

);


 

Parameter

Description

 

 

nMixerUniqueId

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

strText

Text string.

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.

strFacename

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

color

Color used to render this item.

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

 

 

 

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.