CAMSchedule.Advise method

[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.]

The Advise method dispatches all requests that are scheduled for a specified time or earlier.

Syntax

REFERENCE_TIME Advise(
  [ref] const REFERENCE_TIME &rtTime
);

Parameters

rtTime [ref]

Value that specifies the current reference time.

Return value

Returns the reference time of the next scheduled advise request, or MAX_TIME if there are none left.

Remarks

When the clock calls this method, it specifies the current reference time. The scheduler determines which advise requests have expired, if any, and dispatches them. If a one-shot request expires, the scheduler deletes it. If a periodic request expires, the scheduler re-schedules it for the next advise time. The method returns the time of the next pending request.

To dispatch an advise request, the scheduler signals the event or semaphore given in the hNotify parameter of the CAMSchedule::AddAdvisePacket method.

Requirements

Requirement Value
Header
Dsschedule.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CAMSchedule Class