Copyright © 2005-2018 MultiMedia Soft

VideoMixer.OSDItemZOrderGet method

Previous pageReturn to chapter overviewNext page



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 VideoMixer.OSDItemZOrderSet method.


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.





[Visual Basic]

Public Function OSDItemZOrderGet (

nMixerUniqueId as Int32,

nItemUniqueId as Int32,

ByRef nZOrder as Int32

) as enumErrorCodes



public enumErrorCodes OSDItemZOrderGet (

Int32 nMixerUniqueId,

Int32 nItemUniqueId,

ref Int32 nZOrder




public: enumErrorCodes OSDItemZOrderGet (

Int32 nMixerUniqueId,

Int32 nItemUniqueId,

Int32 __gc *nZOrder








Unique identifier of the video mixer returned by a previous call to the VideoMixer.Create method


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


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






Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.