VideoPlayer.OSDItemScrollByPixels method |
|
Remarks
Scrolls the position of the graphical item on the On-Screen-Display (OSD) by a given amount of pixels.
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.OSDItemScrollByPixels ( nPlayer as Integer, nItemUniqueId as Long, xOffset as Long, yOffset as Long ) as enumErrorCodes |
[C++] short control.VideoPlayer.OSDItemScrollByPixels ( short nPlayer, long nItemUniqueId, long xOffset, long yOffset ); |
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 |
xOffset |
Horizontal offset, expressed in pixels, used to scroll the item |
yOffset |
Vertical offset, expressed in pixels, used to scroll 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 |