> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XAppCaptureMetadataStartStringState

> AppCaptureMetadataStartStringState

# AppCaptureMetadataStartStringState

文字列値を持つメタデータ ステートをアプリ キャプチャに追加します。

## 構文

```cpp theme={null}
HRESULT XAppCaptureMetadataStartStringState(  
         const char* name,  
         const char* value,  
         XAppCaptureMetadataPriority priority  
)  
```

### パラメーター

*name*   \_In\_z\_\
型: char\*

アプリ キャプチャのタイムラインに追加されるステートの名前です。

*value*   \_In\_z\_\
型: char\*

タイムラインに追加されるステートの値です。 文字列である必要があります。

*priority*   \_In\_\
型: [XAppCaptureMetadataPriority](https://docs.xbox.com/ja-jp/reference/system/xappcapture/enums/xappcapturemetadatapriority.md)

メタデータの優先度です。 ストレージ制限を超えた場合に何を保存するかを決定するために使用されます。 [XAppCaptureMetaDataPriority](https://docs.xbox.com/ja-jp/reference/system/xappcapture/enums/xappcapturemetadatapriority.md) 列挙型のメンバーです。

### 戻り値

型: HRESULT

関数の結果です。

## 解説

> [!NOTE]
>
> この関数は、時間依存スレッドで呼び出しても安全ではありません。 詳細については、「[Time-sensitive threads](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)」を参照してください。

システムは、ステートが開始されてから、その値が変更されるか、[XAppCaptureMetaDataStopAllStates](https://docs.xbox.com/ja-jp/reference/system/xappcapture/functions/xappcapturemetadatastopallstates.md) の呼び出しによりステートが停止されるまでの時間範囲にメタデータ ステートを関連付けます。 このメタデータは、ライブ ストリームやキャプチャした再生中にイベントを識別し、コンテンツの分類と検索を行うために使用されます。 特定の瞬間に適用される文字列値を保存するには、[XAppCaptureMetadataAddStringEvent](https://docs.xbox.com/ja-jp/reference/system/xappcapture/functions/xappcapturemetadataaddstringevent.md) を使用します。

> [!WARNING]
>
> メタデータは、XBOX Live にアップロードされたり、.mp4 ファイルやスクリーンショットに保存されたり、ブロードキャスト中に使用される可能性があるため、ユーザーのプライベート情報をメタデータに記録しないでください。

## 要件

**ヘッダー:** XAppCapture.h

**ライブラリ:** xgameruntime.lib

**サポートされているプラットフォーム:** Windows、XBOX One ファミリー本体、XBOX Series 本体

## 概念ドキュメント

* [Time-sensitive threads](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## 関連項目

[GameDVR の概要](https://docs.xbox.com/ja-jp/build/console-features/game-dvr/gamedvr-broadcast.md)\
[XAppCapture メンバー](https://docs.xbox.com/ja-jp/reference/system/xappcapture/xappcapture_members.md)


## Related topics

- [XAppCaptureMetadataPriority](https://docs.xbox.com/ja-jp/reference/system/xappcapture/enums/xappcapturemetadatapriority.md)
- [XAppCaptureMetadataStopState](https://docs.xbox.com/ja-jp/reference/system/xappcapture/functions/xappcapturemetadatastopstate.md)
- [XAppCapture (API の内容)](https://docs.xbox.com/ja-jp/reference/system/xappcapture/xappcapture_members.md)
- [Unity プロジェクトでの GDK API 用 C# ラッパーの使用](https://docs.xbox.com/ja-jp/build/gdk-and-engines/unity/unity-api-wrappers.md)
- [XAppCaptureMetadataAddStringEvent](https://docs.xbox.com/ja-jp/reference/system/xappcapture/functions/xappcapturemetadataaddstringevent.md)