IVideoWindow::get_BackgroundPalette method (control.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 get_BackgroundPalette method queries whether the video window realizes its palette in the background..

Syntax

HRESULT get_BackgroundPalette(
  [out] long *pBackgroundPalette
);

Parameters

[out] pBackgroundPalette

Receives one of the following values.

Value	Description
OATRUE	The video window realizes the palette in the background.
OAFALSE	The video window does not realize the palette in the background.

Return value

Possible return values include the following:

Return code	Description
E_POINTER	NULL pointer.
S_OK	Success.
VFW_E_NOT_CONNECTED	The video renderer filter is not connected.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	control.h (include Dshow.h)
Library	Strmiids.lib

See also

Error and Success Codes

IVideoWindow Interface

IVideoWindow::put_BackgroundPalette