Copyright © 2005-2018 MultiMedia Soft

VideoMixer.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 mixer see the VideoMixer object section.

For details about video mixing/blending refer to the How to use the video mixer tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function OSDItemRemove (

nMixerUniqueId as Int32,

nItemUniqueId as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDItemRemove (

Int32 nMixerUniqueId,

Int32 nItemUniqueId

);


 

[C++]

public: enumErrorCodes OSDItemRemove (

Int32 nMixerUniqueId,

Int32 nItemUniqueId

);


 

Parameter

Description

 

 

nMixerUniqueId

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

nItemUniqueId

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

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