|
VideoMixer.OSDItemTextChange method |
  
|
|
VideoMixer.OSDItemTextChange method |
|
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] control.VideoMixer.OSDItemTextChange ( nMixerUniqueId as Long, nItemUniqueId as Long, strText as String, pLogFont as long, strFacename as String, color as OLE_COLOR, nAlignment as enumTextAlignment ) as enumErrorCodes |
[C++] short control.VideoMixer.OSDItemTextChange ( long nMixerUniqueId, long nItemUniqueId, LPCTSTR strText, long pLogFont, LPCTSTR strFacename, OLE_COLOR color, short nAlignment ); |
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.OSDItemTextAdd 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 |
||||||||||||
nAlignment |
Text alignment respect to the item's rectangle. Supported values are the following:
|
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 |
