XAppCaptureMetadataRemainingStorageBytesAvailable

  • Article

Returns the remaining storage available for app capture metadata. Measured in bytes.

Syntax

HRESULT XAppCaptureMetadataRemainingStorageBytesAvailable(  
         uint64_t* value  
)

Parameters

value   _Out_
Type: uint64_t*

The number of bytes still available to store app capture metadata

Return value

Type: HRESULT

Function result.

Remarks

Note

This function isn't safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.

The Capture Platform will impose a limit on the total Metadata that the application can add. The developer can query the amount of storage remaining with this function and use this to determine if he is being over zealous in his use of the metadata. The platform will continue to accept new states and events even after the storage is full, but will perform cleanup operations to ensure the storage constraints are maintained. It is recommended that you monitor the storage available to avoid triggering the XAppCaptureMetaDataPurgedCallback.

Requirements

Header: XAppCapture.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

GameDVR Overview
XAppCapture Members
XAppCaptureMetaDataPurgedCallback