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

Public Function OSDEnable (

nMixerUniqueId as Int32,

bEnable as Boolean,

bZoomContentsOnResize as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDEnable (

Int32 nMixerUniqueId,

bool bEnable,

bool bZoomContentsOnResize

);


 

[C++]

public: enumErrorCodes OSDEnable (

Int32 nMixerUniqueId,

bool bEnable,

bool 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

Meaning

false

Disable the OSD

true

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

Meaning

false

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

true

Zoom items on resize of the video mixer window

 

 

 

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.