CameraCaptureUIPhotoCaptureSettings CameraCaptureUIPhotoCaptureSettings CameraCaptureUIPhotoCaptureSettings Class

Definition

Provides settings for capturing photos with CameraCaptureUI. The settings include aspect ratio, image size, format, resolution, and whether or not cropping is allowed by the user interface (UI).

public sealed class CameraCaptureUIPhotoCaptureSettings : ICameraCaptureUIPhotoCaptureSettingspublic sealed class CameraCaptureUIPhotoCaptureSettings : ICameraCaptureUIPhotoCaptureSettingsPublic NotInheritable Class CameraCaptureUIPhotoCaptureSettings Implements ICameraCaptureUIPhotoCaptureSettings
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
microphone webcam

Remarks

To get an instance of this object, retrieve the PhotoSettings property.

Properties

AllowCropping AllowCropping AllowCropping

Determines whether photo cropping will be enabled in the user interface for capture a photo.

public bool AllowCropping { get; set; }public bool AllowCropping { get; set; }Public ReadWrite Property AllowCropping As bool
Value
bool bool bool

True, if photo cropping will be enabled; otherwise, false.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
microphone webcam

Remarks

Imaging cropping in the CameraCaptureUI is not supported for devices in the Mobile device family. The value of the AllowCropping property is ignored when your app is running on these devices.

CroppedAspectRatio CroppedAspectRatio CroppedAspectRatio

The aspect ratio of the captured photo.

public Size CroppedAspectRatio { get; set; }public Size CroppedAspectRatio { get; set; }Public ReadWrite Property CroppedAspectRatio As Size
Value
Size Size Size

The aspect ratio of the captured photo. If zero, the aspect ratio is not enforced.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
microphone webcam

Remarks

Imaging cropping in the CameraCaptureUI is not supported for devices in the Mobile device family. The value of the CroppedAspectRatio property is ignored when your app is running on these devices.

If a non-zero value is provided, the user interface will force the user to crop the photo to the specified aspect ratio.

CroppedSizeInPixels CroppedSizeInPixels CroppedSizeInPixels

The exact size in pixels of the captured photo.

public Size CroppedSizeInPixels { get; set; }public Size CroppedSizeInPixels { get; set; }Public ReadWrite Property CroppedSizeInPixels As Size
Value
Size Size Size

The size of the captured photo.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
microphone webcam

Remarks

Imaging cropping in the CameraCaptureUI is not supported for devices in the Mobile device family. The value of the CroppedSizeInPixels property is ignored when your app is running on these devices.

If size is provided, the user interface for cropping photos will force the user to crop the photo to the specified size.

If a size is specified that is larger than any available resolution, then the captured photo will be scaled to a large enough size first.

Setting this property requires that the MaxResolution property is set to HighestAvailable and the AllowCropping property is set to True.

Format Format Format

Determines the format that captured photos will be stored in.

public CameraCaptureUIPhotoFormat Format { get; set; }public CameraCaptureUIPhotoFormat Format { get; set; }Public ReadWrite Property Format As CameraCaptureUIPhotoFormat
Value
CameraCaptureUIPhotoFormat CameraCaptureUIPhotoFormat CameraCaptureUIPhotoFormat

A value that indicates the format for captured photos.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
microphone webcam

MaxResolution MaxResolution MaxResolution

Determines the maximum resolution the user will be able to select.

public CameraCaptureUIMaxPhotoResolution MaxResolution { get; set; }public CameraCaptureUIMaxPhotoResolution MaxResolution { get; set; }Public ReadWrite Property MaxResolution As CameraCaptureUIMaxPhotoResolution
Value
CameraCaptureUIMaxPhotoResolution CameraCaptureUIMaxPhotoResolution CameraCaptureUIMaxPhotoResolution

A value that indicates the maximum resolution the user will be able to select.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
microphone webcam