Copyright © 2005-2018 MultiMedia Soft

VideoPlayer.OSDItemScrollByPixels method

Previous pageReturn to chapter overviewNext page

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 class section.

For details about video clips rendering refer to the How to play video files through DirectShow tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function OSDItemScrollByPixels (

nPlayerIndex as Int16,

nItemUniqueId as Int32,

xOffset as Int32,

yOffset as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDItemScrollByPixels (

Int16 nPlayerIndex,

Int32 nItemUniqueId,

Int32 xOffset,

Int32 yOffset

);


 

[C++]

public: enumErrorCodes OSDItemScrollByPixels (

Int16 nPlayerIndex,

Int32 nItemUniqueId,

Int32 xOffset,

Int32 yOffset

);


 

Parameter

Description

 

 

nPlayerIndex

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 (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.