VideoMixer.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 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.OSDItemScrollByPixels ( nMixerUniqueId as Long, nItemUniqueId as Long, xOffset as Long, yOffset as Long ) as enumErrorCodes |
[C++] short control.VideoMixer.OSDItemScrollByPixels ( long nMixerUniqueId, long nItemUniqueId, long xOffset, long yOffset ); |
Parameter |
Description |
|
|
nMixerUniqueId |
Unique identifier of the video mixer returned by a previous call to the VideoMixer.Create method |
nItemUniqueId |
Unique identifier of the item returned by a previous call to one between the following methods: VideoMixer.OSDItemPictureFileAdd, VideoMixer.OSDItemBitmapAdd, VideoMixer.OSDItemTextAdd or VideoMixer.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 |