Overview topic
Overview
flutter_smartface is a Flutter plugin for integrating SmartFace Mobile on Android and iOS.
PT-BR
flutter_smartfaceé um plugin Flutter para integrar o SmartFace Mobile em Android e iOS.
Language guide
English is the primary language of this page.
PT-BR: os blocos marcados com este rótulo resumem a mesma orientação em português do Brasil.
What You Will Find Here
- Public APIs documented with dartdoc.
- License, bootstrap, and product installation APIs in FlutterSmartfaceLicensePlatform.
- Flutter-managed biometric widgets and utility APIs in FlutterSmartfaceMobilePlatform.
- Native hosted flows in SmartfaceHostedFlow.
- Enrollment flows without immediate server push in FlutterSmartfaceEnrollerPlatform.
- UI helpers such as FlutterSmartfacePlatformCameraController and SmartfaceTransparentEllipseOverlay.
Recommended Reading Order
PT-BR
Comece por licença e setup, confirme a integração nativa, escolha o fluxo biométrico e só então refine a UI e a câmera.
Integration Decision Guide
| If you need... | Prefer... |
|---|---|
| The fastest production path with native-managed screens | SmartfaceHostedFlow |
| A Flutter screen that embeds the SmartFace capture surface | FlutterSmartfaceMobilePlatform widget APIs |
| Enrollment without immediate server upload | FlutterSmartfaceEnrollerPlatform or enrollWithoutServerPushingWidget |
| Lower-level native orchestration | Activity-based methods on FlutterSmartfaceMobilePlatform |
Typical Bootstrap Sequence
- Provide the required SmartFace native binaries to the consuming app.
- Authenticate the license user and install the selected product.
- Configure
user,password, andclientIdentifierwith the biometric backend. - Restore the session on startup with
apiConfigured()when appropriate. - Choose widgets, hosted flows, or activity-based APIs for enrollment, identification, and liveness.
PT-BR
O fluxo típico é: disponibilizar binários nativos, instalar a licença, configurar credenciais biométricas, restaurar a sessão e então escolher entre widgets, hosted flows ou activities.
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_enroller Overview Biometric Flows
- Enrollment APIs focused on flows without immediate server push.
- flutter_smartface_hosted_flow Overview Biometric Flows
- Native hosted flows for identification and enrollment.
- flutter_smartface_license Overview License and Setup
- License, product, and installation APIs for SmartFace Flutter integrations.
- 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.