acxcircuit.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).

acxcircuit.h contains the following programming interfaces:

Functions

 
ACX_CIRCUIT_COMPOSITE_CALLBACKS_INIT

The ACX_CIRCUIT_COMPOSITE_CALLBACKS_INIT function initializes a ACX_CIRCUIT_COMPOSITE_CALLBACKS structure.
ACX_CIRCUIT_PNPPOWER_CALLBACKS_INIT

The ACX_CIRCUIT_PNPPOWER_CALLBACKS_INIT function initializes a ACX_CIRCUIT_PNPPOWER_CALLBACKS structure.
ACX_FACTORY_CIRCUIT_ADD_CIRCUIT_INIT

The ACX_FACTORY_CIRCUIT_ADD_CIRCUIT_INIT function initializes a ACX_FACTORY_CIRCUIT_ADD_CIRCUIT structure.
ACX_FACTORY_CIRCUIT_OPERATION_CALLBACKS_INIT

The ACX_FACTORY_CIRCUIT_OPERATION_CALLBACKS_INIT function initializes a ACX_FACTORY_CIRCUIT_OPERATION_CALLBACKS config structure.
ACX_FACTORY_CIRCUIT_PNPPOWER_CALLBACKS_INIT

The ACX_FACTORY_CIRCUIT_PNPPOWER_CALLBACKS_INIT function initializes a ACX_FACTORY_CIRCUIT_PNPPOWER_CALLBACKS structure.
ACX_FACTORY_CIRCUIT_REMOVE_CIRCUIT_INIT

The ACX_FACTORY_CIRCUIT_REMOVE_CIRCUIT_INIT function initializes a ACX_FACTORY_CIRCUIT_REMOVE_CIRCUIT structure.
AcxCircuitAddConnections

The AcxCircuitAddConnections function adds connections to an ACXCIRCUIT.
AcxCircuitAddElements

The AcxCircuitAddElements function adds elements to an ACXCIRCUIT.
AcxCircuitAddEvents

The AcxCircuitAddEvents function adds one or more events to an ACXCIRCUIT.
AcxCircuitAddPhysicalConnections

The AcxCircuitAddPhysicalConnections function adds physical connections to an ACXCIRCUIT.
AcxCircuitAddPins

The AcxCircuitAddPins function adds pins to an ACXCIRCUIT.
AcxCircuitCreate

The AcxCircuitCreate function is used to create an ACXCIRCUIT.
AcxCircuitDispatchAcxRequest

The AcxCircuitDispatchAcxRequest dispatches an ACX WDFREQUEST object to the ACX framework which will manage the request.
AcxCircuitGetElementById

When provided a valid ElementID number, the AcxCircuitGetElementById function returns the corresponding ACXELEMENT object.
AcxCircuitGetElementsCount

The AcxCircuitGetElementsCount function retrieves the number of elements attached to the specified ACX circuit.
AcxCircuitGetNotificationId

The AcxCircuitGetNotificationId function retrieves the Plug and Play notification ID that is used for audio module notifications for the specified ACX circuit.
AcxCircuitGetPinById

When provided a valid PinID number, the AcxCircuitGetPinById function returns the corresponding ACXPIN object.
AcxCircuitGetPinsCount

The AcxCircuitGetPinsCount function retrieves the number of pins for the specified circuit object.
AcxCircuitGetSymbolicLinkName

The AcxCircuitGetSymbolicLinkName function retrieves the symbolic link name for the specified circuit object.
AcxCircuitGetWdfDevice

Given an existing ACX Circuit object, the AcxCircuitGetWdfDevice function returns the associated WDFDEVICE object.
AcxCircuitInitAllocate

The AcxCircuitInitAllocate function is used to initialize the opaque ACXCIRCUIT_INIT structure that is used by the AcxCircuitCreate function.
AcxCircuitInitAssignAcxCreateStreamCallback

The AcxCircuitInitAssignAcxCreateStreamCallback function is used to assign an ACX create stream callback.
AcxCircuitInitAssignAcxRequestPreprocessCallback

The AcxCircuitInitAssignAcxRequestPreprocessCallback function add a WDFREQUEST preprocess callback.
AcxCircuitInitAssignCategories

The AcxCircuitInitAssignCategories function assigns a set of KSCATERGORY entries for the ACXCIRCUIT.
AcxCircuitInitAssignComponentUri

The AcxCircuitInitAssignComponentUri function assigns an URI string as identifier for the ACXCIRCUIT.
AcxCircuitInitAssignMethods

The AcxCircuitInitAssignMethods function assigns one or more ACX methods for the ACXCIRCUIT.
AcxCircuitInitAssignName

The AcxCircuitInitAssignName function assigns a friendly name for the ACXCIRCUIT.
AcxCircuitInitAssignProperties

The AcxCircuitInitAssignProperties function assigns one or more ACX properties for the ACXCIRCUIT.
AcxCircuitInitDisableDefaultStreamBridgeHandling

The AcxCircuitInitDisableDefaultStreamBridgeHandling function disables the ACX default stream bridge handling in a multi-circuit environment.
AcxCircuitInitFree

