acxpin.h header
This header is used by the ACX audio class extensions.
For more information, see:
Note
The ACX headers and libraries are not included in the WDK 10.0.22621.2428 (released October 24, 2023), but are available in previous versions, as well as the latest (25000 series builds) Insider Preview of the WDK. For more information about preview versions of the WDK, see Installing preview versions of the Windows Driver Kit (WDK).
acxpin.h contains the following programming interfaces:
Functions
| ACX_CONNECTION_INIT Initializes an ACX_CONNECTION structure for use in configuring a connection. |
| ACX_INTERLEAVED_AUDIO_FORMAT_INFORMATION_INIT The ACX_INTERLEAVED_AUDIO_FORMAT_INFORMATION_INIT function initializes an ACX_INTERLEAVED_AUDIO_FORMAT_INFORMATION structure for use. |
| ACX_JACK_CALLBACKS_INIT The ACX_JACK_CALLBACKS_INIT function initializes an ACX_JACK_CALLBACKS structure for use. |
| ACX_JACK_CONFIG_INIT The ACX_JACK_CONFIG_INIT macro calls the ACX_JACK_CONFIG_INIT_ID function with the default ID value. |
| ACX_JACK_CONFIG_INIT_ID The ACX_JACK_CONFIG_INIT_ID function initializes an ACX_JACK_CONFIG structure with the specified ID. |
| ACX_MICARRAYGEOMETRY_CONFIG_INIT The ACX_MICARRAYGEOMETRY_CONFIG_INIT function initializes an ACX_MICARRAYGEOMETRY_CONFIG structure for use. |
| ACX_MICROPHONE_CONFIG_INIT The ACX_MICROPHONE_CONFIG_INIT function initialized an ACX_MICROPHONE_CONFIG structure for use. |
| ACX_PHYSICAL_CONNECTION_INIT The ACX_PHYSICAL_CONNECTION_INIT function initializes an ACX_PHYSICAL_CONNECTION structure for use. |
| ACX_PIN_CALLBACKS_INIT The ACX_PIN_CALLBACKS_INIT function initializes an ACX_PIN_CALLBACKS structure for use. |
| ACX_PIN_CONFIG_INIT The ACX_PIN_CONFIG_INIT macro calls the ACX_PIN_CONFIG_INIT_ID function with the default ID value. |
| ACX_PIN_CONFIG_INIT_ID The ACX_PIN_CONFIG_INIT_ID function initializes an ACX_PIN_CONFIG structure with the specified ID. |
| AcxJackChangeStateNotification The AcxJackChangeStateNotification function indicates that a change in the state of the specified jack has occurred. |
| AcxJackCreate The AcxJackCreate function creates and initializes a new audio jack object. |
| AcxMicArrayGeometryAddMicrophoneCoordinates The AcxMicArrayGeometryAddMicrophoneCoordinates function adds physical coordinates to a microphone array geometry. |
| AcxMicArrayGeometryCreate The AcxMicArrayGeometryCreate function creates and initializes a new ACXMICARRAYGEOMETRY object. |
| AcxPinAddEvents The AcxPinAddEvents function adds an array of events to the specified pin. |
| AcxPinAddJacks The AcxPinAddJacks function adds an array of jacks to the specified pin. |
| AcxPinAddStreamBridges The AcxPinAddStreamBridges function adds stream bridges to the specified pin. |
| AcxPinAssignModeDataFormatList The AcxPinAssignModeDataFormatList function assigns a mode data format list to the specified pin. |
| AcxPinCreate The AcxPinCreate function creates and initializes a new ACXPIN object. |
| AcxPinGetCircuit The AcxPinGetCircuit function returns the circuit to which the pin is connected. |
| AcxPinGetId The AcxPinGetId function returns the ID for the specified pin. |
| AcxPinGetRawDataFormatList The AcxPinGetRawDataFormatList function returns the raw mode data format list for the specified pin. |
| AcxPinGetType The AcxPinGetType function returns the type of the specified pin. |
| AcxPinNotifyDataFormatChange The AcxPinNotifyDataFormatChange function is called to generate a data format change notification event for the specified pin. |
| AcxPinRemoveModeDataFormatList The AcxPinRemoveModeDataFormatList function deletes the mode data format list for the specified pin. |
| AcxPinRemoveStreamBridges The AcxPinRemoveStreamBridges function removes ACXSTREAMBRIDGE objects from the specified pin. |
| AcxPinRetrieveModeDataFormatList The AcxPinRetrieveModeDataFormatList function gets the mode data format list for the specified pin. |
Callback functions
| EVT_ACX_JACK_RETRIEVE_PRESENCE_STATE The EVT_ACX_JACK_RETRIEVE_PRESENCE_STATE callback function is implemented by the driver and is called when the state is requested for the specified jack. |
| EVT_ACX_PIN_CONNECTED The EVT_ACX_PIN_CONNECTED callback function is implemented by the driver and is called when the circuit bridge pin is connected to bridge pin of another circuit. |
| EVT_ACX_PIN_DATAFORMAT_CHANGE_NOTIFICATION The EVT_ACX_PIN_DATAFORMAT_CHANGE_NOTIFICATION callback function is implemented by the driver and is called when a data format change occurs on the specified pin. |
| EVT_ACX_PIN_DISCONNECTED The EVT_ACX_PIN_DISCONNECTED callback function is implemented by the driver and is called when the circuit bridge pin is disconnected from the pin of another circuit. |
| EVT_ACX_PIN_RETRIEVE_JACK_SINK_INFO The EVT_ACX_PIN_RETRIEVE_JACK_SINK_INFO callback function is implemented by the driver and is called when sink information is requested for the specified pin. |
| EVT_ACX_PIN_RETRIEVE_NAME The EVT_ACX_PIN_RETRIEVE_NAME callback function is implemented by the driver and is called when the name is requested for the specified pin. |
| EVT_ACX_PIN_SET_DATAFORMAT The EVT_ACX_PIN_SET_DATAFORMAT callback function is implemented by the driver and is called to set the data format for the specified pin. |
Structures
| ACX_CONNECTION The ACX_CONNECTION structure is used to define a connection between two pins. |
| ACX_INTERLEAVED_AUDIO_FORMAT_INFORMATION The ACX_INTERLEAVED_AUDIO_FORMAT_INFORMATION structure specifies how loopback audio is interleaved with the microphone audio for KSPROPERTY_INTERLEAVEDAUDIO_FORMATINFORMATION. |
| ACX_JACK_CALLBACKS The ACX_JACK_CALLBACKS structure specifies audio jack event callback functions. |
| ACX_JACK_CONFIG The ACX_JACK_CONFIG structure is used to configure an audio jack. |
| ACX_JACK_DESCRIPTION The ACX_JACK_DESCRIPTION structure describes attributes of an audio jack, such as connection type, physical location, and so on. |
| ACX_JACK_SINK_INFORMATION The ACX_JACK_SINK_INFORMATION structure specifies information about a display-related digital audio device, such as an HDMI device or a display port. |
| ACX_MIC_ARRAY_GEOMETRY The ACX_MIC_ARRAY_GEOMETRY structure specifies the type and the geometry of the microphone array. |
| ACX_MICARRAYGEOMETRY_CONFIG The ACX_MICARRAYGEOMETRY_CONFIG structure is used to configure a microphone array. |
| ACX_MICROPHONE_CONFIG The ACX_MICROPHONE_CONFIG structure is used to configure a microphone. |
| ACX_MICROPHONE_COORDINATES The ACX_MICROPHONE_COORDINATES structure specifies the 3D location of the microphone in X, Y, and Z coordinates. |
| ACX_PHYSICAL_CONNECTION The ACX_PHYSICAL_CONNECTION structure describes a physical audio connection between two ACXCIRCUIT objects. |
| ACX_PIN_CALLBACKS The ACX_PIN_CALLBACKS structure specifies pin event callback functions. |
| ACX_PIN_CONFIG The ACX_PIN_CONFIG structure is used to configure a pin. |
Enumerations
| ACX_CONNECTION_FLAGS The ACX_CONNECTION_FLAGS enumeration is used by the ACX_CONNECTION structure to specify the ACX object identifier types. |
| ACX_JACK_CONFIG_FLAGS The ACX_JACK_CONFIG_FLAGS enumeration is used to describe the properties of a physical jack to an audio class extension (ACX). |
| ACX_JACK_CONNECTION_TYPE The ACX_JACK_CONNECTION_TYPE enumeration is used to describe the type of a physical connection jack. |
| ACX_JACK_GEN_LOCATION The ACX_JACK_GEN_LOCATION enumeration is used by the ACX_JACK_DESCRIPTION structure to help describe the general location of an audio jack within a system. |
| ACX_JACK_GEO_LOCATION The ACX_JACK_GEO_LOCATION enumeration is used by the ACX_JACK_DESCRIPTION structure to help describe the geometric location of an audio jack. |
| ACX_JACK_PORT_CONNECTION The ACX_JACK_PORT_CONNECTION enumeration is used by the ACX_JACK_DESCRIPTION structure and specifies the type of port represented by the jack. |
| ACX_JACK_SINK_INFO_CONNECTION_TYPE The ACX_JACK_SINK_INFO_CONNECTION_TYPE enumeration is used by the ACX_JACK_SINK_INFORMATION structure to specify the type of a connection. |
| ACX_MIC_ARRAY_TYPE The ACX_MIC_ARRAY_TYPE enumeration is used to specify the type of a microphone array. |
| ACX_MICARRAYGEOMETRY_CONFIG_FLAGS The ACX_MICARRAYGEOMETRY_CONFIG_FLAGS enumeration is used to configure the geometry of a microphone array. |
| ACX_MICROPHONE_CONFIG_FLAGS The ACX_MICROPHONE_CONFIG_FLAGS enumeration is used to configure a physical microphone. |
| ACX_MICROPHONE_TYPE The ACX_MICROPHONE_TYPE enumeration is used to identify the pickup pattern of a microphone. |
| ACX_PHYSICAL_CONNECTION_FLAGS The ACX_PHYSICAL_CONNECTION_FLAGS enumeration is used by the ACX_PHYSICAL_CONNECTION structure to initialize a physical connection. |
| ACX_PIN_COMMUNICATION The ACX_PIN_COMMUNICATION enumeration is used by the ACX_PIN_CONFIG structure to indicate the communication type of a pin. |
| ACX_PIN_CONFIG_FLAGS The ACX_PIN_CONFIG_FLAGS enumeration specifies pin configuration settings used in the ACX_PIN_CONFIG structure. |
| ACX_PIN_QUALIFIER The ACX_PIN_QUALIFIER enumeration specify how the PIN is connected in the multi-circuit audio topology. |
| ACX_PIN_TYPE The ACX_PIN_TYPE enumeration is used by the ACX_PIN_CONFIG structure to indicate the type of a pin. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for