IAMWstDecoder::SetHoldPage 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 SetHoldPage method to tell the WST decoder to hold the current WST page. When the WST decoder holds a page, any updates from the TV stream are turned off. It is as though the page was paused in real time.

Syntax

HRESULT SetHoldPage(
  [in] BOOL bHoldPage
);

Parameters

[in] bHoldPage

Specifies whether to hold the current page.

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