XGameStreamingGetDisplayDetails

[アーティクル]
05/10/2023

この API は、指定されたクライアントの表示の詳細を返します。これを使用して、レンダリングするカスタムアスペクト比や、ダイレクトキャプチャを有効にするために使用する解像度など、十分な情報に基づいた決定を下すことができます。

構文

HRESULT XGameStreamingGetDisplayDetails(
        XGameStreamingClientId client,
        uint32_t maxSupportedPixels,
        float widestSupportedAspectRatio,
        float tallestSupportedAspectRatio,
        XGameStreamingDisplayDetails* displayDetails
)

パラメーター

client _In_
型: XGameStreamingClientId

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

maxSupportedPixels _In_
型: uint32_t

ゲームがサポートする最大ピクセル数。

widestSupportedAspectRatio _In_
型: float

ゲームでサポートされている最も広い縦横比。これは、サポートされている最も広い解像度を使用して、幅 / 高さから計算されます。

tallestSupportedAspectRatio _In_
型: float

ゲームでサポートされている最も高い縦横比。これは、サポートされている最も高い解像度を使用して、幅 / 高さから計算されます。

displayDetails _Out_
Type: XGameStreamingDisplayDetails*

ストリーミングクライアントの表示の詳細。

戻り値

型: HRESULT

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

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

エラーコード	エラー値	エラーの原因
E_GAMESTREAMING_NOT_INITIALIZED	0x89245400	XGameStreaming ランタイムが初期化されていません。他の API を呼び出す前に XGameStreamingInitialize を呼び出してください。
E_GAMESTREAMING_CLIENT_NOT_CONNECTED	0x89245401	指定されたクライアントが接続されていません。
E_GAMESTREAMING_NO_DATA	0x89245402	要求されたデータは利用できません。データは後で利用可能になる場合があります。
E_INVALIDARG	0x80070057	1 つ以上のパラメーターが無効でした。 `maxSupportedPixels` は 0 より大きい必要があります。 `widestSupportedAspectRatio` は 16/9 以上である必要があり、無限であってはなりません。 `tallestSupportedAspectRatio` は16/9 以下で、0 より大きい必要があります。

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

解説

displayDetails 内のデータを使用して、ゲームをレンダリングするための解像度などのゲームの側面を駆動したり、重要な情報や UI を配置する場所を通知したりして、操作可能で不明瞭にならないようにすることができます。

displayDetails 構造体内の preferredWidth と preferredHeight は、ストリーミングクライアントでの実際の表示、ストリーミングシステムに基づく制限、およびゲームによって提供されるパラメーター (maxSupportedPixels、widestSupportedAspectRatio、tallestSupportedAspectRatio)。

データはゲームの起動時に利用できない可能性があり、クライアント接続イベントの時点で必ずしも利用できるとは限らないことに注意してください。そのため、ゲームはイベントまたはポーリングのいずれかを使用する必要があります。

例


#define DEFAULT_GAME_WIDTH 1920
#define DEFAULT_GAME_HEIGHT 1080

#define GAME_WIDEST_SUPPORTED_ASPECT_RATIO 21.5f / 9.0f
#define GAME_TALLEST_SUPPORTED_ASPECT_RATIO 16.0f / 10.0f

static uint32_t s_currentStreamWidth = DEFAULT_GAME_WIDTH;
static uint32_t s_currentStreamHeight = DEFAULT_GAME_HEIGHT;

// Option 1: Event driven. Note: be aware of potential threading issues when using the task queue.
void GameStreamingClientManager::OnConnectionStateChanged(XGameStreamingClientId client, XGameStreamingConnectionState connected)
{
    // Other connection work like registering or unregistering for the client properties change events.
    ...

    UpdateResolutionIfNeeded();
}

void GameStreamingClientManager::OnClientPropertiesChanged(
    XGameStreamingClientId client,
    uint32_t updatedPropertiesCount,
    XGameStreamingClientProperty* updatedProperties)
{
    for (uint32_t i = 0; i < updatedPropertiesCount; ++i)
    {
        switch (updatedProperties[i])
        {
        case XGameStreamingClientProperty::DisplayDetails:
        {
            UpdateResolutionIfNeeded();
            break;
        }

        default:
            // A characteristic we are not tracking - do nothing
            break;
        }
    }
}

// Option 2: Polling.

void Game::Update(DX::StepTimer const& timer)
{
    ...

    gameStreamingClientManager->UpdateResolutionIfNeeded();

    ...
}

void GameStreamingClientManager::UpdateResolutionIfNeeded()
{
    bool changeResolution = false;
    bool useDefaultResolution = true;

    // Only use custom resolution when there is only one streaming client connected.
    if (XGameStreamingGetClientCount() == 1)
    {
        XGameStreamingClientId client;
        uint32_t clientsUsed = 0;
        HRESULT hr = XGameStreamingGetClients(1, &client, &clientsUsed);
        if (SUCCEEDED(hr) && clientsUsed == 1)
        {
            XGameStreamingDisplayDetails displayDetails = {};
            hr = XGameStreamingGetDisplayDetails(client, DEFAULT_GAME_WIDTH * DEFAULT_GAME_HEIGHT, GAME_WIDEST_SUPPORTED_ASPECT_RATIO, GAME_TALLEST_SUPPORTED_ASPECT_RATIO, &displayDetails);

            if (SUCCEEDED(hr))
            {
                useDefaultResolution = false;

                // Assuming the game supports all resolutions, use the stream resolution to the preferred dimensions as provided.
                if (s_currentStreamWidth != displayDetails.preferredWidth || s_currentStreamHeight != displayDetails.preferredHeight)
                {
                    changeResolution = true;
                    s_currentStreamWidth = displayDetails.preferredWidth;
                    s_currentStreamHeight = displayDetails.preferredHeight;
                }
            }
            else
            {
                LogFormat(L"XGameStreamingGetDisplayDetails failed %x", hr);
            }
        }
        else
        {
            LogFormat(L"XGameStreamingGetClients failed hr=%x clientsUsed=%d", hr, clientsUsed);
        }
    }

    if (useDefaultResolution)
    {
        if (s_currentStreamWidth != DEFAULT_GAME_WIDTH || s_currentStreamHeight != DEFAULT_GAME_HEIGHT)
        {
            changeResolution = true;
            s_currentStreamWidth = DEFAULT_GAME_WIDTH;
            s_currentStreamHeight = DEFAULT_GAME_HEIGHT;
        }
    }

    if (changeResolution)
    {
        // Update the stream to the new resolution.
        HRESULT hr = XGameStreamingSetResolution(s_currentStreamWidth, s_currentStreamHeight);
        if (SUCCEEDED(hr))
        {
            // Update the game to render at the new resolution.
        }
        else
        {
            LogFormat(L"XGameStreamingSetResolution failed %x", hr);
        }
    }
}

要件

ヘッダー: xgamestreaming.h
ライブラリ: xgameruntime.lib
サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

次の方法で共有

XGameStreamingGetDisplayDetails

構文

パラメーター

戻り値

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

解説

例

要件

関連項目

その他のリソース