Skip to content

Commit 23e56af

Browse files
authored
[camerax] Update README to encourage users to opt in (flutter#6352)
Modify README to encourage users to opt into `camera_android_camerax` to start ramping up usage before changing it to the default plugin implementation on Android.
1 parent bb247f7 commit 23e56af

File tree

3 files changed

+16
-15
lines changed

3 files changed

+16
-15
lines changed

packages/camera/camera_android_camerax/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 0.6.0+1
2+
3+
* Updates `README.md` to encourage developers to opt into this implementation of the camera plugin.
4+
15
## 0.6.0
26

37
* Implements `setFocusMode`, which makes this plugin reach feature parity with camera_android.

packages/camera/camera_android_camerax/README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,23 @@
22

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

5-
*Note*: This package is under development, so please note the
6-
[missing features and limitations](#limitations), but
7-
otherwise feel free to try out the current implementation and provide any
8-
feedback by filing issues under [`flutter/flutter`][5] with `[camerax]` in
9-
the title, which will be actively triaged.
5+
*Note*: This implementation will become the default implementation of `camera`
6+
on Android by May 2024, so **we strongly encourage you to opt into it**
7+
by using [the instructions](#usage) below. If any of [the limitations](#limitations)
8+
prevent you from using `camera_android_camerax` or if you run into any problems,
9+
please report these issues under [`flutter/flutter`][5] with `[camerax]` in
10+
the title.
1011

1112
## Usage
1213

13-
This package is [non-endorsed][3]; the endorsed Android implementation of `camera`
14-
is [`camera_android`][4]. To use this implementation of the plugin instead of
15-
`camera_android`, you will need to specify it in your `pubspec.yaml` file as a
16-
dependency in addition to `camera`:
14+
To use this plugin instead of [`camera_android`][4], run
1715

18-
```yaml
19-
dependencies:
20-
# ...along with your other dependencies
21-
camera: ^0.10.4
22-
camera_android_camerax: ^0.5.0
16+
```sh
17+
$ flutter pub add camera_android_camerax
2318
```
2419

20+
from your project's root directory.
21+
2522
## Limitations
2623

2724
### 240p resolution configuration for video recording

packages/camera/camera_android_camerax/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: camera_android_camerax
22
description: Android implementation of the camera plugin using the CameraX library.
33
repository: https://github.com/flutter/packages/tree/main/packages/camera/camera_android_camerax
44
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+camera%22
5-
version: 0.6.0
5+
version: 0.6.0+1
66

77
environment:
88
sdk: ^3.1.0

0 commit comments

Comments
 (0)