Syntaxe
Paramètres
regionCount uint32_t*output Le nombre de sortie de régions fournies dans
regions.
regions PartyRegion**library-allocated output array of size
*regionCount
Un tableau de sortie alloué par la bibliothèque contenant l’ensemble des régions.
Valeur de retour
PartyErrorc_partyErrorSuccess si l’appel a réussi; sinon, un code d’erreur. La forme lisible du code d’erreur peut être obtenue au moyen de GetErrorMessage().
Remarques
Le tableau fourni par cette méthode n’est pas renseigné tant que le premier PartyRegionsChangedStateChange n’a pas été fourni. Chaque PartyRegionsChangedStateChange ultérieur indique une mise à jour de cet ensemble de régions. Les opérations en arrière-plan qui renseignent cet ensemble commencent lors de l’appel à Initialize(), sauf si l’option PartyOption::RegionUpdateConfiguration a été utilisée pour configurer un mode de mise à jour PartyRegionUpdateMode::Deferred. Le mode différé signifie que la récupération des régions et la mesure de la qualité de connexion ne commencent pas tant que l’application n’appelle pas CreateNewNetwork() avec un tableau de régions sans entrée, ou, si elle n’est connectée à aucun réseau, n’appelle pas PartyLocalChatControl::PopulateAvailableTextToSpeechProfiles(), PartyLocalChatControl::SetTextToSpeechProfile() ou PartyLocalChatControl::SetTranscriptionOptions() avec des indicateurs d’option incluant PartyVoiceChatTranscriptionOptions::TranscribeSelfRegardlessOfNetworkState. L’option PartyOption::RegionUpdateConfiguration peut également être utilisée pour configurer l’intervalle après lequel le tableau des régions doit être actualisé.Le tableau retourné est trié par latence croissante. La latence d’une région est définie comme le temps de bout en bout nécessaire pour envoyer un datagramme UDP à la balise de qualité de service PlayFab de la région et recevoir une réponse. La bibliothèque mesure plusieurs fois la latence de chaque région afin de calculer des résultats de haute fidélité. Les applications peuvent modifier les aspects de bas niveau de cette procédure de mesure de la qualité de connexion à l’aide de l’option PartyOption::RegionQualityMeasurementConfiguration.
Une latence équivalente à UINT32_MAX indique que la région est prise en charge, mais que les informations de latence n’ont pas pu être déterminées, soit en raison d’échecs internes à la bibliothèque, soit parce qu’un délai d’expiration a été atteint sans réponse de la balise. Cela peut être utilisé à des fins de diagnostic (une latence UINT32_MAX vers toutes les régions indique probablement un problème de configuration locale) ou pour exclure, lors de la sélection de région, les régions peu susceptibles d’être viables.
Les noms retournés dans les structures PartyRegion ne sont pas localisés dans la langue de l’utilisateur actuel, et il n’est pas recommandé d’afficher directement ces chaînes dans l’interface utilisateur, sauf à des fins de dépannage.
Ne partez pas du principe que l’ensemble des régions retournées reste le même pendant toute la durée de vie de votre titre. La bibliothèque PlayFab Party tire automatiquement parti des ajouts et des modifications apportés aux régions disponibles au fil du temps afin d’améliorer continuellement l’expérience des utilisateurs finaux.
Configuration requise
En-tête : Party.hVoir aussi
PartyManagerPartyRegionsChangedStateChange
PartyManager::CreateNewNetwork