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] Public Function OSDItemScrollByPixels ( nMixerUniqueId as Int32, nItemUniqueId as Int32, xOffset as Int32, yOffset as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes OSDItemScrollByPixels ( Int32 nMixerUniqueId, Int32 nItemUniqueId, Int32 xOffset, Int32 yOffset ); |
[C++] public: enumErrorCodes OSDItemScrollByPixels ( Int32 nMixerUniqueId, Int32 nItemUniqueId, Int32 xOffset, Int32 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 (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |