語法
參數
regionCount uint32_t*輸出
regions 中提供的區域輸出數目。
regions PartyRegion**程式庫配置的輸出陣列,大小為
*regionCount
程式庫配置的輸出陣列,包含區域集合。
傳回值
PartyErrorc_partyErrorSuccess (如果呼叫成功),否則為錯誤碼。可透過 GetErrorMessage() 擷取錯誤碼的人類可讀形式。
備註
此方法提供的陣列在提供第一個 PartyRegionsChangedStateChange 之前不會填入。後續的每個 PartyRegionsChangedStateChange 都表示此區域集合有更新。填入此集合的背景作業會在呼叫 Initialize() 時開始,除非使用 PartyOption::RegionUpdateConfiguration 選項將更新模式設定為 PartyRegionUpdateMode::Deferred。延後模式表示區域擷取和連線品質測量在應用程式以零個項目的區域陣列呼叫 CreateNewNetwork(),或在未連線到任何網路的情況下呼叫 PartyLocalChatControl::PopulateAvailableTextToSpeechProfiles()、PartyLocalChatControl::SetTextToSpeechProfile() 或以包含 PartyVoiceChatTranscriptionOptions::TranscribeSelfRegardlessOfNetworkState 的選項旗標呼叫 PartyLocalChatControl::SetTranscriptionOptions() 之前不會開始。PartyOption::RegionUpdateConfiguration 選項也可用來設定重新整理區域陣列的間隔。傳回的陣列會依延遲遞增排序。區域的延遲定義為將 UDP 資料包傳送至該區域的 PlayFab 服務品質信標並接收回應所需的端對端時間。程式庫會對每個區域測量多次延遲,以計算高精確度的結果。應用程式可以使用 PartyOption::RegionQualityMeasurementConfiguration 選項,變更此連線品質測量程序的低階層面。
延遲等於 UINT32_MAX 表示支援該區域,但因程式庫內部失敗或在未收到信標回應的情況下逾時,而無法判斷延遲資訊。這可用於診斷用途 (所有區域的延遲都是 UINT32_MAX,可能表示本機設定問題),或在區域選取期間用於篩除不太可能可行的區域。
PartyRegion 結構中傳回的名稱未當地語系化為目前使用者的語言,因此除了疑難排解之外,不建議直接在 UI 中顯示這些字串。
請勿假設傳回的區域集合在遊戲的整個存留期間都保持不變。PlayFab Party 程式庫會隨著時間自動利用可用區域的新增和變更,持續改善終端使用者的體驗。
需求
標頭: Party.h另請參閱
PartyManagerPartyRegionsChangedStateChange
PartyManager::CreateNewNetwork
