Copyright © 2005-2018 MultiMedia Soft

VideoMixer.OSDBackgroundPictureFileSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets a picture file 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 OSDBackgroundPictureFileSet (

nMixerUniqueId as Int32,

strPathname as String,

bKeepAspectRatio as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes OSDBackgroundPictureFileSet (

Int32 nMixerUniqueId,

string strPathname,

bool bKeepAspectRatio

);


 

[C++]

public: enumErrorCodes OSDBackgroundPictureFileSet (

Int32 nMixerUniqueId,

string strPathname,

bool bKeepAspectRatio

);


 

Parameter

Description

 

 

nMixerUniqueId

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

strPathname

Absolute pathname of the picture file.

Accepted picture formats are BMP, GIF, JPEG and PNG.

You can use an empty string 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.