> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XGameStreamingGetAssociatedFrame

> XGameStreamingGetAssociatedFrame

# XGameStreamingGetAssociatedFrame

<Info>**Déprécié.** Cette API est dépréciée depuis la version 2604 du GDK et sera supprimée dans une version future du GDK. Il n'existe aucune API de remplacement : les titres doivent plutôt utiliser [XGameStreamingGetStreamAddedLatency](/fr-CA/reference/system/xgamestreaming/functions/xgamestreaminggetstreamaddedlatency) pour les ajustements de jouabilité tenant compte de la latence.</Info>

Obtient le jeton de pipeline d'images à partir d'une lecture d'entrée précise.

## Syntaxe

```cpp theme={null}
HRESULT XGameStreamingGetAssociatedFrame(  
         IGameInputReading* gamepadReading,  
         D3D12XBOX_FRAME_PIPELINE_TOKEN* framePipelineToken  
)  
```

### Paramètres

*gamepadReading*   \_In\_\
Type : IGameInputReading\*

Lecture de manette interrogée.

*framePipelineToken*   \_Out\_\
Type : D3D12XBOX\_FRAME\_PIPELINE\_TOKEN\*

Jeton de pipeline d'images associé à l'image qui était affichée sur l'appareil du client lorsque l'entrée a été effectuée par le joueur.  Ce jeton de pipeline correspond à l'appel PresentX effectué lorsque l'image a été présentée par le jeu et envoyée à l'appareil client.

### Valeur de retour

Type : HRESULT

Retourne **S\_OK** en cas de réussite; sinon, retourne un code d'erreur.

#### Erreurs potentielles

| Code d'erreur | Valeur d'erreur | Cause de l'erreur |
| - | - | - |
| E\_GAMESTREAMING\_NOT\_INITIALIZED | 0x89245400 | Le runtime XGameStreaming n'a pas été initialisé. Appelez [XGameStreamingInitialize](/fr-CA/reference/system/xgamestreaming/functions/xgamestreaminginitialize) avant d'appeler d'autres API. |
| E\_GAMESTREAMING\_NO\_DATA | 0x89245402 | Les données demandées ne sont pas disponibles. Elles pourraient l'être plus tard. |
| E\_GAMESTREAMING\_NOT\_STREAMING\_CONTROLLER | 0x89245404 | La lecture actuelle ne provient pas d'une manette de diffusion en continu. |

## Remarques

Lorsqu'un joueur diffuse un jeu en continu, `XGameStreamingGetAssociatedFrame` peut être utilisé si le jeu doit modifier son comportement en fonction de l'image précise qui était affichée sur l'appareil du joueur au moment où l'entrée a été effectuée.

Cela permettrait au jeu de prendre ses décisions de simulation en fonction de l'image que le joueur voyait au moment de l'entrée, et non de l'image actuelle.

`XGameStreamingGetAssociatedFrame` peut uniquement fournir au jeu des informations sur l'image affichée lorsqu'une nouvelle lecture d'entrée est créée.  Si le jeu doit déterminer ce qui était affiché alors qu'aucune entrée n'a peut-être été effectuée par le joueur, il doit utiliser [XGameStreamingGetLastFrameDisplayed](/fr-CA/reference/system/xgamestreaming/functions/xgamestreaminggetlastframedisplayed).

## Exemple

```C++ theme={null}
// In this example, when processing input, the game would like to pass along the frame 
// that was being displayed to the player at the time of input so that their simulation
// engine can take that into account.

// The framePipelineToken was initially captured at the callback of WaitFrameEventX

void Game::Update(DX::StepTimer const& timer)
{
    IGameInputReading* reading;
    if (SUCCEEDED(g_gameInput->GetCurrentReading(GameInputKindGamepad, g_gamepad, &reading)))
    {
        D3D12XBOX_FRAME_PIPELINE_TOKEN framePipelineToken = D3D12XBOX_FRAME_PIPELINE_TOKEN_NULL;        

        if SUCCEEDED(XGameStreamingGetAssociatedFrame(&reading, &framePipelineToken)) 
        {
            SimulateBasedOnInputAndFrameDisplayed(reading, framePipelineToken);
        }
        else 
        {
            // simulate based on current frame
            SimulateBasedOnInput(reading);
        }

        reading->Release();
    }
}

```

## Configuration requise

**En-tête :** xgamestreaming.h

**Bibliothèque :** xgameruntime.lib

**Plateformes prises en charge :** Windows, consoles de la famille XBOX One et consoles XBOX Series

## Documentation conceptuelle

* [Analyse approfondie de la compensation de latence de la diffusion de jeux en continu](/fr-CA/build/core-features/common/game-streaming/game-streaming-latency-compensation-deep-dive)

## Voir aussi

[XGameStreamingGetLastFrameDisplayed](/fr-CA/reference/system/xgamestreaming/functions/xgamestreaminggetlastframedisplayed)\
[XGameStreaming](/fr-CA/reference/system/xgamestreaming/xgamestreaming_members#Latency)\
[Vue d'ensemble de la compensation de latence de la diffusion de jeux en continu](/fr-CA/build/core-features/common/game-streaming/game-streaming-latency-compensation-overview)


## Related topics

- [XGameStreamingGetAssociatedFrame](/reference/system/xgamestreaming/functions/xgamestreaminggetassociatedframe.md)
- [XGameStreamingGetLastFrameDisplayed](/reference/system/xgamestreaming/functions/xgamestreaminggetlastframedisplayed.md)