次の方法で共有

XGameStreamingGetTouchBundleVersion

  • [アーティクル]

指定されたデバイスで現在使用されているタッチ アダプテーション バンドルのバージョンを取得します。

構文

HRESULT XGameStreamingGetTouchBundleVersion(  
        XGameStreamingClientId client,
        XVersion* version,
        size_t versionNameSize,
        char* versionName
)

パラメーター

client _In_
型: XGameStreamingClientId

クエリされているストリーミング クライアント デバイス。

version _Out_opt_
型: XVersion

指定したクライアントで現在使用されているバンドルのバージョン番号。 バンドルにバージョン番号が指定されていない場合、0.0.0.0 が返されます。

versionNameSize _In_
型: size_t

返される versionName の最大サイズ (バイト単位)。 指定するサイズは、XGameStreamingGetTouchBundleVersionNameSize を呼び出すことによって見つけることができます。

versionName _Out_writes_opt_z_
型: char*

指定したクライアントで現在使用されているバンドルのバージョン名。 バンドルにバージョン名が指定されていない場合は、null が返されます。

戻り値

型: HRESULT

成功した場合は S_OK を返し、それ以外の場合はエラー コードを返します。

返される可能性のあるエラー

エラー コード エラー値 エラーの原因
E_GAMESTREAMING_NOT_INITIALIZED 0x89245400 XGameStreaming ランタイムが初期化されていません。 他の API を呼び出す前に XGameStreamingInitialize を呼び出してください。
E_GAMESTREAMING_CLIENT_NOT_CONNECTED 0x89245401 指定されたクライアントが接続されていません。

エラー コードの一覧については、「エラー コード」をご覧ください。

解説

ゲームのストリーミング中にプレーヤーに表示されるタッチ レイアウトは、タッチ調整バンドルの一部として Microsoft にアップロードされた定義済みのレイアウトを使用します。 XGameStreamingGetTouchBundleVersion は、特定のクライアントで使用されている一連のタッチ コントロールに基づいて、ゲームがランタイムを決定できるようにします。 使用例をいくつか紹介します。

  • プレーヤーがタッチ入力を使用していて、タッチ オーバーレイ コントロールを介して要素が使用可能な場合に、HUD から要素を削除する場合。
  • 表示されるタッチ レイアウトに基づいて、ゲームに表示するグラフィカル ヒントを決定する場合。

version は、サービスにアップロードされるバージョンごとに一意です。 すべての更新には、新しいバージョン番号が必要です。

versionName は、特定のバージョン番号にロックするのではなく、セマンティック バージョン（たとえば、これは DLC2 をサポートするレイアウトのセット）を提供するために使用できます。 たとえば、ビルド システムによってバージョン番号が自動的に割り当てられる場合、実行時に表示されるタッチ適応バンドルの正確なバージョン番号をゲーム コードで認識することは難しい場合があります。 正確なバージョンが分からなくてもコードでバンドルの存在を検出できるようにするために、バージョン番号に基づいて比較するのではなく、バージョン名を使用するように選択することができます。

例

void GameStreamingClientManager::GetClientTouchBundleVersion(XGameStreamingClientId client)
{
    // Get the touch bundle version and initialize the touch HUD based on the 
    // semantic version name that was returned
    
    size_t versionNameSize = XGameStreamingGetTouchBundleVersionNameSize(clientId);

    XVersion version{};
    std::vector<char> versionName(versionNameSize, 0);
    XGameStreamingGetTouchBundleVersion(clientId, &version, versionNameSize, &versionName[0]);

    InitializeTouchHUD(versionName);

    if (strcmp("DLC2", versionName.data()) == 0)
    {
        // we have our DLC2 controls, switch to the HUD layout that works best with those overlay controls.
        InitializeHUDForDLC2TouchControls();
    }
}

要件

ヘッダー: XGameStreaming.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

関連項目

XGameStreaming
XGameStreamingGetTouchBundleVersionNameSize