# nsx-audio

<!-- nsx:facts -->
PDM audio capture helper for AmbiqSuite-backed NSX targets with staged PDM support.

- Type: Backend specific
- Version: 5.2.26
- Project: nsx-ambiq-sdk
- Revision: v5.2.26
- Source: https://github.com/AmbiqAI/nsx-ambiq-sdk/tree/v5.2.26
- Capabilities: audio, pdm, microphone, dma
<!-- /nsx:facts -->

## Add it to an app

```bash
nsx module add nsx-audio
```

## Capabilities

- audio
- pdm
- microphone
- dma

## Use cases

- initialize board-supported PDM capture with caller-owned buffers
- receive DMA-backed PCM sample callbacks from a PDM microphone
- provide a stable NSX audio API across AmbiqSuite releases

## Requires

- [`nsx-core`](https://ambiqai.github.io/neuralspotx/modules/nsx-core/)
- [`nsx-soc-hal`](https://ambiqai.github.io/neuralspotx/modules/nsx-soc-hal/)

## Compatibility

:::note[How compatibility is declared]
The boards, SoCs and toolchains listed here are the ones the module manifest declares.
That is the module author's statement of intent, not evidence from hardware. Confirm on your
own target before you depend on it.
:::

| Kind | Declared |
| --- | --- |
| Boards | apollo330mP_evb, apollo510_evb, apollo510b_evb, apollo510dL_evb |
| SoCs | apollo330P, apollo510, apollo510b, apollo510L, apollo3, apollo3p |
| Toolchains | arm-none-eabi-gcc, armclang, atfe |

## Agent keywords

`audio`, `pdm`, `microphone`, `capture`, `dma`, `sampling`

## Source

| Field | Value |
| --- | --- |
| Type | Backend specific |
| Version | 5.2.26 |
| Project | nsx-ambiq-sdk |
| Revision | `v5.2.26` |
| Manifest | `modules/nsx-audio/nsx-module.yaml` |
| Repository | [nsx-ambiq-sdk](https://github.com/AmbiqAI/nsx-ambiq-sdk/tree/v5.2.26) |

Back to the [module catalog](https://ambiqai.github.io/neuralspotx/modules/catalog/).
