XClosedCaptionGetProperties

Article
03/16/2023

Returns the properties of the current closed caption.

Syntax

HRESULT XClosedCaptionGetProperties(  
         XClosedCaptionProperties* properties  
)

Parameters

properties _Out_
Type: XClosedCaptionProperties*

When the function returns, properties contains the current closed caption properties.

Return value

Type: HRESULT

HRESULT if closed captions are enabled and properties contains the current XClosedCaptionProperties. Otherwise, returns an error code.
For a list of error codes, see Error Codes.

Remarks

Note

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

For this function to be successful, closed captions must be enabled. The user must enable the closed captions feature in the UI of the Game title. If the user enabled closed captions, your Game title can flag the status of closed captions by calling XClosedCaptionSetEnabled.

The following example demonstrates how to return the closed caption properties.

XClosedCaptionProperties ccProperties;
if (SUCCEEDED(XClosedCaptionGetProperties(&ccProperties))
{
    // The game title can now access color and font settings in the ccProperties structure.
}

Requirements

Header: XAccessibility.h

Library: xgameruntime.lib

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

Share via