CAMSchedule.AddAdvisePacket 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 AddAdvisePacket method adds an advise request to the list of pending requests.

Syntax

DWORD_PTR AddAdvisePacket(
  [ref] const REFERENCE_TIME &time1,
  [ref] const REFERENCE_TIME &time2,
              HANDLE         hNotify,
              BOOL           bPeriodic
);

Parameters

time1 [ref]

Requested time for the advise.

time2 [ref]

For periodic advise requests, the time between notifications. This parameter is ignored if bPeriodic is FALSE.

hNotify

Handle to a semaphore if bPeriodic is TRUE, or handle to an event if bPeriodic is FALSE.

bPeriodic

Boolean value that specifies whether to add a periodic notification or a one-shot notification. If TRUE, the notification is periodic; the time2 parameter specifies the time between notifications. If FALSE, the notification occurs only once.

Return value

Returns an identifier for the advise request (the "cookie"). If the method fails, the return value is zero.

Requirements

See also

CAMSchedule Class