Microsoft DirectX 9.0 |
The Calibrate method calibrates an external device's
Syntax
HRESULT Calibrate(
HEVENT hEvent,
long Mode,
long *pStatus
);
Parameters
hEvent
[in] Handle to an event. The event is signaled when the action is complete.
Mode
[in] Specifies a value that activates or deactivates the calibration process:
Value | Description |
ED_ACTIVE | Activates the calibration process. |
ED_INACTIVE | Deactivates the calibration process. |
NULL | No action; return the calibration status in pStatus. |
pStatus
[out] Pointer to a long integer that receives one of the following values:
Value | Description |
OATRUE | Calibration is active. |
OAFALSE | Calibration is inactive. |
Return Values
When this method succeeds, it returns S_OK. Otherwise it returns an HRESULT error code.
Remarks
Use this method on certain external devices that require calibration; for example, rewinding a tape and resetting the counter, or computing the frame offset for a timecode reader.
Filters for various external devices can implement this method differently, depending on the calibration that the device needs. This method assumes the IMediaEventSink interface has already established an event sink, or that another event signaling method has been established.
DV Implementation
MSDV does not support this method. It returns E_NOTIMPL.
See Also