KSPROPERTY_CAMERACONTROL_EXTENDED_PHOTOTHUMBNAIL
This property gets or sets the thumbnail capability for the camera. If a scaling factor is provided, then thumbnails are enabled at the selected scale.
Usage Summary Table
| Get | Set | Target | Property descriptor type | Property value type |
|---|---|---|---|---|
Yes |
Yes |
Pin |
The property value (operation data) contains a KSCAMERA_EXTENDEDPROP_HEADER structure and a KSCAMERA_EXTENDEDPROP_VALUE structure. The KSCAMERA_EXTENDEDPROP_VALUE is required but the Value member is ignored.
The total property data size is sizeof(KSCAMERA_EXTENDEDPROP_HEADER) + sizeof(KSCAMERA_EXTENDEDPROP_VALUE). The Size member of KSCAMERA_EXTENDEDPROP_HEADER is set to this total property data size.
The Capability member of KSCAMERA_EXTENDEDPROP_HEADER contains a bitwise OR combination of one or more of the following scale values supported.
| Thumbnail scale flag | Description |
|---|---|
| KSCAMERA_EXTENDEDPROP_PHOTOTHUMBNAIL_DISABLE | Thumbnails are disabled. |
| KSCAMERA_EXTENDEDPROP_PHOTOTHUMBNAIL_2X | Thumbnail resolution is X/2 and Y/2. |
| KSCAMERA_EXTENDEDPROP_PHOTOTHUMBNAIL_2X | Thumbnail resolution is X/4 and Y/4. |
| KSCAMERA_EXTENDEDPROP_PHOTOTHUMBNAIL_8X | Thumbnail resolution is X/8 and Y/8. |
| KSCAMERA_EXTENDEDPROP_PHOTOTHUMBNAIL_16X | Thumbnail resolution is X/16 and Y/16. |
The Flags member of KSCAMERA_EXTENDEDPROP_HEADER contains the thumbnail scale value currently set for the camera. If thumbnail generation is not enabled, then only KSCAMERA_EXTENDEDPROP_PHOTOTHUMBNAIL_DISABLE is set in Flags.
This property control is asynchronous and not cancelable.
Remarks
Getting the property
When responding to a KSPROPERTY_TYPE_GET request, the driver sets the members of the KSCAMERA_EXTENDEDPROP_HEADER to the following.
| Member | Value |
|---|---|
| Version | 1 |
| PinId | The pin ID for the photo pin. |
| Size | sizeof(KSCAMERA_EXTENDEDPROP_HEADER) + sizeof(KSCAMERA_EXTENDEDPROP_VALUE) |
| Result | An error value resulting from the attempt to get the thumbnail settings. |
| Capability | KSCAMERA_EXTENDEDPROP_CAPS_ASYNCCONTROL | (thumbnail scale values supported). |
| Flags | The current thumbnail value setting (only one value). |
Setting the property
When the property is set, a KSPROPERTY_TYPE_SET request, the Flags member of KSCAMERA_EXTENDEDPROP_HEADER will contain one of the thumbnail scale flags.
Requirements
Version |
Available starting with Windows 8.1. |
Header |
Ksmedia.h (include Ksmedia.h) |