mobile_scanner_web.dart
6.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
import 'dart:async';
import 'dart:ui_web' as ui_web;
import 'package:flutter/widgets.dart';
import 'package:flutter_web_plugins/flutter_web_plugins.dart';
import 'package:mobile_scanner/src/enums/mobile_scanner_error_code.dart';
import 'package:mobile_scanner/src/enums/torch_state.dart';
import 'package:mobile_scanner/src/mobile_scanner_exception.dart';
import 'package:mobile_scanner/src/mobile_scanner_platform_interface.dart';
import 'package:mobile_scanner/src/mobile_scanner_view_attributes.dart';
import 'package:mobile_scanner/src/objects/barcode_capture.dart';
import 'package:mobile_scanner/src/objects/start_options.dart';
import 'package:mobile_scanner/src/web/barcode_reader.dart';
import 'package:mobile_scanner/src/web/zxing/zxing_barcode_reader.dart';
import 'package:web/web.dart';
/// A web implementation of the MobileScannerPlatform of the MobileScanner plugin.
class MobileScannerWeb extends MobileScannerPlatform {
/// Constructs a [MobileScannerWeb] instance.
MobileScannerWeb();
/// The alternate script url for the barcode library.
String? _alternateScriptUrl;
/// The internal barcode reader.
final BarcodeReader _barcodeReader = ZXingBarcodeReader();
/// The stream controller for the barcode stream.
final StreamController<BarcodeCapture> _barcodesController =
StreamController.broadcast();
/// The subscription for the barcode stream.
StreamSubscription<Object?>? _barcodesSubscription;
/// The container div element for the camera view.
///
/// This container element is used by the barcode reader.
HTMLDivElement? _divElement;
/// The stream controller for the media track settings stream.
final StreamController<MediaTrackSettings> _settingsController =
StreamController.broadcast();
/// The view type for the platform view factory.
final String _viewType = 'MobileScannerWeb';
static void registerWith(Registrar registrar) {
MobileScannerPlatform.instance = MobileScannerWeb();
}
@override
Stream<BarcodeCapture?> get barcodesStream => _barcodesController.stream;
@override
Stream<TorchState> get torchStateStream => _settingsController.stream.map(
(settings) => settings.torch ? TorchState.on : TorchState.off,
);
@override
Stream<double> get zoomScaleStateStream => _settingsController.stream.map(
(settings) => settings.zoom.toDouble(),
);
void _handleMediaTrackSettingsChange(MediaTrackSettings settings) {
if (_settingsController.isClosed) {
return;
}
_settingsController.add(settings);
}
@override
Widget buildCameraView() {
if (!_barcodeReader.isScanning) {
return const SizedBox();
}
return HtmlElementView(viewType: _viewType);
}
@override
void setBarcodeLibraryScriptUrl(String scriptUrl) {
_alternateScriptUrl ??= scriptUrl;
}
@override
Future<MobileScannerViewAttributes> start(StartOptions startOptions) async {
await _barcodeReader.maybeLoadLibrary(
alternateScriptUrl: _alternateScriptUrl,
);
// Setup the view factory & container element.
if (_divElement == null) {
_divElement = (document.createElement('div') as HTMLDivElement)
..style.width = '100%'
..style.height = '100%';
ui_web.platformViewRegistry.registerViewFactory(
_viewType,
(int id) => _divElement!,
);
}
if (_barcodeReader.isScanning) {
throw const MobileScannerException(
errorCode: MobileScannerErrorCode.controllerAlreadyInitialized,
errorDetails: MobileScannerErrorDetails(
message:
'The scanner was already started. Call stop() before calling start() again.',
),
);
}
try {
// Clear the existing barcodes.
_barcodesController.add(const BarcodeCapture());
// Listen for changes to the media track settings.
_barcodeReader.setMediaTrackSettingsListener(
_handleMediaTrackSettingsChange,
);
await _barcodeReader.start(
startOptions,
containerElement: _divElement!,
);
} catch (error, stackTrace) {
final String errorMessage = error.toString();
MobileScannerErrorCode errorCode = MobileScannerErrorCode.genericError;
if (error is DOMException) {
if (errorMessage.contains('NotFoundError') ||
errorMessage.contains('NotSupportedError')) {
errorCode = MobileScannerErrorCode.unsupported;
} else if (errorMessage.contains('NotAllowedError')) {
errorCode = MobileScannerErrorCode.permissionDenied;
}
}
throw MobileScannerException(
errorCode: errorCode,
errorDetails: MobileScannerErrorDetails(
message: errorMessage,
details: stackTrace.toString(),
),
);
}
try {
_barcodesSubscription = _barcodeReader.detectBarcodes().listen(
(BarcodeCapture barcode) {
if (_barcodesController.isClosed) {
return;
}
_barcodesController.add(barcode);
},
);
final bool hasTorch = await _barcodeReader.hasTorch();
if (hasTorch && startOptions.torchEnabled) {
await _barcodeReader.setTorchState(TorchState.on);
}
return MobileScannerViewAttributes(
hasTorch: hasTorch,
size: _barcodeReader.videoSize,
);
} catch (error, stackTrace) {
throw MobileScannerException(
errorCode: MobileScannerErrorCode.genericError,
errorDetails: MobileScannerErrorDetails(
message: error.toString(),
details: stackTrace.toString(),
),
);
}
}
@override
Future<void> stop() async {
if (_barcodesController.isClosed) {
return;
}
// Ensure the barcode scanner is stopped, by cancelling the subscription.
await _barcodesSubscription?.cancel();
_barcodesSubscription = null;
await _barcodeReader.stop();
}
@override
Future<void> updateScanWindow(Rect? window) {
// A scan window is not supported on the web,
// because the scanner does not expose size information for the barcodes.
return Future<void>.value();
}
@override
Future<void> dispose() async {
if (_barcodesController.isClosed) {
return;
}
await stop();
await _barcodesController.close();
await _settingsController.close();
// Finally, remove the video element from the DOM.
try {
final HTMLCollection? divChildren = _divElement?.children;
if (divChildren != null) {
for (int i = 0; i < divChildren.length; i++) {
final Node? child = divChildren.item(i);
if (child != null) {
_divElement?.removeChild(child);
}
}
}
} catch (_) {
// The video element was no longer a child of the container element.
}
}
}