IWMReaderStreamClock::SetTimer

The SetTimer method sets a timer on the clock.

Syntax

HRESULT SetTimer(
  QWORD  cnsWhen,
  void  *pvParam,
  DWORD*  pdwTimerId
);

Parameters

cnsWhen

[in] Specifies the time at which the reader will give you the IWMReaderCallback::OnStatus callback.

*pvParam

[in] Specifies a pointer to the timer context parameters you want returned in the OnStatus callback.

pdwTimerId

[out] If the method succeeds, returns a pointer to a double word containing the timer identifier.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code	Description
E_INVALIDARG	pdwTimerId is NULL.
E_OUTOFMEMORY	Not enough available memory.

Remarks

All timers are automatically terminated whenever you stop the reader. When a timer expires, you receive an IWMReaderCallback::OnStatus callback with WMT_TIMER as the WMT_STATUS enumerated type and hr == S_OK, pValue ==TimerID and pvContext==pvParam.

See Also

Previous

Next