CSPROPERTY_PIN (Compact 2013)

3/26/2014

This enumeration provides values that represent the properties in the CSPROPERTY_Pin property set. They describe the types of property queries that can be made for a camera pin.

Syntax

typedef enum {
  CSPROPERTY_PIN_CINSTANCES = 0,
  CSPROPERTY_PIN_CTYPES,
  CSPROPERTY_PIN_DATARANGES,
  CSPROPERTY_PIN_DATAINTERSECTION,
  CSPROPERTY_PIN_CATEGORY,
  CSPROPERTY_PIN_NAME,
} CSPROPERTY_PIN;

Elements

• CSPROPERTY_PIN_CINSTANCES
  Used to query for the current number of pins this pin factory has instantiated, as well as the maximum number of pins this pin factory can instantiate, per filter.

  This property returns a structure of type CSPIN_CINSTANCES.

  This property specifies the per-filter maximum for a given pin factory.

  Stream minidrivers do not need to handle this property directly; the stream class driver handles this property using stream request blocks to query for more information.

• CSPROPERTY_PIN_CTYPES
  Used to query the camera driver for the number of pin types it supports.

  This property returns a value of type ULONG, specifying the number of pin factories the CS filters it supports.

  Stream minidrivers do not need to handle this property directly; the stream class driver handles this property using stream request blocks to query for more information.

• CSPROPERTY_PIN_DATARANGES
  Used to determine the data ranges supported by pins instantiated by the pin factory.

  Specify this property using CSP_PIN, where the PinId member specifies the pin factory for which to return acceptable data ranges.

  CS filters return all data ranges supported by pins instantiated by the pin factory. A CS filter may not support a reported data range in its current internal state.

  Stream minidrivers do not need to handle this property directly; the stream class driver handles this property using stream request blocks to query for more information.

• CSPROPERTY_PIN_DATAINTERSECTION
  Used to find a data format supported by pins instantiated by the pin factory. The client supplies a list of data formats; the CS filter returns the first data format on the list that is supported.

  To specify this property, provide a CSP_PIN structure followed by a CSMULTIPLE_ITEM structure and a sequence of 64-bit aligned CSDATARANGE structures. The value in CSP_PIN.PinId specifies the pin factory.

  This property returns the first matching data format from the client-supplied list.

  Stream minidrivers do not need to handle this property directly; the stream class driver handles this property using stream request blocks to query for more information.

• CSPROPERTY_PIN_CATEGORY
  Used to query the camera driver for a pin's type (preview, capture, or still).

  The PinId member of the CSP_PIN structure specifies the pin factory for which to return the category GUID.

  The CS filter uses this property to indicate the standard functional category of pins instantiated by the pin factory.

  Stream minidrivers do not need to handle this property directly; the stream class driver handles this property using stream request blocks to query for more information where necessary.

• CSPROPERTY_PIN_DEVICENAME
  Used to query the camera driver for a pin's name. Drivers can assign any name to a pin, but typically the name will be PIN1:.

  Specify this property using CSP_PIN, where the member specifies the pin factory for which to return the registry name.

  Stream minidrivers do not need to handle this property directly; the stream class driver handles this property using stream request blocks to query for more information.

Remarks

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

Property	Get	Set	Target	Property Descriptor Type	Property Value Type
CSPROPERTY_PIN_CINSTANCES	Yes	No	Pin	CSP_PIN	CSPIN_CINSTANCES
CSPROPERTY_PIN_CTYPES	Yes	No	Pin	CSPROPERTY	ULONG
CSPROPERTY_PIN_DATARANGES	Yes	No	Pin	CSP_PIN	A CSMULTIPLE_ITEM structure, followed by a sequence of 64-bit aligned CSDATARANGE structures.
CSPROPERTY_PIN_DATAINTERSECTION	Yes	No	Pin	CSP_PIN	CSDATAFORMAT
CSPROPERTY_PIN_CATEGORY	Yes	No	Pin	CSP_PIN	GUID
CSPROPERTY_PIN_NAME	Yes	No	Pin	CSP_PIN	A buffer containing the Unicode string.

Requirements

Header

cs.h

See Also

Reference

Camera Driver Enumerations
CSPIN_CINSTANCES
CSP_PIN
CSMULTIPLE_ITEM
CSDATARANGE
CSPROPERTY
CSDATAFORMAT