Copyright © 2005-2018 MultiMedia Soft

VideoMixer.OSDBackgroundBitmapSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets a bitmap to display as a background for 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 OSDBackgroundBitmapSet (

nMixerUniqueId as Int32,

hBitmap as IntPtr,

bKeepAspectRatio as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDBackgroundBitmapSet (

Int32 nMixerUniqueId,

IntPtr hBitmap,

bool bKeepAspectRatio

);


 

[C++]

public: enumErrorCodes OSDBackgroundBitmapSet (

Int32 nMixerUniqueId,

IntPtr hBitmap,

bool bKeepAspectRatio

);


 

Parameter

Description

 

 

nMixerUniqueId

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

hBitmap

Handle of the bitmap (HBITMAP). You can set this parameter to 0 for removing an existing background bitmap.

bKeepAspectRatio

Boolean value that determines if the bitmap must keep its original aspect ratio

Supported values are the following:

Mnemonic constant

Meaning

false (default)

Don't keep aspect ratio

true

Keep aspect ratio

 

 

 

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.