VideoStreamDescriptor.Label VideoStreamDescriptor.Label VideoStreamDescriptor.Label VideoStreamDescriptor.Label VideoStreamDescriptor.Label Property

Definition

Gets or sets an app-defined label that identifies a video stream in a MediaEncodingProfile that contains multiple streams.

public : Platform::String Label { get; set; }
winrt::hstring Label();

void Label(winrt::hstring label);
public string Label { get; set; }
Public ReadWrite Property Label As string
var string = videoStreamDescriptor.label;
videoStreamDescriptor.label = string;

Property Value

string string string

An app-defined label that identifies a video stream.

Additional features and requirements

Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

The label for each stream in a single MediaEncodingProfile must be unique. Calling SetVideoTracks to add a stream descriptor containing a duplicate label will result in an invalid argument error.

If you use a MediaFrameSourceGroup to capture multiple video streams at once, the system will attempt to match the Label property of each VideoStreamDescriptor with the Id property of each Media​Frame​Source​Info in the group in order to match the capture device with the approproate stream descriptor.