VideoMixer.OSDKeyColorSet method |
|
Remarks
Sets the key color that will be rendered as transparent on 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 OSDKeyColorSet ( nMixerUniqueId as Int32, colorKey as Color ) as enumErrorCodes |
[C#] public enumErrorCodes OSDKeyColorSet ( Int32 nMixerUniqueId, Color colorKey ); |
[C++] public: enumErrorCodes OSDKeyColorSet ( Int32 nMixerUniqueId, Color colorKey ); |
Parameter |
Description |
|
|
nMixerUniqueId |
Unique identifier of the video mixer returned by a previous call to the VideoMixer.Create method |
colorKey |
Key color rendered as transparent |
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. |