Edit

ACX_PIN_CONFIG structure (acxpin.h)

  • Article

The ACX_PIN_CONFIG structure is used to configure a pin.

Syntax

typedef struct _ACX_PIN_CONFIG {
  ULONG                 Size;
  ULONG                 Flags;
  ULONG                 Id;
  ACX_PIN_TYPE          Type;
  ACX_PIN_COMMUNICATION Communication;
  ACX_PIN_QUALIFIER     Qualifier;
  const GUID            *Category;
  const GUID            *Name;
  PACX_PIN_CALLBACKS    PinCallbacks;
  ULONG                 PropertiesCount;
  ULONG                 MethodsCount;
  PACX_PROPERTY_ITEM    Properties;
  PACX_METHOD_ITEM      Methods;
  union {
    PACX_MICROPHONE_CONFIG MicrophoneConfig;
  } u;
  ULONG                 MaxStreams;
} ACX_PIN_CONFIG, *PACX_PIN_CONFIG;

Members

Size

The size of all of the data in the ACX_PIN_CONFIG structure in bytes. This field is set by the ACX_PIN_CONFIG_INIT function.

Flags

A combination of values from the ACX_PIN_CONFIG_FLAGS enum that describe the pin.

Id

An identifier associated with the pin.

Type

An ACX_PIN_TYPE enum value that specifies the type of the pin.

Communication

An ACX_PIN_COMMUNICATION enum value that specifies the communication type of the pin.

Qualifier

An ACX_PIN_QUALIFIER enum value that specifies how the pin is connected in the multi-circuit audio topology.

Category

A GUID value representing the category of the pin.

Name

A GUID value representing the name of the pin.

PinCallbacks

A pointer to an ACX_PIN_CALLBACKS structure that specifies the callback functions for the pin.

PropertiesCount

Specifies the size of the array pointed to by the Properties field.

MethodsCount

Specifies the size of the array pointed to by the Methods field.

Properties

A pointer to an array of ACX_PROPERTY_ITEM structures containing pin properties.

Methods

A pointer to an array of ACX_METHOD_ITEM structures containing pin methods.

u

A union used to specify the additional type configuration of the pin.

u.MicrophoneConfig

A pointer to an ACX_MICROPHONE_CONFIG structure associated with the pin.

MaxStreams

Specifies the maximum number of streams supported by the pin.

Remarks

Instances of the ACX_PIN_CONFIG structure must be initialized by calling the ACX_PIN_CONFIG_INIT function.

ACX requirements

Minimum ACX version: 1.0

For more information about ACX versions, see ACX version overview.

Requirements

Requirement Value
Header acxpin.h

See also