IOverlay::Advise

  • Article

This method sets up an advise link for the overlay events specified by the dwInterests parameter.

HRESULT Advise(
  IOverlayNotify* pOverlayNotify,
  DWORD dwInterests
);

Parameters

  • pOverlayNotify
    [in] Notification interface.
  • dwInterests
    [in] Callbacks of interest, which can be any subset of the following events.
    Value Description
    ADVISE_NONE No changes.
    ADVISE_CLIPPING Change in clipping region (synchronized with the window).
    ADVISE_PALETTE Change in palette.
    ADVISE_COLORKEY Change of chroma key value.
    ADVISE_POSITION Change in position of video window (not synchronized with the window).
    ADVISE_ALL All of the above.

Return Values

None.

Remarks

This method sets up an advise link for the IOverlayNotify interface to receive notifications. If one of these events occurs, the appropriate entry point in the pOverlayNotify parameter passed in is called (IOverlayNotify::OnClipChange, IOverlayNotify::OnColorKeyChange, IOverlayNotify::OnPaletteChange, or IOverlayNotify::OnPositionChange).

Only one advise link can be set on any given IOverlay interface. Trying to set another notification interface on second and subsequent calls returns VFW_E_ADVISE_ALREADY_SET. You can cancel an advise link by using IOverlay::Unadvise.

Requirements

DirectShow applications and DirectShow filters have different include file and link library requirements. See Setting Up the Build Environment for more information.

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.

See Also

IOverlay Interface

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.