VideoStreamDescriptor.Label Property

Definition

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

public:
 property Platform::String ^ Label { Platform::String ^ get(); void set(Platform::String ^ value); };
winrt::hstring Label();

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

Property Value

String

An app-defined label that identifies a video stream.

Implements

Windows requirements

Device family
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v5.0)

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.

Applies to