IReferenceClock::AdviseTime method

[The feature associated with this page, Windows Media Format 11 SDK, is a legacy feature. It has been superseded by Source Reader and Sink Writer. Source Reader and Sink Writer have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Source Reader and Sink Writer instead of Windows Media Format 11 SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The AdviseTime method requests an asynchronous notification that a time has elapsed.

Syntax

HRESULT AdviseTime(
  [in]  REFERENCE_TIME rtBaseTime,
  [in]  REFERENCE_TIME rtStreamTime,
  [in]  HEVENT         hEvent,
  [out] DWORD          *pdwAdviseCookie
);

Parameters

rtBaseTime [in]

Base reference time, in 100-nanosecond units.

rtStreamTime [in]

Stream offset time, in 100-nanosecond units.

hEvent [in]

Handle to an event, created by the caller. This event will be signaled when the time specified elapses.

pdwAdviseCookie [out]

Pointer to a variable that receives an identifier for the request. This is used to identify this call to AdviseTime in the future for example, to cancel the request.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
E_POINTER	The pdwAdviseCookie parameter is NULL.
E_FAIL	Unspecified failure.

See also

IReferenceClock Interface