Share via


CSPROPERTY_VIDCAP_VIDEOPROCAMP (Compact 2013)

3/26/2014

This enumeration defines values that represent the properties in the PROPSETID_VIDCAP_VIDEOPROCAMP property set.

Syntax

typedef enum {
  CSPROPERTY_VIDEOPROCAMP_BRIGHTNESS,
  CSPROPERTY_VIDEOPROCAMP_CONTRAST,
  CSPROPERTY_VIDEOPROCAMP_HUE,
  CSPROPERTY_VIDEOPROCAMP_SATURATION,
  CSPROPERTY_VIDEOPROCAMP_SHARPNESS,
  CSPROPERTY_VIDEOPROCAMP_GAMMA,
  CSPROPERTY_VIDEOPROCAMP_COLORENABLE,
  CSPROPERTY_VIDEOPROCAMP_WHITEBALANCE,
  CSPROPERTY_VIDEOPROCAMP_BACKLIGHT_COMPENSATION,
  CSPROPERTY_VIDEOPROCAMP_GAIN,
} CSPROPERTY_VIDCAP_VIDEOPROCAMP;

Elements

  • CSPROPERTY_VIDEOPROCAMP_BRIGHTNESS
    Used to set and get the brightness setting. This property is optional.

    The property value (operation data) is a LONG.

    The Value member of the CSPROPERTY_VIDEOPROCAMP_S structure is used to specify the brightness. This value is expressed in IRE units times 100 for NTSC sources. For non-NTSC sources, the units are arbitrary, with 0 representing blanking and 10000 representing pure white.

    Every video capture minidriver must define a range and default value for this property. The required range must be -10000 through +10000. The default value must be 750 (7.5 IRE).

    Brightness is also known as the black level. Modifying the brightness setting shifts the entire video signal equally for all luminance values.

  • CSPROPERTY_VIDEOPROCAMP_CONTRAST
    Used to set or get the camera's contrast (luma gain) setting. This property is optional.

    The property value (operation data) is a LONG.

    The Value member of the CSPROPERTY_VIDEOPROCAMP_S structure is used to specify the contrast value. The contrast value is expressed as a gain factor multiplied by 100.

    Every video capture minidriver must define a range and default value for the Value member of this property. The required range must be 0 to 10000. The default value must be 100 (1x).

  • CSPROPERTY_VIDEOPROCAMP_HUE
    Used to set and get the hue setting of the camera. This property is optional.

    The property value (operation data) is a LONG.

    The Value member of the CSPROPERTY_VIDEOPROCAMP_S structure is used to specify the hue setting. The value of the hue setting is expressed in degrees multiplied by 100.

    Every video capture minidriver must define a range and default value for the Value member of this property. The required range must be -18000 to 18000 (-180 to +180 degrees). The default value must be 0.

  • CSPROPERTY_VIDEOPROCAMP_SATURATION
    Used to set and get the saturation, or chroma gain, setting of the camera. This property is optional.

    The property value (operation data) is a LONG.

    The Value member of the CSPROPERTY_VIDEOPROCAMP_S structure is used to specify the saturation setting. The value of the saturation setting is expressed as gain multiplied by 100.

    Every video capture minidriver must define a range and default value for this property. The required range must be 0 through 10000. The default value must be 100 (1x).

  • CSPROPERTY_VIDEOPROCAMP_SHARPNESS
    Used to set and get the camera's sharpness setting. This property is optional.

    The property value (operation data) is a LONG.

    The Value member of the CSPROPERTY_VIDEOPROCAMP_S structure is used to specify the sharpness setting. Sharpness is expressed in arbitrary units.

    Every video capture minidriver must define a range and default value for the value of this property. The required range must be 0 through 100. The default value must be 50.

  • CSPROPERTY_VIDEOPROCAMP_GAMMA
    Used to get and set the camera's gamma setting. This property is optional.

    The property value (operation data) is a LONG.

    The Value member of the CSPROPERTY_VIDEOPROCAMP_S structure is used to specify the gamma setting. The value of the gamma setting is expressed in gamma multiplied by 100.

    Every video capture minidriver must define a range and default value for this property. The required range must be 1 through 500. The default value is typically 100 (gamma = 1) or 220 (gamma = 2.2), depending on the display medium and video hardware.

  • CSPROPERTY_VIDEOPROCAMP_COLORENABLE
    Used to set and retrieve the color enable setting. This property is optional.

    The property value (operation data) is a LONG.

    The Value member of the CSPROPERTY_VIDEOPROCAMP_S structure is used to specify the color enable setting. A value of 0 indicates that color is disabled. The default value of 1 indicates that color is enabled.

    This value may be either 0 or 1. The default value for this property is 1

  • CSPROPERTY_VIDEOPROCAMP_WHITEBALANCE
    Used to set or get the camera's white balance setting. This property is optional.

    The property value (operation data) is a LONG.

    The Value member of the CSPROPERTY_VIDEOPROCAMP_S structure specifies the white balance setting. The white balance value is expressed as a color temperature, in degrees Kelvin.

    The range and default value for white balance is device-dependent. Every video capture minidriver must define a range and default value for this property.

  • CSPROPERTY_VIDEOPROCAMP_BACKLIGHT_COMPENSATION
    Used to set and get the backlight compensation setting on the camera. This property is optional.

    The property value (operation data) is a LONG.

    The Value member of the CSPROPERTY_VIDEOPROCAMP_S structure is used to specify the backlight compensation. A value of 0 indicates that the backlight compensation is disabled. The default value of 1 indicates that the backlight compensation is enabled.

    This value may be either 0 or 1. The default value for this property is 1.

    The values used in the property sets are multiplied by 100 to give improved granularity.

  • CSPROPERTY_VIDEOPROCAMP_GAIN
    Used to set or get the camera gain. This property is optional.

    The property value (operation data) is a LONG.

    The Value member of the CSPROPERTY_VIDEOPROCAMP_S structure specifies the requested or current gain, depending on whether this is a get or set request.

    The OEM defines the range for gain; the default resolution is 1.

Remarks

All CSPROPERTY_VIDCAP_VIDEOPROCAMP property elements have a filter target, can be used in get or set operations, and have the CSPROPERTY_VIDEOPROCAMP_S property descriptor type, with a LONG property value type.

Requirements

Header

csmedia.h

See Also

Reference

Camera Driver Enumerations
CSPROPERTY_VIDEOPROCAMP_S