Copyright © 2005-2018 MultiMedia Soft

VideoMixer.OSDItemIsOnVisibleArea method

Previous pageReturn to chapter overviewNext page

Remarks

 

Determines if the given graphical item is currently positioned inside the visible area of 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 OSDItemIsOnVisibleArea (

nMixerUniqueId as Int32,

nItemUniqueId as Int32,

ByRef bIsVisible as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDItemIsOnVisibleArea (

Int32 nMixerUniqueId,

Int32 nItemUniqueId,

ref bool bIsVisible

);


 

[C++]

public: enumErrorCodes OSDItemIsOnVisibleArea (

Int32 nMixerUniqueId,

Int32 nItemUniqueId,

bool __gc *bIsVisible

);


 

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

bIsVisible

Reference to a boolean value that, on return from the method call, will tell if the item is inside the visible area of the OSD.

Supported values are the following:

Mnemonic constant

Meaning

false

The item is outside of the visible area

true

The item is inside the visible area

 

 

 

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.