Copyright © 2005-2018 MultiMedia Soft

VideoPlayer.OSDItemZOrderGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the current Z-Order applied to the graphical item on the On-Screen-Display (OSD). The value for the Z-Order can be modified through the VideoPlayer.OSDItemZOrderSet method.

 

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 OSDItemZOrderGet (

nPlayerIndex as Int16,

nItemUniqueId as Int32,

ByRef nZOrder as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDItemZOrderGet (

Int16 nPlayerIndex,

Int32 nItemUniqueId,

ref Int32 nZOrder

);


 

[C++]

public: enumErrorCodes OSDItemZOrderGet (

Int16 nPlayerIndex,

Int32 nItemUniqueId,

Int32 __gc *nZOrder

);


 

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

nZOrder

Reference that, on return from the method call, will contain the Z-Order for the given OSD item.

Items with a lower Z-Order value will stay on top respect to other items having a higher Z-Order value; for example, an item with Z-Order 0 will stay on top of any other item but, in case two items should be assigned the same Z-Order, the latest one having got the same Z-Order will be placed on top of the previous one.

 

 

 

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.