-
Notifications
You must be signed in to change notification settings - Fork 3.6k
[camerax] Update README with plugin overview #3891
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.
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
Merged
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
dec3d69
Merge remote-tracking branch 'upstream/main' into camx_occ
camsim99 0e0333b
Merge remote-tracking branch 'upstream/main'
camsim99 886e049
Start writing readme
camsim99 cd1f2a7
Finish draft
camsim99 a86eeed
Merge remote-tracking branch 'upstream/main' into camx_readme
camsim99 b7e3cf6
Undo unecessary changes
camsim99 cdf2e67
Undo changelog change
camsim99 597f9d7
Second draft
camsim99 f862d81
Draft 3
camsim99 0585bfa
Draft 4
camsim99 f443d28
Merge remote-tracking branch 'upstream/main' into camx_readme
camsim99 e36d363
Address first reviews
camsim99 dfa4173
Nits
camsim99 b54433a
Merge remote-tracking branch 'upstream/main' into camx_readme
camsim99 7370a5e
address review
camsim99 8343829
Address review
camsim99 426f33b
Update changelog
camsim99 93afe6a
self review
camsim99 f59896a
Merge remote-tracking branch 'upstream/main' into camx_readme
camsim99 d0278e9
Add discord link
camsim99 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Start writing readme
- Loading branch information
commit 886e0495a79779c1b8593cb44b54f58bbf06e48d
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,62 @@ | ||
| # camera_android_camerax | ||
| # camera\_android\_camerax | ||
|
|
||
| An implementation of the camera plugin on Android using CameraX. | ||
| An Android implementation of [`camera`][1] that uses the [CameraX library][2]. | ||
|
|
||
| *Note*: This package is under development. | ||
| See [missing implementations and limitations](#missing-features-and-limitations). | ||
|
|
||
| ## Usage | ||
|
|
||
| This package is [unendorsed][3]; the endorsed Android implementation of `camera` | ||
| is [`camera_android`][4]. To use this implementation of the plugin, you will need | ||
| to specify it in your `pubsepc.yaml` file as a dependency in addition to `camera`: | ||
|
|
||
| ```yaml | ||
| dependencies: | ||
| # ...along with your other dependencies | ||
| camera: ^0.10.4 | ||
| camera_android_camerax: ^0.5.0 | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
|
|
||
| ## Missing features and limitations | ||
|
|
||
| ### Resolution configuration \[[Issue #120462][5]\] | ||
|
|
||
| Any specified `ResolutionPreset` is unused in favor of CameraX defaults and | ||
| `onCameraResolutionChanged` is unimplemented. | ||
|
|
||
| ### Locking/Unlocking capture orientation \[[Issue #125915][6]\] | ||
|
|
||
| `lockCaptureOrientation` & `unLockCaptureOrientation` are unimplemented. | ||
|
|
||
| ### Flash mode configuration \[[Issue #120715][7]\] | ||
|
|
||
| `setFlashMode` is unimplemented. | ||
|
|
||
| ### Exposure mode, point, & offset configuration \[[Issue #120468][8]\] | ||
|
|
||
| `setExposureMode`, `setExposurePoint`, & `setExposureOffset` are unimplemented. | ||
|
|
||
| ### Focus mode & point configuration \[[Issue #120467][9]\] | ||
|
|
||
| `setFocusMode` & `setFocusPoint` are unimplemented. | ||
|
|
||
| ### Zoom configuration \[[Issue #125371][9]\] | ||
|
|
||
| `setZoomLevel` is unimplemented. | ||
|
|
||
| <!-- Links --> | ||
|
|
||
| [1]: https://pub.dev/packages/camera | ||
| [2]: https://developer.android.com/training/camerax | ||
| [3]: https://docs.flutter.dev/packages-and-plugins/developing-packages#non-endorsed-federated-plugin | ||
| [4]: https://pub.dev/packages/camera_android | ||
| [5]: https://github.com/flutter/flutter/issues/120462 | ||
| [6]: https://github.com/flutter/flutter/issues/125915 | ||
| [7]: https://github.com/flutter/flutter/issues/120715 | ||
| [8]: https://github.com/flutter/flutter/issues/120468 | ||
| [9]: https://github.com/flutter/flutter/issues/120467 | ||
| [10]: https://github.com/flutter/flutter/issues/125371 | ||
camsim99 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.