IReferenceClock::AdviseTime

 
Microsoft DirectShow 9.0

IReferenceClock::AdviseTime

The AdviseTime method creates a one-shot advise request.

Syntax

HRESULT AdviseTime(
  REFERENCE_TIME rtBaseTime,
  REFERENCE_TIME rtStreamTime,
  HEVENT hEvent,
  DWORD_PTR *pdwAdviseCookie
);

Parameters

rtBaseTime

[in] Base reference time, in 100-nanosecond units. See Remarks.

rtStreamTime

[in] Stream offset time, in 100-nanosecond units. See Remarks.

hEvent

[in] Handle to an event, created by the caller.

pdwAdviseCookie

[out] Pointer to a variable that receives an identifier for the advise request.

Return Value

Returns an HRESULT value. Possible values include the following.

Return code Description
S_OK Success.
E_INVALIDARG Invalid time values.
E_OUTOFMEMORY Failure.
E_POINTER NULL pointer argument.

Remarks

This method creates a one-shot advise request for the reference time baseTime + streamTime. The sum must be greater than zero and less than MAX_TIME, or the method returns E_INVALIDARG. At the requested time, the clock signals the event specified in the hEvent parameter.

To cancel the notification before the time is reached, call the Unadvise method and pass the pdwAdviseToken value returned from this call. After the notification has occurred, the clock automatically clears it, so it is not necessary to call Unadvise. However, it is not an error to do so.

Requirements

Header: Declared in Strmif.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also


Show: