Copyright © 2001-2018 MultiMedia Soft

VideoMixer.PlayerZOrderGet method

Previous pageReturn to chapter overviewNext page



Obtains the current value of the Z-Order applied to the video clip loaded into the given player. The value for the Z-Order  can be modified through the VideoMixer.PlayerZOrderSet 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]

control.VideoMixer.PlayerZOrderGet (

nMixerUniqueId as Long,

nPlayer as Integer,

nZOrder as Long

) as enumErrorCodes



short control.VideoMixer.PlayerZOrderGet (

long nMixerUniqueId,

short nPlayer,

long *nZOrder








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


Number representing the zero-based index of the player attached to the video mixer through a previous call to the VideoPlayer.AttachToVideoMixer method.


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

Players with a lower Z-Order value will stay on top respect to other players having a higher Z-Order value; for example, a player with Z-Order 0 will stay on top of any other player but, in case two players 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, check the LastError property value in order to get the error code

enumErrorCodes.ERR_NOERROR (0)

The method call was successful