VideoStreamDescriptor VideoStreamDescriptor VideoStreamDescriptor VideoStreamDescriptor Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Defines an video media stream.

public : sealed class VideoStreamDescriptor : IMediaStreamDescriptor, IVideoStreamDescriptorpublic sealed class VideoStreamDescriptor : IMediaStreamDescriptor, IVideoStreamDescriptorPublic NotInheritable Class VideoStreamDescriptor Implements IMediaStreamDescriptor, IVideoStreamDescriptor// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

See the MediaStreamSource Sample for an example of using Media Stream Source in a Windows Store app.

Constructors

VideoStreamDescriptor(VideoEncodingProperties) VideoStreamDescriptor(VideoEncodingProperties) VideoStreamDescriptor(VideoEncodingProperties) VideoStreamDescriptor(VideoEncodingProperties)

Creates an instance of the VideoEncodingProperties class using the specified video encoding.

public : VideoStreamDescriptor(VideoEncodingProperties encodingProperties)public VideoStreamDescriptor(VideoEncodingProperties encodingProperties)Public Sub New(encodingProperties As VideoEncodingProperties)// You can use this method in JavaScript.
Parameters
encodingProperties
VideoEncodingProperties VideoEncodingProperties VideoEncodingProperties VideoEncodingProperties

The encoding properties for the video stream.

Properties

EncodingProperties EncodingProperties EncodingProperties EncodingProperties

Gets the encoding properties on the video stream.

public : VideoEncodingProperties EncodingProperties { get; }public VideoEncodingProperties EncodingProperties { get; }Public ReadOnly Property EncodingProperties As VideoEncodingProperties// You can use this property in JavaScript.

Remarks

If the media pipeline cannot handle the new encoding properties, the MediaStreamSource will raise the Closed event which provides information regarding the error.

IsSelected IsSelected IsSelected IsSelected

Specifies whether the stream is currently in use by the MediaStreamSource.

public : PlatForm::Boolean IsSelected { get; }public bool IsSelected { get; }Public ReadOnly Property IsSelected As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

true if the stream is currently in use by the MediaStreamSource; otherwise, false.

Remarks

IsSelected is true if the stream represented by the stream descriptor is currently selected by the media pipeline. For example, if it is currently in use by the MediaStreamSource. Otherwise, the value is false.

The MediaStreamSource only raises the SampleRequested event for streams which are selected.

Label Label Label Label

Prerelease. 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; }public string Label { get; set; }Public ReadWrite Property Label As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

An app-defined label that identifies a video stream.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.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.

Language Language Language Language

Gets or sets the RFC-1766 language code for the stream.

public : PlatForm::String Language { get; set; }public string Language { get; set; }Public ReadWrite Property Language As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The RFC-1766 language code for the stream.

Remarks

The initial value is an empty string.

The language is specified using a RFC-1766 language code, for example, “en-US”.

Name Name Name Name

Gets or sets the name of the stream.

public : PlatForm::String Name { get; set; }public string Name { get; set; }Public ReadWrite Property Name As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The name of the stream.

Remarks

The initial value is an empty string.

The name is a free-form human readable string that describes the stream, for example, “English soundtrack”.

See Also