AppCaptureMetadataWriter.StartStringState Method

Definition

Namespace:

Windows.Media.Capture

Adds a new double metadata state.

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

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

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

function startStringState(name, value, priority)

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

Parameters

name

String

Platform::String

winrt::hstring

The name of the metadata state.

value

String

Platform::String

winrt::hstring

The value of the metadata state.

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 state with the window of time between when the state is started and when its value is changed or the state is stopped with a call to StopAllStates. To store a string value that applies to an instantaneous moment in time, use AddStringEvent.