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

Lee una secuencia de captura de pantalla.

## Sintaxis

```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 de la secuencia de captura de pantalla devuelto al llamar a [XAppCaptureOpenScreenshotStream](/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream).

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

Posición de la secuencia en la que se comienza a leer.

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

Número de bytes de la secuencia que se van a leer.

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

Búfer que contendrá los bytes leídos por **XAppCaptureReadScreenshotStream**.

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

Número de bytes escritos realmente en el *buffer*.

### Valor devuelto

Tipo: HRESULT

Resultado de la función.

## Comentarios

<Note>No es seguro llamar a esta función en un subproceso con restricciones de tiempo. Para obtener más información, consulte [Subprocesos con restricciones de tiempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads).</Note>

Antes de leer una captura de pantalla, debe abrir una secuencia de captura de pantalla con [XAppCaptureOpenScreenShotStream](/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream). Esto generará el **XAppCaptureScreenshotStreamHandle** necesario para el parámetro *handle*. Después puede llamar a esta función para leer la captura de pantalla. Los parámetros *startPosition* y *bytesToRead* le permitirán leer una sección de la captura de pantalla, lo cual resulta útil para leer una secuencia grande sección por sección. Puede obtener el tamaño total de la secuencia a partir del parámetro de salida *totalBytes* de [XAppCaptureOpenScreenShotStream](/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream). Los parámetros de salida *buffer* y *bytesWritten* le ayudarán a leer con precisión los datos devueltos por esta función. Después de leer los datos de la captura de pantalla, cierre la secuencia de captura de pantalla con [XAppCaptureCloseScreenshotStream](/reference/system/xappcapture/functions/xappcaptureclosescreenshotstream) para evitar una fuga de memoria.

```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

**Encabezado:** XAppCapture.h

**Biblioteca:** xgameruntime.lib

**Plataformas compatibles:** Windows, consolas de la familia XBOX One y consolas XBOX Series

## Documentación conceptual

* [Subprocesos con restricciones de tiempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## Consulte también

[Información general de GameDVR](/build/console-features/game-dvr/gamedvr-broadcast)\
[Miembros de XAppCapture](/reference/system/xappcapture/xappcapture_members)\
[XAppCaptureOpenScreenShotStream](/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream)\
[XAppCaptureTakeScreenshot](/reference/system/xappcapture/functions/xappcapturetakescreenshot)\
[XAppCaptureCloseScreenshotStream](/reference/system/xappcapture/functions/xappcaptureclosescreenshotstream)


## Related topics

- [XAppCaptureTakeScreenshot](/es/reference/system/xappcapture/functions/xappcapturetakescreenshot.md)
- [XAppCaptureScreenshotStream](/es/reference/system/xappcapture/structs/xappcapturescreenshotstream.md)
- [XAppCapture](/es/reference/system/xappcapture/xappcapture_members.md)
- [Contenedores de API de C# de Unity para el GDK](/es/build/gdk-and-engines/unity/unity-api-wrappers.md)
- [XAppCaptureOpenScreenshotStream](/es/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream.md)