XGameStreamingUnregisterConnectionStateChanged

取消注册之前注册的 XGameStreamingConnectionStateChangedCallback

语法

bool XGameStreamingUnregisterConnectionStateChanged(
         XTaskQueueRegistrationToken token,
         bool wait
)

参数

token _In_ 类型: XTaskQueueRegistrationToken

对应通过 XGameStreamingRegisterConnectionStateChanged 完成的回调注册的令牌。

wait   
类型:bool

如果 wait 设置为 true,则在撤消注册并完成任何未完成的回调之前,XGameStreamingUnregisterConnectionStateChanged 将不会返回。

如果 wait 设置为 false,则在吊销注册后,XGameStreamingUnregisterConnectionStateChanged 将立即返回。 尽管不会传递新的回调,但在函数返回时,正在进行的回调可能仍在执行。

返回值

类型:bool

如果注销成功,则返回 true;如果未成功,则返回 false。

备注

注意

在时间敏感线程上调用此函数是不安全的。 有关详细信息,请参阅时间敏感线程

此 API 可用于停止侦听流式处理客户端设备的连接更改。

当游戏只是通过利用 XGameStreamingIsStreaming 泛泛检查有无任何客户端正在进行流式处理,或者因流式处理客户端而不再进行任何体验优化时,应执行这一操作。

要求

头文件:xgamestreaming.h

库:xgameruntime.lib

支持平台:Windows、Xbox One 系列主机和 Xbox Series 主机

另请参阅

XGameStreamingConnectionStateChangedCallback
XGameStreamingRegisterConnectionStateChanged
XGameStreaming