The AcxCircuitInitFree function deletes the circuit initialization object.
AcxCircuitInitSetAcxCircuitCompositeCallbacks

The AcxCircuitInitSetAcxCircuitCompositeCallbacks function sets the driver's composite callbacks for the ACXCIRCUIT.
AcxCircuitInitSetAcxCircuitPnpPowerCallbacks

The AcxCircuitInitSetAcxCircuitPnpPowerCallbacks function sets the driver's PNP callbacks for the ACXCIRCUIT.
AcxCircuitInitSetCircuitType

The AcxCircuitInitSetCircuitType function is used to set the circuit type of the ACXCIRCUIT.
AcxCircuitInitSetComponentId

The AcxCircuitInitSetComponentId function sets the component ID for the ACXCIRCUIT.
AcxCircuitResumeIo

The AcxCircuitResumeIo function is used to resume circuit I/O after it has been temporarily stopped.
AcxCircuitResumeIoActual

The AcxCircuitResumeIoActual function is used to resume circuit I/O after it has been stopped.
AcxCircuitResumeIoWithTag

The AcxCircuitResumeIoWithTag function is used to resume circuit I/O after it has been stopped.
AcxCircuitStopIo

The AcxCircuitStopIo function is used to signal to the operating system to temporarily stop circuit I/O.
AcxCircuitStopIoActual

The AcxCircuitStopIoActual function is used to signal to the operating system to temporarily stop circuit I/O.
AcxCircuitStopIoWithTag

The AcxCircuitStopIoWithTag function is used to signal to the operating system to temporarily stop circuit I/O.
AcxFactoryCircuitAddElements

The AcxFactoryCircuitAddElements function adds elements to an ACXFACTORYCIRCUIT.
AcxFactoryCircuitCreate

The AcxFactoryCircuitCreate function is used to create an ACXFACTORYCIRCUIT.
AcxFactoryCircuitGetSymbolicLinkName

The AcxFactoryCircuitGetSymbolicLinkName function retrieves the symbolic link name for the specified ACX factory circuit.
AcxFactoryCircuitInitAllocate

The AcxFactoryCircuitInitAllocate function is used to initialize the opaque ACXFACTORYCIRCUIT_INIT structure that is used by the AcxFactoryCircuitCreate function.
AcxFactoryCircuitInitAssignAcxRequestPreprocessCallback

The AcxFactoryCircuitInitAssignAcxRequestPreprocessCallback function add a WDFREQUEST preprocess callback.
AcxFactoryCircuitInitAssignCategories

The AcxFactoryCircuitInitAssignCategories function assigns a set of driver category (GUID) entries for the ACXFACTORYCIRCUIT.
AcxFactoryCircuitInitAssignComponentUri

The AcxFactoryCircuitInitAssignComponentUri function assigns an URI string as identifier for the ACXFACTORYCIRCUIT.
AcxFactoryCircuitInitAssignMethods

The AcxCircuitFactoryInitAssignMethods function assigns one or more ACX methods for the ACXFACTORYCIRCUIT.
AcxFactoryCircuitInitAssignName

The AcxFactoryCircuitInitAssignName function assigns a friendly name for the ACXFACTORYCIRCUIT.
AcxFactoryCircuitInitAssignProperties

The AcxFactoryCircuitInitAssignProperties function assigns one or more ACX properties for the ACXFACTORYCIRCUIT.
AcxFactoryCircuitInitFree

The AcxFactoryCircuitInitFree function deletes the factory circuit initialization object.
AcxFactoryCircuitInitSetAcxCircuitPnpPowerCallbacks

The AcxFactoryCircuitInitSetAcxCircuitPnpPowerCallbacks function sets the driver's PNP callbacks for the ACXFACTORYCIRCUIT.
AcxFactoryCircuitInitSetComponentId

The AcxFactoryCircuitInitSetComponentId function sets the component ID for the ACXFACTORYCIRCUIT.
AcxFactoryCircuitInitSetOperationCallbacks

The AcxFactoryCircuitInitSetOperationCallbacks sets the driver factory operation callbacks for the ACXFACTORYCIRCUIT.

Callback functions

 
EVT_ACX_CIRCUIT_COMPOSITE_CIRCUIT_INITIALIZE

The EVT_ACX_CIRCUIT_COMPOSITE_CIRCUIT_INITIALIZE callback is used by the driver to do any initialization of a composite circuit when it is detected and initialized by ACX Manager.
EVT_ACX_CIRCUIT_COMPOSITE_DEINITIALIZE

The EVT_ACX_CIRCUIT_COMPOSITE_CIRCUIT_DEINITIALIZE callback is used by the driver to do any de-initialiation of a composite circuit when it is de-initialized by ACX Manager.
EVT_ACX_CIRCUIT_COMPOSITE_INITIALIZE

The EVT_ACX_CIRCUIT_COMPOSITE_INITIALIZE callback is used by the driver to do any post-initialization after the composite endpoint has been assembled by ACX Manager.
EVT_ACX_CIRCUIT_CREATE_STREAM

