CameraCaptureUIPhotoCaptureSettings
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// You can use this class in JavaScript.
- Attributes
| 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 |
webcam
microphone
|
Remarks
To get an instance of this object, retrieve the PhotoSettings property.
Properties
AllowCropping AllowCropping AllowCropping AllowCropping
Determines whether photo cropping will be enabled in the user interface for capture a photo.
public : PlatForm::Boolean AllowCropping { get; set; }public bool AllowCropping { get; set; }Public ReadWrite Property AllowCropping As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True, if photo cropping will be enabled; otherwise, false.
| 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 |
webcam
microphone
|
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 CroppedAspectRatio
The aspect ratio of the captured photo.
public : Size CroppedAspectRatio { get; set; }public Size CroppedAspectRatio { get; set; }Public ReadWrite Property CroppedAspectRatio As Size// You can use this property in JavaScript.
The aspect ratio of the captured photo. If zero, the aspect ratio is not enforced.
| 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 |
webcam
microphone
|
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 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// You can use this property in JavaScript.
| 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 |
webcam
microphone
|
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 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// You can use this property in JavaScript.
- Value
- CameraCaptureUIPhotoFormat CameraCaptureUIPhotoFormat CameraCaptureUIPhotoFormat CameraCaptureUIPhotoFormat
A value that indicates the format for captured photos.
| 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 |
webcam
microphone
|
MaxResolution 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// You can use this property in JavaScript.
- Value
- CameraCaptureUIMaxPhotoResolution CameraCaptureUIMaxPhotoResolution CameraCaptureUIMaxPhotoResolution CameraCaptureUIMaxPhotoResolution
A value that indicates the maximum resolution the user will be able to select.
| 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 |
webcam
microphone
|