MediaFrameSourceGroup
MediaFrameSourceGroup
MediaFrameSourceGroup
MediaFrameSourceGroup
Class
Definition
Represents a group of media frame sources that can be used simultaneously by a MediaCapture.
public : sealed class MediaFrameSourceGroup : IMediaFrameSourceGrouppublic sealed class MediaFrameSourceGroup : IMediaFrameSourceGroupPublic NotInheritable Class MediaFrameSourceGroup Implements IMediaFrameSourceGroup// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Remarks
Get an instance of this class by calling FindAllAsync and selecting an instance from the returned list. If you know the unique identifier of a media frame source group, you can get an instance of this class by calling FromIdAsync.
Initialize a MediaCapture object to use the selected MediaFrameSourceGroup by assigning the group to the SourceGroup property of a MediaCaptureInitializationSettings object, and then passing that settings object into InitializeAsync.
For how-to guidance on using MediaFrameSource to capture frames, see Process media frames with MediaFrameReader.
Properties
DisplayName DisplayName DisplayName DisplayName
Gets the human-readable name for the media frame source group.
public : PlatForm::String DisplayName { get; }public string DisplayName { get; }Public ReadOnly Property DisplayName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The human-readable name for the media frame source group.
Id Id Id Id
Gets a unique identifier for the media frame source group.
public : PlatForm::String Id { get; }public string Id { get; }Public ReadOnly Property Id As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
A unique identifier for the media frame source group.
Remarks
Use this identifier when calling FromIdAsync to retrieve a specific media frame source group.
SourceInfos SourceInfos SourceInfos SourceInfos
Gets a list of MediaFrameSourceInfo objects that describe each media frame source in the group.
public : IVectorView<MediaFrameSourceInfo> SourceInfos { get; }public IReadOnlyList<MediaFrameSourceInfo> SourceInfos { get; }Public ReadOnly Property SourceInfos As IReadOnlyList<MediaFrameSourceInfo>// You can use this property in JavaScript.
- Value
- IVectorView<MediaFrameSourceInfo> IReadOnlyList<MediaFrameSourceInfo> IReadOnlyList<MediaFrameSourceInfo> IReadOnlyList<MediaFrameSourceInfo>
An asynchronous action that returns a list of MediaFrameSourceInfo upon successful completion.
Methods
FindAllAsync() FindAllAsync() FindAllAsync() FindAllAsync()
Asynchronously retrieves a list of the available media frame source groups on the current device.
public : static IAsyncOperation<IVectorView<MediaFrameSourceGroup>> FindAllAsync()public static IAsyncOperation<IReadOnlyList<MediaFrameSourceGroup>> FindAllAsync()Public Static Function FindAllAsync() As IAsyncOperation( Of IReadOnlyListMediaFrameSourceGroup )// You can use this method in JavaScript.
An asynchronous operation that returns a list of MediaFrameSourceGroup objects upon completion.
FromIdAsync(String) FromIdAsync(String) FromIdAsync(String) FromIdAsync(String)
Asynchronously gets the media frame source group with the specified ID.
public : static IAsyncOperation<MediaFrameSourceGroup> FromIdAsync(PlatForm::String id)public static IAsyncOperation<MediaFrameSourceGroup> FromIdAsync(String id)Public Static Function FromIdAsync(id As String) As IAsyncOperation( Of MediaFrameSourceGroup )// You can use this method in JavaScript.
- id
- PlatForm::String String String String
The unique identifier of a media frame source group.
An asynchronous operation that returns a MediaFrameSourceGroup upon successful completion.
GetDeviceSelector() GetDeviceSelector() GetDeviceSelector() GetDeviceSelector()
Gets a device selector string that can be used to initialize a DeviceWatcher, which allows you receive notifications when the set of available media frame source groups changes.
public : static PlatForm::String GetDeviceSelector()public static string GetDeviceSelector()Public Static Function GetDeviceSelector() As string// You can use this method in JavaScript.
The device selector string for a media frame source group.