multipaz-compose/org.multipaz.compose.qrcode/QrCodeScanner

QrCodeScanner

@Composable
actual fun QrCodeScanner(modifier: Modifier, cameraSelection: CameraSelection, captureResolution: CameraCaptureResolution, showCameraPreview: Boolean, onCodeScanned: (qrCode: String?) -> Unit)
@Composable
expect fun QrCodeScanner(modifier: Modifier = Modifier, cameraSelection: CameraSelection, captureResolution: CameraCaptureResolution, showCameraPreview: Boolean, onCodeScanned: (qrCode: String?) -> Unit)

A composable for scanning QR codes.

On iOS this is implemented using the platform Vision API and on Android it's using the ZXing library.

This provides the guarantee that onCodeScanned will never be called with null multiple times in a row and will never be called with the same QR Code multiple times in a row. However do note that in some situations the underlying QR code scanner might flicker so onCodeScanned will be called with the QR code, then null, the QR code, then null, many times in a row.

This requires camera permission, see org.multipaz.compose.permissions.rememberCameraPermissionState.

Parameters

modifier

The composition modifier to apply to the composable.

cameraSelection

The desired hardware camera to use.

captureResolution

The desired resolution to use for the camera capture.

showCameraPreview

Whether to show the preview of the captured frame within the composable.

onCodeScanned

a callback which will be called when a QR code has been detected (in which case the contents are passed) and when a QR code is no longer detected (in which case null is passed).

actual fun QrCodeScanner(modifier: <Error class: unknown class>, cameraSelection: <Error class: unknown class>, captureResolution: <Error class: unknown class>, showCameraPreview: Boolean, onCodeScanned: (qrCode: String?) -> Unit)