IAMLine21Decoder::SetBackgroundColor method (il21dec.h)

[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.]

The SetBackgroundColor method sets the background color that the Line 21 Decoder filter uses for overlay. The default background color is magenta.

Generally, applications should not call this method. The background color must match the overlay color key, which is defined by the downstream rendering filter.

Syntax

HRESULT SetBackgroundColor(
  DWORD dwPhysColor
);

Parameters

dwPhysColor

Sets the background color as a pixel color value. The meaning of the pixel value is defined by the bit depth of the filter's current output format.

Return value

Returns S_OK if successful, or an error code otherwise.

Requirements

See also

Error and Success Codes

IAMLine21Decoder Interface

IAMLine21Decoder::GetBackgroundColor