The driver defines the EVT_ACX_CIRCUIT_CREATE_STREAM callback to create circuit stream instances.
EVT_ACX_CIRCUIT_POWER_DOWN

The EVT_ACX_CIRCUIT_POWER_DOWN callback is used by the driver to add functionality in the power down path of an ACXCIRCUIT object.
EVT_ACX_CIRCUIT_POWER_UP

The EVT_ACX_CIRCUIT_POWER_UP callback is used by the driver to add functionality in the power up path of an ACXCIRCUIT object.
EVT_ACX_CIRCUIT_PREPARE_HARDWARE

The EVT_ACX_CIRCUIT_PREPARE_HARDWARE callback is used by the driver to add functionality when a circuit is in the prepare hardware phase.
EVT_ACX_CIRCUIT_RELEASE_HARDWARE

The EVT_ACX_CIRCUIT_RELEASE_HARDWARE callback is used by the driver to add functionality when an ACXCIRCUIT is in the release hardware phase.
EVT_ACX_FACTORY_CIRCUIT_CREATE_CIRCUIT

The EVT_ACX_FACTORY_CIRCUIT_CREATE_CIRCUIT callback is invoked by ACX when the driver must create an ACXCIRCUIT object with the specified configuration.
EVT_ACX_FACTORY_CIRCUIT_CREATE_CIRCUITDEVICE

The EVT_ACX_FACTORY_CIRCUIT_CREATE_CIRCUITDEVICE callback is invoked by ACX when the driver must create a WDFDEVICE for a new ACXCIRCUIT object.
EVT_ACX_FACTORY_CIRCUIT_DELETE_CIRCUITDEVICE

The EVT_ACX_FACTORY_CIRCUIT_DELETE_CIRCUITDEVICE callback is invoked by ACX when the driver must delete a previously created WDFDEVICE associated with an ACXCIRCUIT object.
EVT_ACX_FACTORY_CIRCUIT_POWER_DOWN

The EVT_ACX_FACTORY_CIRCUIT_POWER_DOWN callback is used by the driver to add functionality in the power down path of an ACXFACTORYCIRCUIT object.
EVT_ACX_FACTORY_CIRCUIT_POWER_UP

The EVT_ACX_FACTORY_CIRCUIT_POWER_UP callback is used by the driver to add functionality in the power up path of an ACXFACTORYCIRCUIT object.
EVT_ACX_FACTORY_CIRCUIT_PREPARE_HARDWARE

The EVT_ACX_FACTORY_CIRCUIT_PREPARE_HARDWARE callback is used by the driver to add functionality when a circuit factory is in the prepare hardware phase.
EVT_ACX_FACTORY_CIRCUIT_RELEASE_HARDWARE

The EVT_ACX_FACTORY_CIRCUIT_RELEASE_HARDWARE callback is used by the driver to add functionality when an ACXFACTORYCIRCUIT is in the release hardware phase.

Structures

 
ACX_CIRCUIT_COMPOSITE_CALLBACKS

The ACX_CIRCUIT_COMPOSITE_CALLBACKS structure identifies the driver callbacks for ACX composite circuit operations.
ACX_CIRCUIT_PNPPOWER_CALLBACKS

The ACX_CIRCUIT_PNPPOWER_CALLBACKS structure contains pointers to an ACXCIRCUIT's Plug and Play and power event callback functions.
ACX_FACTORY_CIRCUIT_ADD_CIRCUIT

The ACX_FACTORY_CIRCUIT_ADD_CIRCUIT structure is used to add circuits by an ACX circuit factory.
ACX_FACTORY_CIRCUIT_OPERATION_CALLBACKS

The ACX_FACTORY_CIRCUIT_OPERATION_CALLBACKS structure identifies the driver callbacks for ACX factory operations.
ACX_FACTORY_CIRCUIT_PNPPOWER_CALLBACKS

The ACX_FACTORY_CIRCUIT_PNPPOWER_CALLBACKS structure contains pointers to an ACXFACTORYCIRCUITs Plug and Play and power event callback functions.
ACX_FACTORY_CIRCUIT_REMOVE_CIRCUIT

The ACX_FACTORY_CIRCUIT_REMOVE_CIRCUIT structure is used to remove ACX circuit factory circuits.

Enumerations

 
ACX_CIRCUIT_TYPE

The ACX_CIRCUIT_TYPE enumeration defines the types of ACXCIRCUITs.
ACX_FACTORY_CIRCUIT_ADD_CIRCUIT_FLAGS

The ACX_FACTORY_CIRCUIT_ADD_CIRCUIT_FLAGS enumeration defines factory circuit add flags.
ACX_FACTORY_CIRCUIT_REMOVE_CIRCUIT_FLAGS

The ACX_FACTORY_CIRCUIT_REMOVE_CIRCUIT_FLAGS enumeration defines factory circuit remove flags.
ACX_STOP_IO_FLAGS

The ACX_STOP_IO_FLAGS enumeration defines Stop IO flags.