Syntaxe
enum class PartyOption : uint32_t
{
LocalUdpSocketBindAddress = 0,
LocalDeviceDirectPeerConnectivityOptionsMask = 1,
TextChatFilterLevel = 2,
LocalDeviceMaxDirectPeerConnections = 3,
RegionUpdateConfiguration = 4,
RegionQualityMeasurementConfiguration = 5,
}
Constantes
| Constante | Description |
|---|---|
| LocalUdpSocketBindAddress | Une option utilisée pour configurer la façon dont la bibliothèque Party se lie à un socket UDP. Pour remplacer cette option, appelez PartyManager::SetOption en transmettant null pour le paramètre d’objet, cette valeur pour le paramètre d’option et un pointeur facultatif vers une structure PartyLocalUdpSocketBindAddressConfiguration pour la valeur. Si un pointeur PartyLocalUdpSocketBindAddressConfiguration null est fourni, la configuration par défaut est restaurée. Pour interroger cette option, appelez PartyManager::GetOption en transmettant null pour le paramètre d’objet, cette valeur pour le paramètre d’option et un pointeur vers une structure PartyLocalUdpSocketBindAddressConfiguration de sortie pour la valeur. Il est sûr et recommandé de remplacer ou d’interroger cette option avant d’initialiser la bibliothèque Party. Le remplacement de la configuration d’adresse de liaison du socket UDP local prend effet lors de la prochaine initialisation de la bibliothèque Party. Il ne modifie aucune liaison de socket de la bibliothèque Party déjà initialisée. De même, l’interrogation récupère la configuration qui sera utilisée lors de la prochaine initialisation de la bibliothèque Party, et non la valeur actuellement utilisée si la bibliothèque est déjà initialisée. |
| LocalDeviceDirectPeerConnectivityOptionsMask | Une option permettant de limiter la connectivité directe entre pairs autorisée entre l’appareil local et d’autres appareils dans les réseaux qui autorisent les tentatives de telles connexions. Lors de l’authentification réussie d’un premier utilisateur local dans un réseau dont le champ PartyNetworkConfiguration::directPeerConnectivityOptions est défini sur une valeur autre que PartyDirectPeerConnectivityOptions::None, ou lorsqu’un appareil distant s’authentifie dans un tel réseau, une connectivité directe entre pairs peut être tentée entre cet appareil local et le ou les appareils distants du réseau. Les indicateurs configurés par cette option peuvent être utilisés pour limiter davantage les types spécifiques d’appareils distants autorisés à impliquer l’appareil local dans ces tentatives. Tous les indicateurs sont évalués à l’aide d’une opération AND au niveau du bit. Autrement dit, un indicateur particulier n’est effectif pour une paire d’appareils d’un réseau donné que s’il est activé à trois endroits : dans la structure PartyNetworkConfiguration du réseau et dans les options de masque local respectives des deux appareils. Même si le réseau Party autorise la forme de connectivité directe entre pairs concernée, chacun des deux appareils peut refuser unilatéralement la divulgation d’adresse IP et les tentatives de connexion directe entre eux en n’activant pas l’indicateur lors du remplacement de cette option. La connectivité directe entre pairs est prise en charge dans les versions Windows, Microsoft Game Core, PlayStation®, Switch, Linux et macOS de la bibliothèque. Sur ces plateformes, la valeur par défaut du masque de l’appareil local, lorsqu’elle n’a pas encore été définie, est PartyDirectPeerConnectivityOptions::AnyPlatformType | PartyDirectPeerConnectivityOptions::AnyEntityLoginProvider | PartyDirectPeerConnectivityOptions::OnlyServers. Cela signifie que ces appareils ne restreignent aucune connectivité directe entre pairs autorisée par la PartyNetworkConfiguration d’un réseau, sauf si cette valeur est explicitement remplacée pour être moins permissive. Pour toutes les autres versions de la bibliothèque, la valeur par défaut du masque de l’appareil local est PartyDirectPeerConnectivityOptions::None et ne peut pas être modifiée ; toute tentative de la modifier via PartyManager::SetOption échoue. Cela signifie que ces appareils ne tentent jamais de connectivité directe entre pairs. Pour remplacer cette option, appelez PartyManager::SetOption en transmettant null pour le paramètre d’objet, cette valeur pour le paramètre d’option et un pointeur facultatif vers une variable PartyDirectPeerConnectivityOptions contenant tous les indicateurs d’option souhaités. Si un pointeur PartyDirectPeerConnectivityOptions null est fourni, les options par défaut sont restaurées. Pour interroger cette option, appelez PartyManager::GetOption en transmettant null pour le paramètre d’objet, cette valeur pour le paramètre d’option et un pointeur vers une variable PartyDirectPeerConnectivityOptions dans laquelle les indicateurs d’option actuellement configurés doivent être écrits. Il est recommandé de remplacer ou d’interroger cette option lorsque l’appareil n’est connecté à aucun réseau. La valeur configurée prend effet la prochaine fois que cet appareil authentifie un premier utilisateur dans un nouveau réseau. Elle ne modifie pas les paramètres déjà utilisés pour participer aux réseaux existants. De même, l’interrogation récupère la valeur actuellement configurée qui sera utilisée avec les futurs réseaux, et non la ou les valeurs utilisées avec les réseaux existants. Il est également sûr de remplacer ou d’interroger cette option avant d’initialiser la bibliothèque Party. |
| TextChatFilterLevel | Une option permettant d’ajuster finement le niveau de filtrage du texte de chat. Cette fonctionnalité ne s’applique qu’au texte de chat entrant détecté comme étant en anglais. Le niveau de filtrage ne peut pas être modifié pour les autres langues. Le niveau de filtrage s’applique au texte de chat entrant pour tous les contrôles de chat locaux du client. Le filtrage doit être activé avec PartyLocalChatControl::SetTextChatOptions pour au moins un contrôle de chat local afin d’avoir un effet sur le texte de chat. Pour remplacer cette option, appelez PartyManager::SetOption en transmettant null pour le paramètre d’objet, cette valeur pour le paramètre d’option et un pointeur facultatif vers une variable PartyTextChatFilterLevel contenant le niveau de filtrage souhaité. Si un pointeur PartyTextChatFilterLevel null est fourni, le niveau par défaut est restauré. Pour interroger cette option, appelez PartyManager::GetOption en transmettant null pour le paramètre d’objet, cette valeur pour le paramètre d’option et un pointeur vers une variable PartyTextChatFilterLevel dans laquelle le niveau de filtrage actuellement configuré doit être écrit. Il est sûr de remplacer ou d’interroger cette option à tout moment, y compris avant d’initialiser la bibliothèque Party. La définition d’une nouvelle valeur prend effet immédiatement. |
| LocalDeviceMaxDirectPeerConnections | Une option permettant de configurer le nombre maximal de connexions directes entre pairs que cet appareil tente d’établir avec d’autres appareils. Lors de l’authentification réussie d’un premier utilisateur local dans un réseau dont le champ PartyNetworkConfiguration::directPeerConnectivityOptions est défini sur une valeur autre que PartyDirectPeerConnectivityOptions::None, les appareils peuvent tenter une connectivité directe entre eux. Pour éviter une consommation excessive de ressources, la bibliothèque Party empêche en interne tout appareil de tenter d’établir plus de connexions directes entre pairs que ce maximum sur l’ensemble des réseaux auxquels il participe actuellement. Cela n’affecte pas la capacité de l’appareil à participer à de grands réseaux ou à plusieurs réseaux comportant des appareils distants supplémentaires ; cela définit simplement le nombre d’occasions de transmettre les messages de points de terminaison et les données de chat entre les appareils via ces connexions directes plutôt que via des serveurs de relais cloud transparents. Vous pouvez déterminer si l’appareil local a effectivement établi une connexion pair à pair directe avec un appareil distant spécifique d’un réseau en appelant PartyNetwork::GetDeviceConnectionType(). La valeur par défaut de cette option est c_maxDirectPeerConnectionsPerDevice, mais avec les paramètres par défaut, cette valeur ne s’applique que lors de l’authentification d’un utilisateur local dont le type d’entité PlayFab est title_player_account. Lors de l’authentification d’un utilisateur local dont le type d’entité PlayFab est game_server avec la configuration d’option par défaut, il n’existe pas de nombre maximal de connexions directes entre pairs. Pour remplacer cette valeur quel que soit le type d’entité PlayFab, appelez PartyManager::SetOption en transmettant null pour le paramètre d’objet, cette valeur pour le paramètre d’option et un pointeur facultatif vers une variable uint32_t pour la valeur. Si un pointeur uint32_t null est fourni, la valeur et le comportement par défaut sont restaurés. Pour interroger cette option, appelez PartyManager::GetOption en transmettant null pour le paramètre d’objet, cette valeur pour le paramètre d’option et un pointeur vers une variable uint32_t dans laquelle la valeur actuellement configurée doit être écrite. Il est sûr de remplacer ou d’interroger cette option à tout moment, y compris avant d’initialiser la bibliothèque Party. La définition d’une nouvelle valeur prend effet pour tous les réseaux rejoints après la modification de la valeur. |
| RegionUpdateConfiguration | Une option utilisée pour configurer le moment où la bibliothèque Party effectue la découverte automatique des régions et les mises à jour des mesures de qualité de connexion. Pour remplacer cette option, appelez PartyManager::SetOption en transmettant null pour le paramètre d’objet, cette valeur pour le paramètre d’option et un pointeur facultatif vers une structure PartyRegionUpdateConfiguration pour la valeur. Si un pointeur PartyRegionUpdateConfiguration null est fourni, la configuration par défaut est restaurée. Pour interroger cette option, appelez PartyManager::GetOption en transmettant null pour le paramètre d’objet, cette valeur pour le paramètre d’option et un pointeur vers une structure PartyRegionUpdateConfiguration de sortie pour la valeur. Il est sûr de remplacer ou d’interroger cette option à tout moment, y compris avant d’initialiser la bibliothèque Party. Le remplacement de la configuration de mise à jour des régions prend effet immédiatement. |
| RegionQualityMeasurementConfiguration | Une option utilisée pour un contrôle précis du comportement de mesure de la qualité des régions de la bibliothèque Party. Pour remplacer cette option, appelez PartyManager::SetOption en transmettant null pour le paramètre d’objet, cette valeur pour le paramètre d’option et un pointeur facultatif vers une structure PartyRegionQualityMeasurementConfiguration pour la valeur. Si un pointeur PartyRegionQualityMeasurementConfiguration null est fourni, la configuration par défaut est restaurée. Pour interroger cette option, appelez PartyManager::GetOption en transmettant null pour le paramètre d’objet, cette valeur pour le paramètre d’option et un pointeur vers une structure PartyRegionQualityMeasurementConfiguration de sortie pour la valeur. Il est sûr de remplacer ou d’interroger cette option à tout moment, y compris avant d’initialiser la bibliothèque Party. Le remplacement de la configuration de mesure de la qualité des régions prend effet lors de la prochaine mise à jour des régions. |
Configuration requise
En-tête : Party.hVoir aussi
Membres de PartyPartyManager::SetOption
PartyManager::GetOption
PartyLocalUdpSocketBindAddressConfiguration
PartyNetworkConfiguration
PartyDirectPeerConnectivityOptions
PartyRegionUpdateConfiguration
PartyRegionQualityMeasurementConfiguration