AppCaptureMetadataWriter.AddStringEvent Method

Definition

Namespace:

Windows.Media.Capture

Adds a new string metadata event.

public:
 virtual void AddStringEvent(Platform::String ^ name, Platform::String ^ value, AppCaptureMetadataPriority priority) = AddStringEvent;

void AddStringEvent(winrt::hstring const& name, winrt::hstring const& value, AppCaptureMetadataPriority const& priority);

public void AddStringEvent(string name, string value, AppCaptureMetadataPriority priority);

function addStringEvent(name, value, priority)

Public Sub AddStringEvent (name As String, value As String, priority As AppCaptureMetadataPriority)

Parameters

name

String

Platform::String

winrt::hstring

The name of the metadata event.

value

String

Platform::String

winrt::hstring

The value of the metadata event.

priority

AppCaptureMetadataPriority

A member of the AppCaptureMetadataPriority enumeration specifying the relative importance of the metadata item. This value and the age of a metadata item are used by the system to determine which metadata items should be purged first when the limit of the allocated storage space for accumulated metadata is reached.

Remarks

The system associates a metadata event with a timestamp when this method is called. To store a string value that applies to a window of time, use StartStringState.