Copyright © 2001-2018 MultiMedia Soft

VideoMixer.OSDEnable method

Previous pageReturn to chapter overviewNext page

Remarks

 

Enables/disables the On-Screen-Display (OSD) that will be used to show graphics over the video mixer window. You can know if the OSD is enabled or disabled through a call to the VideoMixer.OSDIsEnabled method.

 

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.OSDEnable (

nMixerUniqueId as Long,

bEnable as enumBoolean,

bZoomContentsOnResize as enumBoolean

) as enumErrorCodes


 

[C++]

short control.VideoMixer.OSDEnable (

long nMixerUniqueId,

short bEnable,

short bZoomContentsOnResize

);


 

Parameter

Description

 

 

nMixerUniqueId

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

bEnable

Boolean value that determines if the OSD is enabled or disabled.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE

0

Disable the OSD

BOOL_TRUE

1

Enable the OSD

bZoomContentsOnResize

Boolean value that determines if items inside the OSD will be zoomed to fit inside the OSD area after a resize of the video mixer window.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE

0

Don't zoom items on resize of the video mixer window

BOOL_TRUE

1

Zoom items on resize of the video mixer window

 

 

 

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