IWMReaderStreamClock::SetTimer method (wmsdkidl.h)
[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 SetTimer method sets a timer on the clock.
Syntax
HRESULT SetTimer(
[in] QWORD cnsWhen,
[in] void *pvParam,
[out] DWORD *pdwTimerId
);
Parameters
[in] cnsWhen
Specifies the time at which the reader notifies the OnStatus callback, in 100-nanosecond units.
[in] pvParam
Specifies a pointer to the timer context parameters that are returned in the OnStatus callback.
[out] pdwTimerId
Pointer to a DWORD containing the timer identifier.
Return value
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
| Return code | Description |
|---|---|
|
The method succeeded. |
|
pdwTimerId is NULL. |
|
Not enough available memory. |
Remarks
The application must execute IWMReader::Open, and successfully receive a WMT_OPENED status notification to its IWMStatusCallback::OnStatus method, before it creates any timers.
All timers are automatically terminated when the application stops the reader. When a timer expires, the following happens:
- The OnStatus method is called with WMT_TIMER, as the WMT_STATUS enumeration type
- The parameter hr is set to S_OK
- pValue is set to the TimerID
- pvContext is set to the pvParam pointer that is specified in this method
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only],Windows Media Format 7 SDK, or later versions of the SDK |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | wmsdkidl.h (include Wmsdk.h) |
| Library | Wmvcore.lib; WMStubDRM.lib (if you use DRM) |