IAMLine21Decoder::GetDrawBackgroundMode 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 GetDrawBackgroundMode method indicates whether the Line 21 Decoder filter draws the captions on a transparent background or an opaque background. By default, the caption background is opaque.

Syntax

HRESULT GetDrawBackgroundMode(
  AM_LINE21_DRAWBGMODE *lpMode
);

Parameters

lpMode

Pointer a variable that receives a member of the AM_LINE21_DRAWBGMODE enumeration.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
E_INVALIDARG
Invalid argument
S_OK
Success

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header il21dec.h
Library Strmiids.lib

See also

Error and Success Codes

IAMLine21Decoder Interface

IAMLine21Decoder::SetDrawBackgroundMode