Edit

Share via

KSPROPERTY_CAMERACONTROL_EXTENDED_OIS

  • Article

KSPROPERTY_CAMERACONTROL_EXTENDED_OIS is a property ID that is used to control optical image stabilization (OIS) on the driver.

Usage summary table

Scope Control Type

Version 1

Filter

Synchronous

The following flags can be placed in the KSCAMERA_EXTENDEDPROP_HEADER.Flags field to control optical image stabilization. The default should be AUTO if AUTO is supported, or ON otherwise.

#define KSCAMERA_EXTENDEDPROP_OIS_OFF   0x0000000000000000
#define KSCAMERA_EXTENDEDPROP_OIS_ON    0x0000000000000001
#define KSCAMERA_EXTENDEDPROP_OIS_AUTO  0x0000000000000002

If the driver supports this control, it must support OIS_ON and OIS_OFF.

If the driver does not support optical image stabilization, the driver should not implement this control.

The SET call of this control has no effect when the video or photo pin is in KSSTATE_RUN state. The driver shall reject the SET call received if either video or photo pin is in running state and returns STATUS_INVALID_DEVICE_STATE. In a GET call, driver should return the current settings in Flags field.

The following table describes the flag capabilities.

Flag Description

KSCAMERA_EXTENDEDPROP_OIS_OFF

This is a mandatory capability. When specified, the optical image stabilization is disabled in the driver.

KSCAMERA_EXTENDEDPROP_OIS_ON

This is a mandatory capability. When specified, the optical image stabilization is enabled in the driver. This flag is mutually exclusive with the OIS_AUTO and OIS_OFF flags.

KSCAMERA_EXTENDEDPROP_OIS_AUTO

This capability is optional. When specified, the driver that supports such capability will determine whether optical image stabilization should be turned on or off. This flag is mutually exclusive with the OIS_ON and OIS_OFF flags.

The table below contains the descriptions and requirements for the KSCAMERA_EXTENDEDPROP_HEADER structure fields when using the control.

Member Description

Version

This must be 1.

PinId

This must be KSCAMERA_EXTENDEDPROP_FILTERSCOPE (0xFFFFFFFF).

Size

This must be sizeof(KSCAMERA_EXTENDEDPROP_HEADER) + sizeof(KSCAMERA_EXTENDEDPROP_VALUE).

Result

Indicates the error results of the last SET operation. If no SET operation has taken place, this must be 0.

Capability

Must be a bitwise OR of the supported KSCAMERA_EXTENDEDPROP_OIS_* flags defined above.

Flags

This is a read/write field. This can be any one of the KSCAMERA_EXTENDEDPROP_OIS_* flags defined above.

Requirements

Header

 Ksmedia.h