Media​Capture​Settings Media​Capture​Settings Media​Capture​Settings Class

Definition

Contains read-only configuration settings for the MediaCapture object.

public sealed class MediaCaptureSettings : IMediaCaptureSettings, IMediaCaptureSettings2public sealed class MediaCaptureSettings : IMediaCaptureSettings, IMediaCaptureSettings2Public NotInheritable Class MediaCaptureSettings Implements IMediaCaptureSettings, IMediaCaptureSettings2
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
microphone webcam

Remarks

To get an instance of this class, retrieve the MediaCapture.MediaCaptureSettings property.

For how-to guidance for using the MediaCapture object to capture audio, photos, and video, see Camera.

Note

: This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX) and Using Windows Runtime objects in a multithreaded environment (.NET).

Properties

AudioDeviceId AudioDeviceId AudioDeviceId

Gets the DeviceInformation.Id of the microphone.

public PlatForm::String AudioDeviceId { get; }public string AudioDeviceId { get; }Public ReadOnly Property AudioDeviceId As string
Value
string string string

The DeviceInformation.Id of the microphone.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
microphone webcam

Remarks

This method may return null if the device doesn't support this functionality. For more information, see the DeviceInformation class.

AudioProcessing AudioProcessing AudioProcessing

Gets the audio processing mode.

public AudioProcessing AudioProcessing { get; }public AudioProcessing AudioProcessing { get; }Public ReadOnly Property AudioProcessing As AudioProcessing
Value
AudioProcessing AudioProcessing AudioProcessing

The audio processing mode.

Attributes

CameraSoundRequiredForRegion CameraSoundRequiredForRegion CameraSoundRequiredForRegion

Gets a value that indicates if the device’s region requires that a sound be played when a photo or video is captured.

public PlatForm::Boolean CameraSoundRequiredForRegion { get; }public bool CameraSoundRequiredForRegion { get; }Public ReadOnly Property CameraSoundRequiredForRegion As bool
Value
bool bool bool

true if the device’s region requires that a sound be played when a photo or video is captured; otherwise, false. An app may play a sound during photo or video capture even if it is not required by the device’s region.

Attributes

Remarks

App developers can use this information to determine if they should suppress playing a sound when the device takes a picture since the operating system will play a sound if it is required by the device's region.

ConcurrentRecordAndPhotoSequenceSupported ConcurrentRecordAndPhotoSequenceSupported ConcurrentRecordAndPhotoSequenceSupported

Gets a value that indicates if the capture device supports recording video and taking a photo sequence at the same time.

public PlatForm::Boolean ConcurrentRecordAndPhotoSequenceSupported { get; }public bool ConcurrentRecordAndPhotoSequenceSupported { get; }Public ReadOnly Property ConcurrentRecordAndPhotoSequenceSupported As bool
Value
bool bool bool

true if the capture device supports concurrently recording video and capturing a photo sequence; otherwise, false.

Attributes

ConcurrentRecordAndPhotoSupported ConcurrentRecordAndPhotoSupported ConcurrentRecordAndPhotoSupported

Gets a value that indicates if the capture device supports recording video and taking a photo at the same time.

public PlatForm::Boolean ConcurrentRecordAndPhotoSupported { get; }public bool ConcurrentRecordAndPhotoSupported { get; }Public ReadOnly Property ConcurrentRecordAndPhotoSupported As bool
Value
bool bool bool

true if the capture device supports concurrently recording video and capturing a photo; otherwise, false.

Attributes

Horizontal35mmEquivalentFocalLength Horizontal35mmEquivalentFocalLength Horizontal35mmEquivalentFocalLength

Gets the horizontal 35mm equivalent focal length of the camera lens on the capture device.

public IReference<uint> Horizontal35mmEquivalentFocalLength { get; }public IReference<uint> Horizontal35mmEquivalentFocalLength { get; }Public ReadOnly Property Horizontal35mmEquivalentFocalLength As IReference<uint>
Value

The horizontal 35mm equivalent focal length of the camera lens.

Attributes

Remarks

The value of Horizontal35mmEquivalentFocalLength is for the current preview resolution and may change each time the resolution is changed using VideoDeviceController.SetMediaStreamPropertiesAsync.

MediaCategory MediaCategory MediaCategory

Gets the media category of the media.

public MediaCategory MediaCategory { get; }public MediaCategory MediaCategory { get; }Public ReadOnly Property MediaCategory As MediaCategory
Value
MediaCategory MediaCategory MediaCategory

The media category

Attributes

PhotoCaptureSource PhotoCaptureSource PhotoCaptureSource

Gets the stream that is used for photo capture.

public PhotoCaptureSource PhotoCaptureSource { get; }public PhotoCaptureSource PhotoCaptureSource { get; }Public ReadOnly Property PhotoCaptureSource As PhotoCaptureSource
Value
PhotoCaptureSource PhotoCaptureSource PhotoCaptureSource

The stream that is used for photo capture.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
microphone webcam

PitchOffsetDegrees PitchOffsetDegrees PitchOffsetDegrees

Gets the pitch offset of the camera in degrees.

public IReference<int> PitchOffsetDegrees { get; }public IReference<int> PitchOffsetDegrees { get; }Public ReadOnly Property PitchOffsetDegrees As IReference<int>
Value

The pitch offset in degrees.

Attributes

StreamingCaptureMode StreamingCaptureMode StreamingCaptureMode

Gets the streaming mode.

public StreamingCaptureMode StreamingCaptureMode { get; }public StreamingCaptureMode StreamingCaptureMode { get; }Public ReadOnly Property StreamingCaptureMode As StreamingCaptureMode
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
microphone webcam

Remarks

This property indicates whether audio capture, video capture, or both are enabled.

Vertical35mmEquivalentFocalLength Vertical35mmEquivalentFocalLength Vertical35mmEquivalentFocalLength

Gets the vertical 35mm equivalent focal length of the camera lens on the capture device.

public IReference<uint> Vertical35mmEquivalentFocalLength { get; }public IReference<uint> Vertical35mmEquivalentFocalLength { get; }Public ReadOnly Property Vertical35mmEquivalentFocalLength As IReference<uint>
Value

The vertical 35mm equivalent focal length of the camera lens.

Attributes

Remarks

The value of Vertical35mmEquivalentFocalLength is for the current preview resolution and may change each time the resolution is changed using VideoDeviceController.SetMediaStreamPropertiesAsync.

VideoDeviceCharacteristic VideoDeviceCharacteristic VideoDeviceCharacteristic

Gets a value that indicates which video streams are independent of each other.

public VideoDeviceCharacteristic VideoDeviceCharacteristic { get; }public VideoDeviceCharacteristic VideoDeviceCharacteristic { get; }Public ReadOnly Property VideoDeviceCharacteristic As VideoDeviceCharacteristic
Value
VideoDeviceCharacteristic VideoDeviceCharacteristic VideoDeviceCharacteristic

A value of VideoDeviceCharacteristic that indicates which video streams are independent pf each other.

Attributes

VideoDeviceId VideoDeviceId VideoDeviceId

Gets the DeviceInformation.Id of the video camera.

public PlatForm::String VideoDeviceId { get; }public string VideoDeviceId { get; }Public ReadOnly Property VideoDeviceId As string
Value
string string string

The DeviceInformation.Id of the video camera.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
microphone webcam

Remarks

This method may return null if the device doesn't support this functionality. For more information, see the DeviceInformation class.