XClosedCaptionSetEnabled
クローズド キャプションが有効か無効かを示すブール値を設定します。
構文
HRESULT XClosedCaptionSetEnabled(
bool enabled
)
パラメーター
enabled _In_
型: bool
クローズド キャプションを有効か無効かを示すブール値。
戻り値
型: HRESULT
成功した場合は HRESULT。 それ以外の場合は、 エラー コードを返します。
エラー コードの一覧については、「エラー コード」を参照してください。
解説
注意
この関数は、時間依存のスレッドで呼び出すのに安全ではありません。 詳細については、「時間依存のスレッド」を参照してください。
この関数が成功するには、クローズド キャプションが有効である必要があります。 ユーザーは、ゲーム タイトルの UI で、クローズド キャプション機能を有効にする必要があります。
クローズド キャプションを有効としてフラグを設定するには、enabled を true または 1 に設定します。 クローズド キャプションを無効としてフラグを設定するには、enabled を false または 0 に設定します。
次の例では、プログラムでクローズド キャプションを有効にする方法を示します。
//The user must first enable closed captions in the UI of the Game title. Afterwards, the game title can set the Boolean flag.
if (SUCCEEDED(XClosedCaptionsSetEnabled(true)))
{
// Closed captions successfully enabled
}
要件
ヘッダー: XAccessibility.h
ライブラリ: xgameruntime.lib
サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体