IAMLine21Decoder::SetBackgroundColor

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 Values

Returns S_OK if successful, or an error code otherwise.

See Also

• Error and Success Codes
• IAMLine21Decoder Interface
• IAMLine21Decoder::GetBackgroundColor