Edit

KSPROPERTY_CAMERACONTROL_EXTENDED_PHOTOTRIGGERTIME

  • Article

This property controls the trigger time for the camera driver. The trigger time is used in determining a reference frame for a photo sequence.

Usage Summary Table

Get Set Target Property descriptor type Property value type

Yes

Yes

Pin

KSPROPERTY

KSCAMERA_EXTENDEDPROP_HEADER

The property value (operation data) contains a KSCAMERA_EXTENDEDPROP_HEADER structure and a KSCAMERA_EXTENDEDPROP_VALUE structure. The photo trigger time, in 100 nanosecond units, is set or returned as value in KSCAMERA_EXTENDEDPROP_VALUE.

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 trigger time is set or cleared using the one of the following flags in the Flags member of KSCAMERA_EXTENDEDPROP_HEADER.

Trigger time flag Description
KSPROPERTY_CAMERA_PHOTOTRIGGERTIME_CLEAR Clear the trigger time setting.
KSPROPERTY_CAMERA_PHOTOTRIGGERTIME_SET Set a new trigger time value.

This property control is synchronous 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 read the max frame rate.

Otherwise, 0.
Capability 0
Flags Set or Clear flag

If the trigger time is not currently set to any time value, the Flags member of KSCAMERA_EXTENDEDPROP_HEADER must contain KSPROPERTY_CAMERA_PHOTOTRIGGERTIME_CLEAR value.

Setting the Property

When the property is set, the ull member of KSCAMERA_EXTENDEDPROP_VALUE will contain the trigger time value. The trigger time is set or cleared based on the operation flag. When the flag is KSPROPERTY_CAMERA_PHOTOTRIGGERTIME_CLEAR the value in KSCAMERA_EXTENDEDPROP_VALUE is not used and is ignored.

Requirements

Version

Available starting with Windows 8.1.

Header

 Ksmedia.h (include Ksmedia.h)