Copyright © 2005-2018 MultiMedia Soft

VideoPlayer.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 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 OSDItemIsOnVisibleArea (

nPlayerIndex as Int16,

nItemUniqueId as Int32,

ByRef bIsVisible as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDItemIsOnVisibleArea (

Int16 nPlayerIndex,

Int32 nItemUniqueId,

ref bool bIsVisible

);


 

[C++]

public: enumErrorCodes OSDItemIsOnVisibleArea (

Int16 nPlayerIndex,

Int32 nItemUniqueId,

bool __gc *bIsVisible

);


 

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

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:

false

0

The item is outside of the visible area

true

1

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.