MediaCaptureSettings MediaCaptureSettings MediaCaptureSettings MediaCaptureSettings Class

Definition

Namespace:
Windows.Media.Capture Windows.Media.Capture Windows.Media.Capture Windows.Media.Capture
Edit

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// You can use this class in JavaScript.
Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute ThreadingAttribute
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
webcam microphone

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 AudioDeviceId

Edit

Gets the DeviceInformation.Id of the microphone.

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

The DeviceInformation.Id of the microphone.

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

Remarks

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

AudioProcessing AudioProcessing AudioProcessing AudioProcessing

Edit

Gets the audio processing mode.

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

The audio processing mode.

CameraSoundRequiredForRegion CameraSoundRequiredForRegion CameraSoundRequiredForRegion CameraSoundRequiredForRegion

Edit

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// You can use this property in JavaScript.
Value
PlatForm::Boolean 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.

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 ConcurrentRecordAndPhotoSequenceSupported

Edit

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// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

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

ConcurrentRecordAndPhotoSupported ConcurrentRecordAndPhotoSupported ConcurrentRecordAndPhotoSupported ConcurrentRecordAndPhotoSupported

Edit

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// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

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

Horizontal35mmEquivalentFocalLength Horizontal35mmEquivalentFocalLength Horizontal35mmEquivalentFocalLength Horizontal35mmEquivalentFocalLength

Edit

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

public : IReference<uint> Horizontal35mmEquivalentFocalLength { get; }public Nullable<uint> Horizontal35mmEquivalentFocalLength { get; }Public ReadOnly Property Horizontal35mmEquivalentFocalLength As Nullable<uint>// You can use this property in JavaScript.
Value
IReference<unsigned int> Nullable<uint> Nullable<uint> Nullable<uint>

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

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 MediaCategory

Edit

Gets the media category of the media.

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

The media category

PhotoCaptureSource PhotoCaptureSource PhotoCaptureSource PhotoCaptureSource

Edit

Gets the stream that is used for photo capture.

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

The stream that is used for photo capture.

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

PitchOffsetDegrees PitchOffsetDegrees PitchOffsetDegrees PitchOffsetDegrees

Edit

Gets the pitch offset of the camera in degrees.

public : IReference<int> PitchOffsetDegrees { get; }public Nullable<int> PitchOffsetDegrees { get; }Public ReadOnly Property PitchOffsetDegrees As Nullable<int>// You can use this property in JavaScript.
Value
IReference<int> Nullable<int> Nullable<int> Nullable<int>

The pitch offset in degrees.

StreamingCaptureMode StreamingCaptureMode StreamingCaptureMode StreamingCaptureMode

Edit

Gets the streaming mode.

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

The streaming mode.

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

Remarks

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

Vertical35mmEquivalentFocalLength Vertical35mmEquivalentFocalLength Vertical35mmEquivalentFocalLength Vertical35mmEquivalentFocalLength

Edit

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

public : IReference<uint> Vertical35mmEquivalentFocalLength { get; }public Nullable<uint> Vertical35mmEquivalentFocalLength { get; }Public ReadOnly Property Vertical35mmEquivalentFocalLength As Nullable<uint>// You can use this property in JavaScript.
Value
IReference<unsigned int> Nullable<uint> Nullable<uint> Nullable<uint>

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

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 VideoDeviceCharacteristic

Edit

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// You can use this property in JavaScript.
Value
VideoDeviceCharacteristic VideoDeviceCharacteristic VideoDeviceCharacteristic VideoDeviceCharacteristic

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

VideoDeviceId VideoDeviceId VideoDeviceId VideoDeviceId

Edit

Gets the DeviceInformation.Id of the video camera.

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

The DeviceInformation.Id of the video camera.

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

Remarks

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