Syntax
Parameters
regionCount uint32_t*output 在
regions 中提供的区域的输出数量。
regions PartyRegion**library-allocated output array of size
*regionCount
库分配的输出数组,包含区域集。
Return value
PartyError 如果调用成功,则返回c_partyErrorSuccess;否则返回错误代码。可通过 GetErrorMessage() 检索错误代码的可读形式。
Remarks
在提供第一个 PartyRegionsChangedStateChange 之前,此方法提供的数组不会被填充。每个后续的 PartyRegionsChangedStateChange 都指示对该区域集的更新。填充此集合的后台操作在调用 Initialize() 时开始,除非使用 PartyOption::RegionUpdateConfiguration 选项配置了 PartyRegionUpdateMode::Deferred 的更新模式。延迟模式意味着直到应用程序使用零条目区域数组调用 CreateNewNetwork(),或者未连接到任何网络并使用包括 PartyVoiceChatTranscriptionOptions::TranscribeSelfRegardlessOfNetworkState 的选项标志调用 PartyLocalChatControl::PopulateAvailableTextToSpeechProfiles()、PartyLocalChatControl::SetTextToSpeechProfile() 或 PartyLocalChatControl::SetTranscriptionOptions() 之前,才会开始区域检索和连接质量测量。也可以使用 PartyOption::RegionUpdateConfiguration 选项配置刷新区域数组的时间间隔。返回的数组按延迟递增的顺序排序。区域的延迟定义为向该区域的 PlayFab 服务质量信标发送 UDP 数据报并接收响应所需的端到端时间。库会为每个区域多次测量延迟,以便计算高保真度结果。应用程序可以使用 PartyOption::RegionQualityMeasurementConfiguration 选项更改此连接质量测量过程的低级方面。
等效于 UINT32_MAX 的延迟表示该区域受支持,但由于库内部故障或未收到信标响应而达到超时,无法确定延迟信息。这可用于诊断目的(对每个区域的 UINT32_MAX 延迟可能表明存在本地配置问题)或在区域选择期间过滤掉不太可能可行的区域。
PartyRegion 结构中返回的名称未本地化为当前用户的语言,除非用于故障排除,否则不建议直接在 UI 中显示这些字符串。
不要假定返回的区域集在标题的整个生命周期内保持不变。PlayFab Party 库将随着时间推移自动利用可用区域的添加和更改,以不断改进最终用户的体验。
Requirements
Header: Party.hSee also
PartyManagerPartyRegionsChangedStateChange
PartyManager::CreateNewNetwork
