> ## 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.

# XApuStateOptions

> XApuStateOptions

# XApuStateOptions

Defines the current state of the processing engine.

## Syntax

```cpp theme={null}
enum class XApuStateOptions  : uint32_t  
{  
    None = 0,  
    OutputReady = 1,  
    NeedMoreInput = 2,  
    MoreOutputAvailable = 4,  
    OutputSaturation = 8,  
}  
```

## Constants

| Constant            | Description                                                                           |
| ------------------- | ------------------------------------------------------------------------------------- |
| None                | No options are set.                                                                   |
| OutputReady         | Used for `XApuProcessType::ConvertPCM` and `XApuProcessType::DecodeConvertOpus` only. |
| NeedMoreInput       | Used for `XApuProcessType::ConvertPCM` and `XApuProcessType::DecodeConvertOpus` only. |
| MoreOutputAvailable | Used for `XApuProcessType::ConvertPCM` and `XApuProcessType::DecodeConvertOpus` only. |
| OutputSaturation    | Used for `XApuProcessType::ConvertPCM` and `XApuProcessType::DecodeConvertOpus` only. |

## Remarks

Not all options are used for all [XApuProcessType](/reference/audio/xapu/enums/xapuprocesstype). `XApuProcessType` is a single process or chain of processes that the Audio Processing Unit (APU) performs. `XApuResult` defines a result returned from the XAPU.

## Requirements

**Header:** xapu.h

**Supported platforms:** XBOX Series X|S

## See also

[XApuResult](/reference/audio/xapu/structs/xapuresult)\
[XAPU](/reference/audio/xapu/xapu_members)


## Related topics

- [XApuProcessType](/reference/audio/xapu/enums/xapuprocesstype.md)
- [XAPU](/reference/audio/xapu/xapu_members.md)
- [XApuCommandOptions](/reference/audio/xapu/enums/xapucommandoptions.md)
- [XApuConnectOptions](/reference/audio/xapu/enums/xapuconnectoptions.md)
- [ApuHeapState](/reference/audio/apu/structs/apuheapstate.md)