Class LocalVideoDeviceInitConfig

Configuration to initialize capture on a local video device (webcam).

Inheritance
Object
LocalVideoDeviceInitConfig
Namespace: Microsoft.MixedReality.WebRTC
Assembly: Microsoft.MixedReality.WebRTC.dll
Syntax
public class LocalVideoDeviceInitConfig : object

Fields

| Improve this Doc View Source

enableMrc

Enable Mixed Reality Capture (MRC) on devices supporting the feature. This setting is silently ignored on device not supporting MRC.

Declaration
public bool enableMrc
Field Value
Type Description
Boolean
Remarks

This is only supported on UWP.

| Improve this Doc View Source

enableMrcRecordingIndicator

Display the on-screen recording indicator while MRC is enabled. This setting is silently ignored on device not supporting MRC, or if enableMrc is set to false.

Declaration
public bool enableMrcRecordingIndicator
Field Value
Type Description
Boolean
Remarks

This is only supported on UWP.

| Improve this Doc View Source

framerate

Optional capture frame rate, in frames per second (FPS). This must be a capture framerate the device supports.

Declaration
public double? framerate
Field Value
Type Description
Nullable<Double>
Remarks

This is compared by strict equality, so is best left unspecified or to an exact value retrieved by GetCaptureFormatsAsync(String).

| Improve this Doc View Source

height

Optional capture resolution height, in pixels. This must be a resolution width the device supports.

Declaration
public uint? height
Field Value
Type Description
Nullable<UInt32>
| Improve this Doc View Source

videoDevice

Optional video capture device to use for capture. Use the default device if not specified.

Declaration
public VideoCaptureDevice videoDevice
Field Value
Type Description
VideoCaptureDevice
| Improve this Doc View Source

videoProfileId

Optional unique identifier of the video profile to use for capture, if the device supports video profiles, as retrieved by one of:

Declaration
public string videoProfileId
Field Value
Type Description
String
| Improve this Doc View Source

videoProfileKind

Optional video profile kind to restrict the list of video profiles to consider. Note that this is not exclusive with videoProfileId, although in practice it is recommended to specify only one or the other. This requires videoDevice to be specified.

Declaration
public VideoProfileKind videoProfileKind
Field Value
Type Description
VideoProfileKind
| Improve this Doc View Source

width

Optional capture resolution width, in pixels. This must be a resolution width the device supports.

Declaration
public uint? width
Field Value
Type Description
Nullable<UInt32>