Copyright © 2005-2018 MultiMedia Soft

VideoPlayer.OSDItemRemove method

Previous pageReturn to chapter overviewNext page

Remarks

 

Removes the given graphical item from 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 OSDItemRemove (

nPlayerIndex as Int16,

nItemUniqueId as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDItemRemove (

Int16 nPlayerIndex,

Int32 nItemUniqueId

);


 

[C++]

public: enumErrorCodes OSDItemRemove (

Int16 nPlayerIndex,

Int32 nItemUniqueId

);


 

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.

Set this parameter to -1 for removing all of the available items in one single shot.

 

 

 

Return value

 

Value

Meaning

 

 

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