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

# 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](https://docs.xbox.com/reference/audio/xapu/enums/xapuprocesstype.md). `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](https://docs.xbox.com/reference/audio/xapu/structs/xapuresult.md)\
[XAPU](https://docs.xbox.com/reference/audio/xapu/xapu_members.md)


## Related topics

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