KSPROPERTY_CAMERACONTROL_S_EX structure (ksmedia.h)
Specifies a camera control operation, including setting the flash, the image pin control properties, the region of interest in the image, or video stabilization. This structure describes filter-based properties in the PROPSETID_VIDCAP_CAMERACONTROL property set.
Supported starting with Windows 8.
Syntax
typedef struct {
KSPROPERTY Property;
LONG Value;
ULONG Flags;
ULONG Capabilities;
RECT FocusRect;
} KSPROPERTY_CAMERACONTROL_S_EX, *PKSPROPERTY_CAMERACONTROL_S_EX;
Members
Property
Specifies an initialized KSPROPERTY structure that describes the property set, property ID, and request type.
Value
Specifies the value of the property. This member is read/write.
Flags
Indicates, for Get requests, the current setting for the specified property from the values listed below. Indicates, for Set requests, the desired setting for the specified property from the values listed below. This member can be a bitwise OR of the following values that are defined in Ksmedia.h:
Value | Description |
---|---|
KSPROPERTY_CAMERACONTROL_FLAGS_AUTO | Indicates that the setting is controlled automatically. If the driver receives this value, it should set the camera control synchronously to automatic mode and then return. |
KSPROPERTY_CAMERACONTROL_FLAGS_MANUAL | Indicates that the setting is controlled manually. If the driver receives this value, it should set the camera control synchronously to manual mode and then return. |
KSPROPERTY_CAMERACONTROL_FLAGS_ASYNCHRONOUS | Indicates whether the driver should perform the camera control operation asynchronously—where the application has issued a command for the driver to set up the camera control settings in advance of taking a picture. This flag must be set only if either KSPROPERTY_CAMERACONTROL_FLAGS_MANUAL or KSPROPERTY_CAMERACONTROL_FLAGS_AUTO are set. If this flag value and the KSPROPERTY_CAMERACONTROL_FLAGS_AUTO flag value are both set, the driver should initiate a worker thread to start one requested control operation and should reject all other requests for the same operation until it has completed the first one. After the operation has successfully completed, the driver should trigger the KSEVENTSETID_CameraAsyncControl event. |
Capabilities
If set, indicates that when the application submits a query, the driver should return the value of the Capabilities member of the appropriate camera control structure from the following list.
FocusRect
A RECT structure that specifies the rectangular region in which the device should set the focus. This structure is available only to Windows desktop applications.
Remarks
When a requested camera focus operation is completed or is canceled, the driver should generate an event specified by the KSEVENT_CAMERACONTROL_FOCUS enumeration value.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows 8 |
Minimum supported server | Windows Server 2012 |
Header | ksmedia.h (include Ksmedia.h) |
See also
KSPROPERTY_CAMERACONTROL_FLASH_S
KSPROPERTY_CAMERACONTROL_REGION_OF_INTEREST_S