IOverlay::Advise (Compact 2013)

  • Article

3/26/2014

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

Syntax

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 Value

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

Header

dshow.h

Library

Strmiids.lib

See Also

Reference

IOverlay Interface