|
VideoPlayer.OSDItemTextChange method |
  
|
|
VideoPlayer.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 player see the VideoPlayer object section.
For details about video clips rendering refer to the How to play video files through DirectShow tutorial.
Syntax
[Visual Basic] control.VideoPlayer.OSDItemTextChange ( nPlayer as Integer, nItemUniqueId as Long, strText as String, pLogFont as long, strFacename as String, color as OLE_COLOR, nAlignment as enumTextAlignment ) as enumErrorCodes |
[C++] short control.VideoPlayer.OSDItemTextChange ( short nPlayer, long nItemUniqueId, LPCTSTR strText, long pLogFont, LPCTSTR strFacename, OLE_COLOR color, short nAlignment ); |
Parameter |
Description |
||||||||||||
|
|
||||||||||||
nPlayer |
Number representing the zero-based index of the player that will use the video player. |
||||||||||||
nItemUniqueId |
Unique identifier of item returned by a previous call to the VideoPlayer.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 |
