Share via

CSPROPERTY_VIDCAP_VIDEOCONTROL (Compact 2013)

  • Article

3/26/2014

This enumeration provides values that represent the properties in the PROPSETID_VIDCAP_VIDEOCONTROL property set. They describe aspects of video control.

Syntax

typedef enum {
  CSPROPERTY_VIDEOCONTROL_CAPS,
  CSPROPERTY_VIDEOCONTROL_ACTUAL_FRAME_RATE,
  CSPROPERTY_VIDEOCONTROL_FRAME_RATES,
  CSPROPERTY_VIDEOCONTROL_MODE
} CSPROPERTY_VIDCAP_VIDEOCONTROL;

Elements

  • CSPROPERTY_VIDEOCONTROL_CAPS
    Used to identify the video control capabilities of the device. This property must be implemented.

    The property value (operation data) is a ULONG.

    The VideoControlCaps member of the CSPROPERTY_VIDEOCONTROL_CAPS_S structure is used to specify the video control capabilities of the device.

  • CSPROPERTY_VIDEOCONTROL_ACTUAL_FRAME_RATE
    Used to get the frame rate at which the device is streaming for the specified pin. This property is optional.

    The property value (operation data) is a CSPROPERTY_VIDEOCONTROL_ACTUAL_FRAME_RATE_S structure.

  • CSPROPERTY_VIDEOCONTROL_FRAME_RATES
    Used to enumerate the available frame rates. This property is optional.

    The property value (operation data) is a CSPROPERTY_VIDEOCONTROL_FRAME_RATES_S structure.

    The available frame rates are returned in a CSMULTIPLE_ITEM array. The application sends the minidriver a CSPROPERTY_VIDEOCONTROL_FRAMES_RATES request specifying the stream index and image dimensions in a CSPROPERTY_VIDEOCONTROL_FRAME_RATES_S structure. The minidriver returns frame rates information in the caller's CSMULTIPLE_ITEM array buffer. This buffer has a fixed header (CSMULTIPLE_ITEM), and a variable length amount of data following it based on the values in the CSMULTIPLE_ITEM structure.

    Individual values are in 100-nansecond increments.

    If the size of the buffer passed to the minidriver is zero, the minidriver should set the NumberOfBytesToTransfer member of the HW_STREAM_REQUEST_BLOCK structure passed to the minidriver to the size of the buffer required and return STATUS_BUFFER_OVERFLOW.

  • CSPROPERTY_VIDEOCONTROL_MODE
    Used to control the mode of image production. This includes settings for horizontal and vertical image flipping, and enabling frame capture by an external trigger. This property is optional.

    The property value (operation data) is a LONG.

    The Mode member of the CSPROPERTY_VIDEOCONTROL_MODE_S structure is used to specify the video control mode.

Remarks

The following table summarizes the usages for the CSPROPERTY_VIDCAP_VIDEOCONTROL property types.

Property

Get

Set

Target

Property Descriptor Type

Property Value Type

CSPROPERTY_VIDEOCONTROL_CAPS

Yes

No

Filter

CSPROPERTY_VIDEOCONTROL_CAPS_S

ULONG

CSPROPERTY_VIDEOCONTROL_ACTUAL_FRAME_RATE

Yes

No

Filter

CSPROPERTY_VIDEOCONTROL_ACTUAL_FRAME_RATE_S

CSPROPERTY_VIDEOCONTROL_ACTUAL_FRAME_RATE_S

CSPROPERTY_VIDEOCONTROL_FRAME_RATES

Yes

No

Filter

CSPROPERTY_VIDEOCONTROL_FRAME_RATES_S

CSPROPERTY_VIDEOCONTROL_FRAME_RATES_S

CSPROPERTY_VIDEOCONTROL_MODE

Yes

Yes

Filter

CSPROPERTY_VIDEOCONTROL_MODE_S

LONG

Requirements

Header

csmedia.h

See Also

Reference

Camera Driver Enumerations
CSPROPERTY_VIDEOCONTROL_CAPS_S
CSPROPERTY_VIDEOCONTROL_ACTUAL_FRAME_RATE_S
CSPROPERTY_VIDEOCONTROL_FRAME_RATES_S
CSMULTIPLE_ITEM
CSPROPERTY_VIDEOCONTROL_MODE_S