|
VideoPlayer.OSDItemOutlineTextChange method |
  
|
|
VideoPlayer.OSDItemOutlineTextChange method |
|
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 player see the VideoPlayer class section.
For details about video clips rendering refer to the How to play video files through DirectShow tutorial.
Syntax
[Visual Basic] Public Function OSDItemOutlineTextChange ( nPlayerIndex as Int16, nItemUniqueId as Int32, strText as String, LogFont as ADJ_LOGFONT, strFacename as String, color as Color, colorOutline as Color, nAlignment as enumTextAlignment, nOutlineWidth as Int16 ) as enumErrorCodes |
[C#] public enumErrorCodes OSDItemOutlineTextChange ( Int16 nPlayerIndex, Int32 nItemUniqueId, string strText, ADJ_LOGFONT LogFont, string strFacename, Color color, Color colorOutline, enumTextAlignment nAlignment, Int16 nOutlineWidth ); |
[C++] public: enumErrorCodes OSDItemOutlineTextChange ( Int16 nPlayerIndex, Int32 nItemUniqueId, string strText, ADJ_LOGFONT LogFont, string strFacename, Color color, Color colorOutline, enumTextAlignment nAlignment, Int16 nOutlineWidth ); |
Parameter |
Description |
||||||||||||
|
|
||||||||||||
nPlayerIndex |
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.OSDItemOutlineTextAdd 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 |
||||||||||||
colorOutline |
Color used to render the outline of the text. |
||||||||||||
nAlignment |
Text alignment respect to the item's rectangle. Supported values are the following:
|
||||||||||||
nOutlineWidth |
Width of the outline expressed in pixels. |
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. |
