> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XDSP audio

> XDSP audio

# XDSP audio

## Functions

| Function                                                                                                    | Description                                                                                                                                                  |
| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [XDspActivate](/reference/audio/xdspaudio/functions/xdspactivate)                                           | Activate XDSP stream by acquiring a free processing resource from the pool.                                                                                  |
| [XDspConnect](/reference/audio/xdspaudio/functions/xdspconnect)                                             | Establishes a connection with the hardware server, creates an XDSP client instance, and allocates the necessary resources for processing.                    |
| [XDspConnectWithMaximumStreamLimit](/reference/audio/xdspaudio/functions/xdspconnectwithmaximumstreamlimit) | Establishes a connection with the hardware server, creates an XDSP client instance, and allocates the necessary resources for processing.                    |
| [XDspDeactivate](/reference/audio/xdspaudio/functions/xdspdeactivate)                                       | Deactivate a stream and return its processing resources that were acquired in [XDspActivate](/reference/audio/xdspaudio/functions/xdspactivate) to the pool. |
| [XDspDisconnect](/reference/audio/xdspaudio/functions/xdspdisconnect)                                       | Disconnect from the hardware server and release all resources allocated during [XDspConnect](/reference/audio/xdspaudio/functions/xdspconnect).              |
| [XDspSubmitCommand](/reference/audio/xdspaudio/functions/xdspsubmitcommand)                                 | Submit one command to the hardware queue for a given stream.                                                                                                 |
| [XDspSubmitCommandWithEnvelope](/reference/audio/xdspaudio/functions/xdspsubmitcommandwithenvelope)         | Submit one command to the hardware queue for a given stream with envelope.                                                                                   |

## Enumerations

| Enumeration                                                                     | Description                                                               |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| [XDspActivationOptions](/reference/audio/xdspaudio/enums/xdspactivationoptions) | XDSP activation options.                                                  |
| [XDspProcessType](/reference/audio/xdspaudio/enums/xdspprocesstype)             | XDSP process type.                                                        |
| [XDSP Errors](/reference/audio/xdspaudio/enums/xdsperrors)                      | This topic lists the errors that can be returned by any of the XDSP APIs. |

## Structures

| Structure                                                                               | Description                 |
| --------------------------------------------------------------------------------------- | --------------------------- |
| [XDspActivationParameters](/reference/audio/xdspaudio/structs/xdspactivationparameters) | XDSP activation parameters. |
| [XDspCommand](/reference/audio/xdspaudio/structs/xdspcommand)                           | XDSP command.               |
| [XDspStatus](/reference/audio/xdspaudio/structs/xdspstatus)                             | XDSP status.                |

## Handles

| Handle                                                                  | Description         |
| ----------------------------------------------------------------------- | ------------------- |
| [XDspClientHandle](/reference/audio/xdspaudio/handles/xdspclienthandle) | XDSP client handle. |
| [XDspStreamHandle](/reference/audio/xdspaudio/handles/xdspstreamhandle) | XDSP stream handle. |

## Conceptual documentation

* [XDSP overview](/build/console-features/audio/overviews/xdsp-overview)
* [XDSP overview - Enveloping](/build/console-features/audio/overviews/xdsp-overview-enveloping)
* [XDSP overview - IR Reduction](/build/console-features/audio/overviews/xdsp-overview-ir-reduction)
* [XDSP overview - Single stream convolution](/build/console-features/audio/overviews/xdsp-overview-single-stream-convolution)
* [XDSP overview - Single stream convolution with envelope](/build/console-features/audio/overviews/xdsp-overview-single-stream-convolution-with-envelope)

## See also

[Audio API reference](/reference/audio/gc-reference-audio-toc)


## Related topics

- [XDSP Errors](/reference/audio/xdspaudio/enums/xdsperrors.md)
- [XDSP overview](/build/console-features/audio/overviews/xdsp-overview.md)
- [XDSP Enveloping Overview](/build/console-features/audio/overviews/xdsp-overview-enveloping.md)
- [Audio](/build/console-features/audio/gc-audio-toc.md)
- [XDSP Impulse Response Reduction Overview](/build/console-features/audio/overviews/xdsp-overview-ir-reduction.md)