Copyright © 2001-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]

control.VideoMixer.OSDItemIsOnVisibleArea (

nMixerUniqueId as Long,

nItemUniqueId as Long,

bIsVisible as enumBoolean

) as enumErrorCodes


 

[C++]

short control.VideoMixer.OSDItemIsOnVisibleArea (

long nMixerUniqueId,

long nItemUniqueId,

short *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

Value

Meaning

BOOL_FALSE

0

The item is outside of the visible area

BOOL_TRUE

1

The item is inside the visible area

 

 

 

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