Copyright © 2005-2018 MultiMedia Soft

VideoPlayer.OSDItemRectGet method

Previous pageReturn to chapter overviewNext page

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

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

 

 

Syntax

 

[Visual Basic]

Public Function OSDItemRectGet (

nPlayerIndex as Int16,

nItemUniqueId as Int32,

ByRef fLeftPos as Single,

ByRef fTopPos as Single,

ByRef fRightPos as Single,

ByRef fBottomPos as Single

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDItemRectGet (

Int16 nPlayerIndex,

Int32 nItemUniqueId

ref float fLeftPos,

ref float fTopPos,

ref float fRightPos,

ref float fBottomPos

);


 

[C++]

public: enumErrorCodes OSDItemRectGet (

Int16 nPlayerIndex,

Int32 nItemUniqueId

float __gc *fLeftPos,

float __gc *fTopPos,

float __gc *fRightPos,

float __gc *fBottomPos

);


 

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.

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

enumErrorCodes.NOERROR (0)

The method call was successful.