XAppCaptureMetadataAddStringEvent
文字列型の値を持つメタデータ イベントをアプリのキャプチャに追加します。
構文
HRESULT XAppCaptureMetadataAddStringEvent(
const char* name,
const char* value,
XAppCaptureMetadataPriority priority
)
パラメーター
name _In_z_
型: char*
アプリのキャプチャ タイムラインに追加されるイベントの名前。
value _In_z_
型: char*
タイムラインに追加されるイベントの値。 文字列でなければなりません。
priority _In_
型: XAppCaptureMetadataPriority
メタデータの優先順位。 ストレージのリミッターを超えた場合に保存するものを決定するために使用されます。 XAppCaptureMetaDataPriority 列挙型のメンバー。
戻り値
型: HRESULT
関数の結果です。
解説
注意
この関数は、時間依存のスレッドで呼び出すのに安全ではありません。 詳細については、「時間依存のスレッド」をご覧ください。
このメソッドが呼び出されると、システムはメタデータ イベントをタイムスタンプに関連付けます。 このメタデータは、ライブ ストリーミング中のイベント、およびコンテンツの分類と検索のためにキャプチャされた再生を識別するために使用されます。 時間枠に適用される文字列値を保存するには、XAppCaptureMetaDataStartStringState を使用します。
注意
メタデータは、Xbox Live にアップロードされたり、.mp4 ファイルやスクリーンショットに保存されたり、配信の間に使用されたりする可能性があるため、メタ データでユーザーの個人情報を記録しないでください。
要件
ヘッダー: XAppCapture.h
ライブラリ: xgameruntime.lib
サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体
関連項目
ゲーム録画の概要
XAppCapture のメンバー
XAppCaptureMetadataAddDoubleEvent
XAppCaptureMetadataAddInt32Event