> ## 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.

# XAppCaptureReadScreenshotStream

> XAppCaptureReadScreenshotStream

# XAppCaptureReadScreenshotStream

Lê um fluxo de captura de tela.

## Sintaxe

```cpp theme={null}
HRESULT XAppCaptureReadScreenshotStream(  
         XAppCaptureScreenshotStreamHandle handle,  
         uint64_t startPosition,  
         uint32_t bytesToRead,  
         uint8_t* buffer,  
         uint32_t* bytesWritten  
)  
```

### Parâmetros

*handle*   \_In\_\
Tipo: XAppCaptureScreenshotStreamHandle

Identificador do fluxo de captura de tela retornado pela chamada de [XAppCaptureOpenScreenshotStream](/pt-BR/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream).

*startPosition*   \_In\_\
Tipo: uint64\_t

Posição no fluxo em que a leitura deve começar.

*bytesToRead*   \_In\_\
Tipo: uint32\_t

Número de bytes do fluxo a serem lidos.

*buffer*   \_Out\_writes\_to\_(bytesToRead,*bytesWritten)\
Tipo: uint8\_t*

Buffer que conterá os bytes lidos por **XAppCaptureReadScreenshotStream**.

*bytesWritten*   \_Out\_\
Tipo: uint32\_t\*

Número de bytes realmente gravados no *buffer*.

### Valor retornado

Tipo: HRESULT

Resultado da função.

## Comentários

<Note>Não é seguro chamar esta função em um thread sensível ao tempo. Para obter mais informações, confira [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads).</Note>

Antes de ler uma captura de tela, você deve abrir um fluxo de captura de tela com [XAppCaptureOpenScreenShotStream](/pt-BR/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream). Isso produzirá o **XAppCaptureScreenshotStreamHandle** necessário para o parâmetro *handle*. Em seguida, você pode chamar esta função para ler a captura de tela. Os parâmetros *startPosition* e *bytesToRead* permitem ler uma seção da captura de tela, o que é útil para ler um fluxo grande uma seção por vez. Você pode obter o tamanho total do fluxo pelo parâmetro de saída *totalBytes* em [XAppCaptureOpenScreenShotStream](/pt-BR/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream). Os parâmetros de saída *buffer* e *bytesWritten* ajudarão você a ler com precisão os dados retornados por esta função. Depois de ler os dados da captura de tela, feche o fluxo de captura de tela com [XAppCaptureCloseScreenshotStream](/pt-BR/reference/system/xappcapture/functions/xappcaptureclosescreenshotstream) para evitar um vazamento de memória.

```cpp theme={null}
const int MAX_DATA = 1024;

XAppCaptureTakeScreenshotResult takeScreenshotResult = {0};
XAppCaptureScreenshotStreamHandle handle = nullptr;
XAppCaptureScreenshotFormatFlag screenshotFormat = XAppCaptureScreenshotFormatFlag::SDR;

BYTE buffer[MAX_DATA];
HANDLE file = INVALID_HANDLE_VALUE;
UINT64 totalBytesRead = 0;
UINT64 totalBytesToRead = 0;
bool hdrAvailable = false;

/* ... obtain takeScreenshotResult with XAppCaptureTakeScreenshot. Refer to corresponding documentation ... */

hdrAvailable = static_cast<bool>(takeScreenshotResult.availableScreenshotFormats & XAppCaptureScreenshotFormatFlag::HDR);

/* Note: It is optional to obtain the HDR screenshot, if HDR is available. You will need to call XAppCaptureOpenScreenshotStream twice to obtain both SDR and HDR screenshots */
if (hdrAvailable)
{
    screenshotFormat = XAppCaptureScreenshotFormatFlag::HDR;
}

if (FAILED_LOG(XAppCaptureOpenScreenshotStream(takeScreenshotResult.localId, screenshotFormat, &handle, &totalBytesToRead)))
{
    return;
}

/* T:\ is one example of a writeable local directory. Be aware that the T:\ drive can be invalidated on suspend or resume, and as such it's better to use Persistant Local Storage */
file = CreateFileA(hdrAvailable ? "T:\\MyScreenshot.jxr" : "T:\\MyScreenshot.png", GENERIC_READ | GENERIC_WRITE, 0, 0, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, 0);
if (file == INVALID_HANDLE_VALUE)
{
    /* You must always call XAppCaptureCloseScreenshotStream on an open XAppCaptureScreenshotStreamHandle to avoid a memory leak */
    FAILED_LOG(XAppCaptureCloseScreenshotStream(handle));
    return;
}

while (totalBytesRead < totalBytesToRead)
{
    uint32_t bytesRead = 0;
    uint32_t bytesWritten = 0;
    if (SUCCEEDED(XAppCaptureReadScreenshotStream(handle, totalBytesRead, sizeof(buffer), buffer, &bytesRead)))
    {
        WriteFile(file, buffer, bytesRead, &bytesWritten, NULL);

        totalBytesRead += bytesRead;
    }
    else
    {
        break;
    }
}

FAILED_LOG(XAppCaptureCloseScreenshotStream(handle));

CloseHandle(file);

```

## Requisitos

**Cabeçalho:** XAppCapture.h

**Biblioteca:** xgameruntime.lib

**Plataformas compatíveis:** Windows, consoles da família XBOX One e consoles XBOX Series

## Documentação conceitual

* [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## Confira também

[Visão geral do GameDVR](/pt-BR/build/console-features/game-dvr/gamedvr-broadcast)\
[Membros de XAppCapture](/pt-BR/reference/system/xappcapture/xappcapture_members)\
[XAppCaptureOpenScreenShotStream](/pt-BR/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream)\
[XAppCaptureTakeScreenshot](/pt-BR/reference/system/xappcapture/functions/xappcapturetakescreenshot)\
[XAppCaptureCloseScreenshotStream](/pt-BR/reference/system/xappcapture/functions/xappcaptureclosescreenshotstream)


## Related topics

- [XAppCaptureReadScreenshotStream](/reference/system/xappcapture/functions/xappcapturereadscreenshotstream.md)
- [XAppCaptureScreenshotStream](/reference/system/xappcapture/structs/xappcapturescreenshotstream.md)
- [XAppCaptureTakeScreenshot](/reference/system/xappcapture/functions/xappcapturetakescreenshot.md)
- [XAppCapture](/reference/system/xappcapture/xappcapture_members.md)
- [XAppCaptureOpenScreenshotStream](/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream.md)