blob: 4b66ad3dfe32cd18943e2186f7db8204ff26b54d [file] [log] [blame] [view]
Joonas Kerttulabf018752022-02-03 18:27:03 +02001# Camera Windows Plugin
2
3The Windows implementation of [`camera`][camera].
4
5*Note*: This plugin is under development.
6See [missing implementations and limitations](#missing-features-on-the-windows-platform).
7
8## Usage
9
10### Depend on the package
11
12This package is not an [endorsed][endorsed-federated-plugin]
stuartmorgan84dfaa32022-07-20 13:27:05 -040013implementation of the [`camera`][camera] plugin, so in addition to depending
14on [`camera`][camera] you'll need to
15[add `camera_windows` to your pubspec.yaml explicitly][install].
16Once you do, you can use the [`camera`][camera] APIs as you normally would.
Joonas Kerttulabf018752022-02-03 18:27:03 +020017
18## Missing features on the Windows platform
19
20### Device orientation
21
22Device orientation detection
23is not yet implemented: [issue #97540][device-orientation-issue].
24
25### Pause and Resume video recording
26
27Pausing and resuming the video recording
28is not supported due to Windows API limitations.
29
30### Exposure mode, point and offset
31
32Support for explosure mode and offset
33is not yet implemented: [issue #97537][camera-control-issue].
34
35Exposure points are not supported due to
36limitations of the Windows API.
37
38### Focus mode and point
39
40Support for explosure mode and offset
41is not yet implemented: [issue #97537][camera-control-issue].
42
43### Flash mode
44
45Support for flash mode is not yet implemented: [issue #97537][camera-control-issue].
46
47Focus points are not supported due to
48current limitations of the Windows API.
49
50### Streaming of frames
51
52Support for image streaming is not yet implemented: [issue #97542][image-streams-issue].
53
54## Error handling
55
56Camera errors can be listened using the platform's `onCameraError` method.
57
58Listening to errors is important, and in certain situations,
59disposing of the camera is the only way to reset the situation.
60
61<!-- Links -->
62
63[camera]: https://pub.dev/packages/camera
64[endorsed-federated-plugin]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin
65[install]: https://pub.dev/packages/camera_windows/install
66[camera-control-issue]: https://github.com/flutter/flutter/issues/97537
67[device-orientation-issue]: https://github.com/flutter/flutter/issues/97540
stuartmorgan84dfaa32022-07-20 13:27:05 -040068[image-streams-issue]: https://github.com/flutter/flutter/issues/97542