VideoPlayer.OSDItemRectGet method |
|
Remarks
Obtains the coordinates of the rectangle surrounding the 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.OSDItemRectGet ( nPlayer as Integer, nItemUniqueId as Long, fLeftPos as Single, fTopPos as Single, fRightPos as Single, fBottomPos as Single ) as enumErrorCodes |
[C++] short control.VideoPlayer.OSDItemRectGet ( short nPlayer, long nItemUniqueId, float fLeftPos, float fTopPos, float fRightPos, float fBottomPos ); |
Parameter |
Description |
|
|
nPlayer |
Number representing the zero-based index of the player that will use the video player. |
nItemUniqueId |
Unique identifier of the item returned by a previous call to one between the following methods: VideoPlayer.OSDItemPictureFileAdd, VideoPlayer.OSDItemBitmapAdd, VideoPlayer.OSDItemTextAdd, VideoPlayer.OSDItemOutlineTextAdd or VideoPlayer.OSDItemRectangleAdd. |
fLeftPos |
Reference that, on return from the method call, will contain the left position, expressed in percentage of the On-Screen-Display (OSD) area, of the rectangle surrounding the item, |
fTopPos |
Reference that, on return from the method call, will contain the top position, expressed in percentage of the On-Screen-Display (OSD) area, of the rectangle surrounding the item, |
fRightPos |
Reference that, on return from the method call, will contain the right position, expressed in percentage of the On-Screen-Display (OSD) area, of the rectangle surrounding the item, |
fBottomPos |
Reference that, on return from the method call, will contain the bottom position, expressed in percentage of the On-Screen-Display (OSD) area, of the rectangle surrounding the item, |
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 |