Edit

Share via

ColorKey Property

  • Article

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Note

This component is available for use in the Microsoft Windows 2000, Windows XP, and Windows Server 2003 operating systems. It may be altered or unavailable in subsequent versions.

 

The ColorKey property sets or retrieves the color key used in closed captioning.

[ iColorKey = ] MSWebDVD.ColorKey

Return Value

Returns an integer value representing the color to use as a transparent background for closed-captioned text. The default value in 256 colors is magenta, and off-black in any other color depth.

Remarks

This property is read/write. This property applies only to the closed-captions, if any exist, not to the subpicture stream.