VideoMixer.OSDKeyColorGet method |
|
Remarks
Obtains the current key color that will be rendered as transparent on the On-Screen-Display (OSD). The key color can be modified through the VideoMixer.OSDKeyColorSet 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 OSDKeyColorGet ( nMixerUniqueId as Int32 ) as Color |
[C#] public Color OSDKeyColorGet ( Int32 nMixerUniqueId ); |
[C++] public: Color OSDKeyColorGet ( Int32 nMixerUniqueId ); |
Parameter |
Description |
|
|
nMixerUniqueId |
Unique identifier of the video mixer returned by a previous call to the VideoMixer.Create method |
Return value
Value |
Meaning |
|
|
Color.Empty |
An error occurred (see the LastError property for further error details) |
Other color value |
The current key color |