Share via


CSPROPERTY_CONNECTION (Compact 2013)

3/26/2014

This enumeration provides values that are used to describe a pin's connection. It contains the properties of the CSPROPSETID_Connection property set (see IOCTL_CS_PROPERTY).

Syntax

typedef enum {
  CSPROPERTY_CONNECTION_STATE,
  CSPROPERTY_CONNECTION_DATAFORMAT,
  CSPROPERTY_CONNECTION_ALLOCATORFRAMING,
  CSPROPERTY_CONNECTION_PROPOSEDATAFORMAT,
  CSPROPERTY_CONNECTION_ALLOCATORFRAMING_EX
} CSPROPERTY_CONNECTION;

Elements

  • CSPROPERTY_CONNECTION_STATE
    Sets the current run state of the pin. This property returns a value from the CSSTATE enumeration.

    The pin only reads or writes data in the CSSTATE_RUN state. Both individual pins and the CS filter as a whole may support this property.

  • CSPROPERTY_CONNECTION_DATAFORMAT
    Used to get or set the current data format.

    This property returns a CSDATAFORMAT specifying the current data format.

    CS filters only need to support this property if they allow clients to reset the current property, or if connections can be made with the data format incompletely specified.

  • CSPROPERTY_CONNECTION_ALLOCATORFRAMING
    Used to determine framing requirements for a pin.

    This property returns a CSALLOCATOR_FRAMING structure, which describes the framing requirements for the pin. For example, the FrameSize member specifies the frame size of data on the pin.

    AVStream minidrivers should use CSPROPERTY_CONNECTION_ALLOCATORFRAMING_EX.

  • CSPROPERTY_CONNECTION_PROPOSEDATAFORMAT
    Used to propose a new data format for the connection.

    This property returns a CSDATAFORMAT specifying the proposed data format.

    The CS filter returns STATUS_SUCCESS if the pin can be reset to the proposed data format, or an error code otherwise. Note that this property request does not change the data format. Clients use CSPROPERTY_CONNECTION_DATAFORMAT to change the format.

  • CSPROPERTY_CONNECTION_ALLOCATORFRAMING_EX
    Used to determine framing requirements for a pin.

    This property returns a CSALLOCATOR_FRAMING_EX structure that describes the framing requirements for an AVStream pin.

    Minidrivers running under stream class should use CSPROPERTY_CONNECTION_ALLOCATORFRAMING.

Remarks

The following table summarizes the usages of the CSPROPERTY_CONNECTION connection types.

Connection Type

Get

Set

Target

Property Descriptor Type

Property Value Type

CSPROPERTY_CONNECTION_STATE

No

Yes

Filter or Pin

CSPROPERTY

CSSTATE

CSPROPERTY_CONNECTION_DATAFORMAT

Yes

Yes

Pin

CSPROPERTY

CSDATAFORMAT

CSPROPERTY_CONNECTION_ALLOCATORFRAMING

Yes

No

Pin

CSPROPERTY

CSALLOCATOR_FRAMING

CSPROPERTY_CONNECTION_PROPOSEDATAFORMAT

No

Yes

Pin

CSPROPERTY

CSDATAFORMAT

CSPROPERTY_CONNECTION_ALLOCATORFRAMING_EX

Yes

No

Pin

CSPROPERTY

CSALLOCATOR_FRAMING_EX

Setting the CS_PROPERT_CONNECTION_STATE to CSSTATE_RUN on a still image pin will succeed, even if the state is not actually changed.

Requirements

Header

cs.h

See Also

Reference

Camera Driver Enumerations
IOCTL_CS_PROPERTY
CSSTATE
CSDATAFORMAT
CSALLOCATOR_FRAMING
CSALLOCATOR_FRAMING_EX
CSPROPERTY