acxtargets.h header
The acxtargets header is used by the ACX audio class extensions. For more information, see ACX Audio Class Extensions overview.
WdfIoTarget is a WDF abstraction to facilitate the communication between two different stacks. ACX uses WdfIoTarget to facilitate communications between ACX objects, circuits, pins, streams, elements and circuit factories.
ACX uses the following ACX Objects to support communications between targets. For more information, see ACX - Summary of ACX Objects.
Drivers use AcxTargetCircuit to communicate with a remote circuit exposed by a different stack. AcxTargetCircuit is implemented using a WdfIoTarget.
Drivers use AcxTargetPin to communicate with a remote circuit’s pin exposed by a different stack. AcxTargetPin is implemented using a WdfIoTarget to send messages to the remote pin entity.
Drivers use AcxTargetStream to communicate with a remote circuit’s stream exposed by a different stack. AcxTargetStream is implemented using a WdfIoTarget to create a remote stream and change the state of the remote stream.
Drivers use AcxTargetElement to communicate with a remote circuit’s element exposed by a different stack. AcxTargetElement is implemented using a WdfIoTarget to send messages to the remote element entity.
Drivers use AcxTargetFactoryCircuit to communicate with a remote circuit factory instance. AcxTargetFactoryCircuit is implemented using a WdfIoTarget to send messages to the remote circuit factory.
To interact with the remote circuit, each of the above ACX types supports:
- properties
- methods
- events
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).
acxtargets.h contains the following programming interfaces:
Functions
| ACX_TARGET_CIRCUIT_CONFIG_INIT The ACX_TARGET_CIRCUIT_CONFIG_INIT function initializes an ACX target circuit config structure. |
| ACX_TARGET_FACTORY_CIRCUIT_CONFIG_INIT The ACX_TARGET_FACTORY_CIRCUIT_CONFIG_INIT function initializes an ACX target factory circuit config structure. |
| ACX_TARGET_STREAM_CONFIG_INIT The ACX_TARGET_STREAM_CONFIG_INIT function initializes an ACX target stream config structure. |
| AcxTargetCircuitCreate The AcxTargetCircuitCreate function is used to create an ACX target circuit. |
| AcxTargetCircuitFormatRequestForMethod The AcxTargetCircuitFormatRequestForMethod formats a WDFREQUEST as an ACX method request to be used on specified circuit target. |
| AcxTargetCircuitFormatRequestForProperty The AcxTargetCircuitFormatRequestForProperty formats a WDFREQUEST as an ACX property request to be used on specified circuit target. |
| AcxTargetCircuitGetElementsCount The AcxTargetCircuitGetElementsCount function returns the count of ACX elements on the remote target. |
| AcxTargetCircuitGetPinsCount The AcxTargetCircuitGetPinsCount function returns the count of ACX pins on the remote target. |
| AcxTargetCircuitGetSymbolicLinkName The AcxTargetCircuitGetSymbolicLinkName function retrieves the symbolic link name for the specifies ACX target circuit. |
| AcxTargetCircuitGetTargetElement The AcxTargetCircuitGetTargetElement function, given a valid element index value, will return the associated ACXTARGETELEMENT object. |
| AcxTargetCircuitGetTargetPin The AcxTargetCircuitGetTargetPin function, given a valid pin index value, will return the associated ACXTARGETPIN object. |
| AcxTargetCircuitGetWdfIoTarget The AcxTargetCircuitGetWdfIoTarget function will return the associated WDFIOTARGET object. |
| AcxTargetElementFormatRequestForMethod The AcxTargetElementFormatRequestForMethod function formats a WDFREQUEST as an ACX method request to be used on specified element target. |
| AcxTargetElementFormatRequestForProperty The AcxTargetElementFormatRequestForProperty formats a WDFREQUEST as an ACX property request to be used on specified element target. |
| AcxTargetElementGetId The AcxTargetElementGetId given an existing ACXTARGETELEMENT object, returns its corresponding ID value. |
| AcxTargetElementGetNameTag The AcxTargetElementGetNameTag given an existing ACXTARGETELEMENT object, returns its name-tag in the form of a GUID. |
| AcxTargetElementGetType The AcxTargetElementGetType function given an existing ACXTARGETELEMENT object, returns its corresponding element type in the form of a GUID. |
| AcxTargetElementGetWdfIoTarget The AcxTargetElementGetWdfIoTarget given an existing ACXTARGETELEMENT object, returns its corresponding WDFIOTARGET object. |
| AcxTargetFactoryCircuitCreate The AcxTargetFactoryCircuitCreate function returns a handle to a new ACXTARGETFACTORYCIRCUIT ACX object. |
| AcxTargetFactoryCircuitFormatRequestForMethod The AcxTargetFactoryCircuitFormatRequestForMethod formats a WDFREQUEST as an ACX method request to be used on specified circuit factory target. |
| AcxTargetFactoryCircuitFormatRequestForProperty AcxTargetFactoryCircuitFormatRequestForProperty formats a WDFREQUEST as an ACX property request to be used on specified circuit factory target. |
| AcxTargetFactoryCircuitGetWdfIoTarget The AcxTargetFactoryCircuitGetWdfIoTarget given an existing ACXTARGETFACTORYCIRCUIT object, returns its corresponding WDFIOTARGET object. |
| AcxTargetPinFlushModeDataFormatListCache The AcxTargetPinFlushModeDataFormatListCache function flushes the mode data format list cache for the specified target pin. |
| AcxTargetPinFormatRequestForMethod The AcxTargetPinFormatRequestForMethod function formats a WDFREQUEST as an ACX method request to be used on specified pin target. |
| AcxTargetPinFormatRequestForProperty AcxTargetPinFormatRequestForProperty formats a WDFREQUEST as an ACX property request to be used on specified pin target. |
| AcxTargetPinGetId The AcxTargetPinGetId given an existing ACXTARGETPIN object returns its associated ID value. |
| AcxTargetPinGetWdfIoTarget The AcxTargetPinGetWdfIoTarget function given an existing ACXTARGETPIN object, returns its corresponding WDFIOTARGET object. |
| AcxTargetPinRetrieveModeDataFormatList The AcxTargetPinRetrieveModeDataFormatList function given an existing ACXTARGETPIN object, returns the ACXDATAFORMATLIST associated to the specified signal-processing-mode data format list. |
| AcxTargetStreamAssignDrmContentId The AcxTargetStreamAssignDrmContentId function given an existing ACXTARGETSTREAM object, assigns a DRM Content Id to that stream. |
| AcxTargetStreamCreate The AcxTargetStreamCreate function is used to create a target stream. |
| AcxTargetStreamFormatRequestForMethod The AcxTargetStreamFormatRequestForMethod formats a WDFREQUEST as an ACX method request to be used on specified stream target. |
| AcxTargetStreamFormatRequestForProperty The AcxTargetStreamFormatRequestForProperty formats a WDFREQUEST as an ACX property request to be used on specified stream target. |
| AcxTargetStreamGetElementsCount The AcxTargetStreamGetElementsCount function given an ACXTARGETSTREAM object, returns its number of ACX elements. |
| AcxTargetStreamGetTargetElement The AcxTargetStreamGetTargetElement function, given a valid element index value, returns the corresponding ACXTARGETELEMENT ACX object that is associated with the specified stream. |
| AcxTargetStreamGetWdfIoTarget The AcxTargetStreamGetWdfIoTarget function returns a WDFIOTARGET WDF object that is associated with the specified stream. |
Structures
| ACX_TARGET_CIRCUIT_CONFIG The ACX_TARGET_CIRCUIT_CONFIG structure is used to define the target circuit configuration. |
| ACX_TARGET_FACTORY_CIRCUIT_CONFIG The ACX_TARGET_FACTORY_CIRCUIT_CONFIG structure is used to define the target factory circuit configuration. |
| ACX_TARGET_STREAM_CONFIG The ACX_TARGET_STREAM_CONFIG structure is used to define the target stream configuration. |
Enumerations
| ACX_TARGET_CIRCUIT_CONFIG_FLAGS The ACX_TARGET_CIRCUIT_CONFIG_FLAGS enumeration defines the config flags for the ACX target circuit. |
| ACX_TARGET_FACTORY_CIRCUIT_CONFIG_FLAGS The ACX_TARGET_FACTORY_CIRCUIT_CONFIG_FLAGS enumeration defines the config flags for the ACX target circuit factory. |
| ACX_TARGET_STREAM_CONFIG_FLAGS The ACX_TARGET_STREAM_CONFIG_FLAGS enumeration defines the config flags for the ACX target stream. |
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