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

# XApuDisconnect

> XApuDisconnect

# XApuDisconnect

从硬件服务器断开连接,并释放在 [XApuConnect](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapuconnect.md) 期间分配的所有资源。

## Syntax

```cpp theme={null}
HRESULT XApuDisconnect(  
         XApuHandle handle  
)  
```

### Parameters

*handle*   \_In\_\
Type: XApuHandle

通过调用 [XApuConnect](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapuconnect.md) 返回的句柄。

### Return value

Type: HRESULT

如果成功,则返回 `S_OK`;否则,返回错误代码。

## Remarks

除了与硬件服务器断开连接之外,此调用还将释放 [XApuConnectOutputParameters::baseData](https://docs.xbox.com/zh-CN/reference/audio/xapu/structs/xapuconnectoutputparameters.md) 并关闭 [XApuConnectOutputParameters::resultReadyEvent](https://docs.xbox.com/zh-CN/reference/audio/xapu/structs/xapuconnectoutputparameters.md) 句柄。

如果在所有已排队命令处理完毕之前调用 [XApuDisconnect](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapudisconnect.md),它将释放所有资源并返回此错误代码 [XAPU\_E\_PENDING\_RESULTS](https://docs.xbox.com/zh-CN/reference/audio/xapu/enums/xapuerrors.md)。

调用方必须在调用 [XApuDisconnect](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapudisconnect.md) 之前等待最后一个入队命令的结果,否则硬件中可能会发生灾难性故障,从而禁用其他活动的 XAPU 客户端。

不建议频繁调用 [XapuConnect](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapuconnect.md) 和 [XApuDisconnect](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapudisconnect.md) 来启动和停止流,因为这些调用非常耗时,并且可能由于内存碎片而导致资源丢失。相反,应在流会话初始化时调用一次 [XapuConnect](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapuconnect.md),然后在流传输过程中使用 [XApuCommandType::Activate](https://docs.xbox.com/zh-CN/reference/audio/xapu/enums/xapucommandtype.md) 和 [XApuCommandType::Deactivate](https://docs.xbox.com/zh-CN/reference/audio/xapu/enums/xapucommandtype.md) 来启动和停止流。在流会话结束时,应调用 [XApuDisconnect](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapudisconnect.md)。所有 XAPU 客户端均适用。

## Requirements

**头文件:** xapu.h

**库:** xapu.lib

**支持的平台:** XBOX Series X|S

## Conceptual documentation

* [XAPU 概述](https://docs.xbox.com/zh-CN/build/console-features/audio/overviews/xapu-overview.md)

## See also

[XApuConnect](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapudisconnect.md)\
[XAPU](https://docs.xbox.com/zh-CN/reference/audio/xapu/xapu_members.md)


## Related topics

- [XApuConnect](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapuconnect.md)
- [XApuConnectOutputParameters](https://docs.xbox.com/zh-CN/reference/audio/xapu/structs/xapuconnectoutputparameters.md)
- [使用 XAPU API 进行单流 Opus 音频解码](https://docs.xbox.com/zh-CN/build/console-features/audio/overviews/xapu-overview-single-stream-audio-decode.md)
- [XAPU](https://docs.xbox.com/zh-CN/reference/audio/xapu/xapu_members.md)
- [XAPU 概述](https://docs.xbox.com/zh-CN/build/console-features/audio/overviews/xapu-overview.md)