UI and Camera topic

UI and Camera

This category covers the APIs used when the Flutter app owns the surrounding screen while SmartFace renders the biometric capture surface natively.

PT-BR

Esta categoria cobre as APIs usadas quando o app Flutter controla a tela ao redor enquanto o SmartFace renderiza a superfície biométrica no lado nativo.

Language guide

English is the primary language of this page.

PT-BR: os resumos com este rótulo servem como apoio rápido para leitura em português do Brasil.

Main Components

Camera Controller

FlutterSmartfacePlatformCameraController exposes camera switching, coordinated closing of the native flow, and dynamic liveness-security updates when the underlying flow supports them.

Overlay Recommendation

SmartfaceTransparentEllipseOverlay is the recommended enrollment helper for face positioning. It receives native events and updates its visual state automatically.

Widget Guidance

  • Use identifyWidget when you need a Flutter-owned identification screen.
  • Use enrollWidget when the app controls enrollment layout and wants the optional ellipse overlay integration.
  • Use livenessWidget when the only capture task is liveness validation.
  • Prefer rectInsideEllipseOverlay over the legacy faceMaskOverlay parameter when building enrollment screens.

Practical Notes

  • Keep permission handling explicit by providing a dedicated customPermissionBuilder.
  • Reuse the camera controller provided to widget builders instead of creating your own camera coordination layer.
  • Keep the Flutter overlay lightweight; capture rendering remains on the native side.

PT-BR

Na prática: trate permissões de forma explícita, reutilize o controller entregue pelo widget e mantenha os overlays Flutter leves.

Libraries

flutter_smartface_base Overview Integration UI and Camera
Core building blocks shared by the public SmartFace Flutter APIs.
flutter_smartface_camera_controller Overview UI and Camera
Camera controller exposed by SmartFace widget builders.
flutter_smartface_mobile Overview Integration License and Setup Biometric Flows UI and Camera
Main SmartFace Flutter API for biometric operations.
flutter_smartface_transparent_ellipse_overlay_widget Overview UI and Camera
SmartFace enrollment overlay with an ellipse cutout and automatic visual feedback.