PartyOption

[アーティクル]
02/09/2024

Party ライブラリの機能を微調整するために設定できる追加オプション。

構文

enum class PartyOption  : uint32_t  
{  
    LocalUdpSocketBindAddress = 0,  
    LocalDeviceDirectPeerConnectivityOptionsMask = 1,  
    TextChatFilterLevel = 2,  
    LocalDeviceMaxDirectPeerConnections = 3,  
    RegionUpdateConfiguration = 4,  
    RegionQualityMeasurementConfiguration = 5,  
}

定数

定数	説明
LocalUdpSocketBindAddress	Party ライブラリが UDP ソケットにバインドする方法を構成するために使用されるオプション。このオプションをオーバーライドするには、PartyManager::SetOption を呼び出して、オブジェクトパラメーターに null、オプションのパラメーターにこの値、値に PartyLocalUdpSocketBindAddressConfiguration 構造体へのオプションのポインターを渡します。 null PartyLocalUdpSocketBindAddressConfiguration ポインターが指定されている場合、既定の構成が復元されます。このオプションをクエリするには、PartyManager::GetOption を呼び出して、オブジェクトパラメーターに null、オプションパラメーターにこの値、値に PartyLocalUdpSocketBindAddressConfiguration 構造体出力へのポインターを渡します。 Party ライブラリを初期化する前に、このオプションをオーバーライドまたはクエリすることをお勧めします。ローカル UDP ソケットバインドアドレス構成のオーバーライドは、次に Party ライブラリが初期化されたときに有効になります。すでに初期化されている Party ライブラリソケットバインドは変更されません。同様に、クエリを実行すると、次の Party ライブラリの初期化で使用される構成が取得されますが、すでに初期化されている場合はアクティブに使用されている値は取得されません。
LocalDeviceDirectPeerConnectivityOptionsMask	ローカルデバイスと、そのような接続の試行を許可するネットワーク内の他のデバイスとの間で許可される直接ピア接続を制限するためのオプション。 PartyNetworkConfiguration::directPeerConnectivityOptions フィールドが PartyDirectPeerConnectivityOptions::None 以外の値に設定されているネットワークへの初期ローカルユーザーの認証に成功した場合、またはリモートデバイスがそのようなネットワークへの認証を行った場合、このローカルデバイスとネットワーク内のリモートデバイス間の直接ピア接続が試行される場合があります。このオプションで構成されたフラグを使用して、これらの試行におけるローカルデバイスの関与が許可されている特定の種類のリモートデバイスをさらに制限できます。すべてのフラグは、ビット単位の AND 演算を使用して評価されます。つまり、特定のフラグは、ネットワークの PartyNetworkConfiguration 構造と、両方のデバイスのそれぞれのローカルマスクオプションの 3 つの場所で有効になっている場合にのみ、特定のネットワークのデバイスのペアに対して実際に有効になります。 Party ネットワークが、関連するフォームの直接ピア接続を許可している場合でも、どちらのデバイスも、このオプションを上書きするときにフラグを有効にしないことで、IP アドレスの開示とデバイス間の直接接続の試行を一方的にオプトアウトできます。直接ピア接続は、ライブラリの Windows 10 および Microsoft Game Core バージョンでサポートされています。これらのプラットフォームで、まだ設定されていない場合のローカルデバイスマスクの既定値は `PartyDirectPeerConnectivityOptions::AnyPlatformType \| PartyDirectPeerConnectivityOptions::AnyEntityLoginProvider` です。つまり、このようなデバイスは、許容度が低くなるように明示的にオーバーライドされるまで、ネットワークの PartyNetworkConfiguration によって許可される直接ピア接続を制限しません。ライブラリの他のすべてのバージョンでは、ローカルデバイスマスクの既定値は `PartyDirectPeerConnectivityOptions::None` で、変更できません。PartyManager::SetOption を介して変更しようとすると失敗します。これは、そのようなデバイスが直接ピア接続を試みることは決してないことを意味します。このオプションをオーバーライドするには、PartyManager::SetOption を呼び出して、オブジェクトパラメーターに null、オプションのパラメーターにこの値、および目的のすべてのオプションフラグを含む PartyDirectPeerConnectivityOptions 変数にオプションのポインターを渡します。 null PartyDirectPeerConnectivityOptions ポインターが指定されている場合、既定のオプションが復元されます。このオプションをクエリするには、PartyManager::GetOption を呼び出して、オブジェクトパラメーターに null、オプションパラメーターにこの値、および現在設定されているオプションフラグを書き込む PartyDirectPeerConnectivityOptions 変数へのポインターを渡します。ネットワークに接続していない場合は、このオプションをオーバーライドまたはクエリすることをお勧めします。設定された値は、次にこのデバイスが最初のユーザーを新しいネットワークで認証したときに有効になります。既存のネットワークに参加するためにすでに使用されている設定は変更されません。同様に、クエリを実行すると、既存のネットワークで使用される値ではなく、将来のネットワークで使用される現在設定されている値が取得されます。 Party ライブラリを初期化する前に、このオプションをオーバーライドまたはクエリすることも安全です。
TextChatFilterLevel	チャットテキストをフィルター処理するレベルを微調整するためのオプション。この機能は、英語として検出された着信チャットテキストにのみ適用されます。他の言語ではフィルターレベルを変更できません。フィルターレベルは、クライアントのすべてのローカルチャットコントロールの着信チャットテキストに適用されます。チャットテキストに影響を与えるには、少なくとも 1 つのローカルチャットコントロールで PartyLocalChatControl::SetTextChatOptions を使用してフィルター処理を有効にする必要があります。このオプションをオーバーライドするには、PartyManager::SetOption を呼び出して、オブジェクトパラメーターに null、オプションパラメーターにこの値、および目的のフィルターレベルを含む PartyTextChatFilterLevel 変数にオプションのポインターを渡します。 null PartyTextChatFilterLevel ポインターが指定されている場合、既定のレベルが復元されます。このオプションをクエリするには、PartyManager::GetOption を呼び出して、オブジェクトパラメーターに null、オプションパラメーターにこの値、および現在設定されているフィルターレベルを書き込む PartyTextChatFilterLevel 変数へのポインターを渡します。 Party ライブラリを初期化する前を含めて、このオプションを安全にオーバーライドまたはクエリ実行できます。新しい値を設定すると、すぐに有効になります。
LocalDeviceMaxDirectPeerConnections	このデバイスが他のデバイスへの確立を試みるダイレクトピア接続の最大数を構成するためのオプション。 PartyNetworkConfiguration::d irectPeerConnectivityOptions フィールドを PartyDirectPeerConnectivityOptions::None 以外の値に設定して、初期ローカルユーザーをネットワークに正常に認証すると、デバイスは相互にピア接続を直接試行する可能性があります。過剰なリソース消費を回避するために、パーティーライブラリは、特定のデバイスが現在参加しているすべてのネットワークで、この最大値よりも多くの直接ピア接続を確立しようとすることを内部的に防止します。これは、追加のリモートデバイスを使用して大規模または複数のネットワークに参加するデバイスの機能には影響しません。単に、透過的なクラウドリレーサーバーではなく、これらの直接接続を使用してデバイス間で送信されるエンドポイントメッセージとチャットデータの機会の数を定義するだけです。 PartyNetwork::GetDeviceConnectionType() を呼び出すことによって、ローカルデバイスがネットワーク内の特定のリモートデバイスへの直接ピアツーピア接続を実際に確立したかどうかを確認できます。この値をオーバーライドするには、PartyManager::SetOption を呼び出し、オブジェクトパラメーターに null を渡し、オプションパラメーターにこの値、および値の uint32_t 変数にオプションのポインターを渡します。 null uint32_t ポインターを指定すると、既定値が復元されます。このオプションに対してクエリを実行するには、PartyManager::GetOption を呼び出して、オブジェクトパラメーターに null、オプションのパラメーターにこの値、現在構成されている値を書き込む必要がある uint32_t 変数にポインターを渡します。 Party ライブラリを初期化する前を含めて、このオプションを安全にオーバーライドまたはクエリ実行できます。新しい値を設定すると、値が変更された後に参加しているすべてのネットワークに対して有効になります。
RegionUpdateConfiguration	Party ライブラリが領域の自動検出と接続品質の測定更新を実行するタイミングを構成するために使用されるオプション。このオプションをオーバーライドするには、PartyManager::SetOption を呼び出して、オブジェクトパラメーターに null、オプションのパラメーターにこの値、値に PartyRegionUpdateConfiguration 構造体へのオプションのポインターを渡します。 null PartyRegionUpdateConfiguration ポインターが指定されている場合、既定の構成が復元されます。このオプションに対してクエリを実行するには、PartyManager::GetOption を呼び出して、オブジェクトパラメーターに null、オプションパラメーターにこの値、値に PartyRegionUpdateConfiguration 構造体出力へのポインターを渡します。 Party ライブラリを初期化する前を含めて、このオプションを安全にオーバーライドまたはクエリ実行できます。領域の更新構成をオーバーライドすると、すぐに有効になります。
RegionQualityMeasurementConfiguration	Party ライブラリ領域の品質測定動作をきめ細かく制御するために使用されるオプション。このオプションをオーバーライドするには、PartyManager::SetOption を呼び出して、オブジェクトパラメーターに null、オプションのパラメーターにこの値、値に PartyRegionQualityMeasurementConfiguration 構造体へのオプションのポインターを渡します。 null PartyRegionQualityMeasurementConfiguration ポインターが指定されている場合、既定の構成が復元されます。このオプションに対してクエリを実行するには、PartyManager::GetOption を呼び出して、オブジェクトパラメーターに null、オプションパラメーターにこの値、値に PartyRegionQualityMeasurementConfiguration 構造体出力へのポインターを渡します。 Party ライブラリを初期化する前を含めて、このオプションを安全にオーバーライドまたはクエリ実行できます。領域品質測定の構成をオーバーライドすると、次の領域の更新で有効になります。

要件

ヘッダー: Party.h

次の方法で共有

PartyOption

構文

定数

要件

関連項目

その他のリソース