IAMWstDecoder::GetDrawBackgroundMode method (iwstdec.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.]

Downstream filters use the GetDrawBackgroundMode method to determine whether the caption text background is opaque or transparent.

Syntax

HRESULT GetDrawBackgroundMode(
  [out] AM_WST_DRAWBGMODE *lpMode
);

Parameters

[out] lpMode

Receives a member of the AM_WST_DRAWBGMODE enumeration. This parameter receives one of the following values.

Return value

When the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

See also

Error and Success Codes

IAMWstDecoder Interface