Skip to content

Commit

Permalink
Updating CameraCaptureUI Spec Doc (#4895)
Browse files Browse the repository at this point in the history
* Addressing comments from PR-review!

* addressing comments

* Addressing comment
  • Loading branch information
Saharsh979 authored Nov 19, 2024
1 parent b05c65c commit 61c8a40
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
14 changes: 12 additions & 2 deletions specs/CameraCaptureUI/CameraCaptureUI.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,12 @@ 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).

**Important Note**:
- By default, `AllowCropping` is true.
- Don't specify both size and aspect ratio in the `PhotoSettings`, doing so will cause an invalid argument exception.
- `PhotoSettings` can't have a ratio or size specified with cropping disabled. Attempting to do so will result in an invalid argument exception.


## CameraCaptureUIPhotoCaptureSettings Properties

| Name | Description | Value |
Expand All @@ -207,6 +213,12 @@ and whether or not cropping is allowed by the user interface (UI).
Provides settings for capturing videos.
The settings include format, maximum resolution, maximum duration, and whether or not to allow trimming.

**Important Note**:
- By default, `AllowTrimming` is true.
- `MaxDurationInSeconds` must be a valid value (i.e., the duration should be in the range of 0 to `UINT32_MAX`). Specifying an invalid value will result in an invalid argument exception.
- `MaxDurationInSeconds` cannot be set if `AllowTrimming` is false. Attempting to do so will result in an invalid argument exception.


## CameraCaptureUIVideoCaptureSettings Properties
| Name | Description | Value |
|-|-|-|
Expand Down Expand Up @@ -355,8 +367,6 @@ namespace Microsoft.Windows.Media.Capture
}

[contract(CameraCaptureUIContract, 1)]
[threading(sta),
marshaling_behavior(none)]
runtimeclass CameraCaptureUI
{
CameraCaptureUI(Microsoft.UI.WindowId window);
Expand Down
1 change: 1 addition & 0 deletions specs/WinRT/WinRTAPIContracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ The list of all contracts defined across Windows App SDK
| AppLifecycle | windowsappsdk | AppLifecycleContract | Microsoft.Windows.AppLifecycle | |
| AppNotifications | windowsappsdk | AppNotificationsContract | Microsoft.Windows.AppNotifications | |
| BackgroundTask | windowsappsdk | BackgroundTaskContract | Microsoft.Windows.ApplicationModel.Background | |
| CameraCaptureUI | windowsappsdk | CameraCaptureUIContract | Microsoft.Windows.Media.Capture | |
| Deployment | windowsappsdk | DeploymentManagerContract | Microsoft.Windows.ApplicationModel.WindowsAppRuntime | |
| DynamicDependency | windowsappsdk | DynamicDependencyContract | Microsoft.Windows.ApplicationModel.DynamicDependency | |
| EnvironmentManager | windowsappsdk | EnvironmentManagerContract | Microsoft.Windows.System | |
Expand Down

0 comments on commit 61c8a40

Please sign in to comment.