Skip to content

[camerax] Update README to encourage users to opt in #6352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
auto-submit merged 8 commits into from
Mar 19, 2024
Merged

[camerax] Update README to encourage users to opt in #6352

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
61f143e
Change note
camsim99 Mar 18, 2024
4297c92
Rewrite
camsim99 Mar 19, 2024
93f5933
Add bold
camsim99 Mar 19, 2024
86fd12e
Merge remote-tracking branch 'upstream/main' into camx_usecamx
camsim99 Mar 19, 2024
36eeab3
Merge remote-tracking branch 'upstream/main' into camx_usecamx
camsim99 Mar 19, 2024
b6a3ec9
Add timeframe
camsim99 Mar 19, 2024
cb576f9
Bump version
camsim99 Mar 19, 2024
1041abe
review
camsim99 Mar 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Rewrite
  • Loading branch information
@camsim99
camsim99 committed Mar 19, 2024
commit 4297c92b255c2bbebe2e480793acc1a51d93ffc2
21 changes: 8 additions & 13 deletions packages/camera/camera_android_camerax/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@

An Android implementation of [`camera`][1] that uses the [CameraX library][2].

*Note*: Unless any of the [missing features and limitations](#missing-features-and-limitations)
may restrict you from using this implementation, please see [the instructions](#usage)
on how to use this platform implementation in place of [`camera_android`][4] as
support for it will eventually stop. Additionally, if there are any reasons you are unable to
use this package instead of `camera_android` besides those listed [below](#missing-features-and-limitations),
please report these by filing issues under [`flutter/flutter`][5] with `[camerax]` in
the title, which will be actively triaged.
*Note*: This implementation will eventually become the default implementation
Copy link

@mariamhas mariamhas Mar 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small nit: should we be more prescriptive of when we estimate this becomes the default? eventually makes it still seem like it is far off.

Copy link
Contributor Author

@camsim99 camsim99 Mar 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed this to "by May" to give us until I/O (though we should try making the breaking change well before then, at least a couple of weeks I'd say). LMK what you think!

of `camera` on Android, so we strongly encourage you to opt into using it
by using [the instructions](#usage) below. If any of [the limitations](#limitations)
prevent you from using `camera_android_camerax` or if you run into any problems,
please report these issues under [`flutter/flutter`][5] with `[camerax]` in
the title.

## Usage

Expand All @@ -21,21 +20,17 @@ dependency in addition to `camera`:
dependencies:
# ...along with your other dependencies
camera: ^0.10.4
camera_android_camerax: ^0.5.0
camera_android_camerax: ^0.6.0
Copy link
Contributor Author

@camsim99 camsim99 Mar 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will land after #6176 which will bump the plugin to version 0.6.0 as it has reached feature parity with camera_android.

Copy link
Collaborator

@stuartmorgan-g stuartmorgan-g Mar 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternately, we could replace this whole section with something like "To use this plugin instead of camera_android, run flutter pub add camera_android_camerax in your project." That will give the latest version.

```

## Missing features and limitations
## Limitations

### 240p resolution configuration for video recording

240p resolution configuration for video recording is unsupported by CameraX,
and thus, the plugin will fall back to 480p if configured with a
`ResolutionPreset`.

### Focus mode configuration \[[Issue #120467][120467]\]

`setFocusMode` is unimplemented.

### Setting maximum duration and stream options for video capture

Calling `startVideoCapturing` with `VideoCaptureOptions` configured with
Expand Down