|
VideoMixer.OSDBackgroundBitmapSet method |
  
|
|
VideoMixer.OSDBackgroundBitmapSet method |
|
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] control.VideoMixer.OSDBackgroundBitmapSet ( nMixerUniqueId as Long, hBitmap as OLE_HANDLE, bKeepAspectRatio as enumBoolean ) as enumErrorCodes |
[C++] short control.VideoMixer.OSDBackgroundBitmapSet ( long nMixerUniqueId, OLE_HANDLE hBitmap, short 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:
|
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 |
