Flutter 3D身份识别插件gts_myid_3d的使用

gts_myid_3d

GTS-MyID SDK flutter 插件。

目录

• 项目调整
• 使用方法
• SDK 错误码

Android SDK: 1.1.1

iOS SDK: 1.1.0

项目调整

iOS

更新你的 iOS 配置文件。

在 ios/Podfile 中将版本设置为 13：

platform :ios, '13.0'

在 ios/YourProjectName/Info.plist 中添加相机权限描述：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <!-- 添加以下两行 -->
    <key>NSCameraUsageDescription</key>
    <string>Required for document and facial capture</string>
    <!-- ... -->
</dict>
</plist>

使用方法

以下是如何初始化和使用 gts_myid_3d 的示例代码：

var result = await GtsClient.start(
  config: GtsConfig(
    locale: GtsLocale.english
  ),
);

参数详细说明：

SDK 错误码

在调用 SDK 时可能会出现以下错误码。这些错误码仅供参考。

示例代码

以下是一个完整的示例代码，展示如何在 Flutter 中集成和使用 gts_myid_3d 插件：

import 'dart:async';

import 'package:flutter/material.dart';
import 'package:gts_myid_3d/gts_myid_3d_enums.dart'; // 导入枚举类
import 'package:gts_myid_3d/gts_myid_3d.dart'; // 导入主插件类
import 'package:gts_myid_3d/gts_myid_3d_config.dart'; // 导入配置类

void main() {
  runApp(const MyApp()); // 启动应用
}

class MyApp extends StatefulWidget {
  const MyApp({super.key}); // 构造函数

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState(); // 初始化状态
}

class _MyAppState extends State<MyApp> {
  String? _error; // 存储错误信息
  GtsResult? _result; // 存储结果

  Future<void> init() async { // 初始化方法
    String? error;
    GtsResult? result;

    try {
      // 调用 GtsClient.start 方法并传入配置
      final gtsResult = await GtsClient.start(config: GtsConfig(
        locale: GtsLocale.kyrgyz // 设置语言为吉尔吉斯语
      ));
      
      error = null; // 如果成功，清空错误
      result = gtsResult; // 存储结果
    } catch (e) {
      error = e.toString(); // 捕获异常并存储错误信息
      result = null;
    }

    // 确保组件未被移除后再更新 UI
    if (!mounted) return;

    setState(() {
      _error = error; // 更新错误信息
      _result = result; // 更新结果
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp( // 主应用结构
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Gts-MyID 示例'), // 应用标题
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center, // 垂直居中对齐
            children: [
              MaterialButton( // 按钮用于启动 SDK
                onPressed: init, // 点击按钮触发 init 方法
                child: const Text('启动 SDK'), // 按钮文本
              ),
              Text( // 显示结果或错误信息
                _result?.videoPath ?? _error ?? '失败', // 如果有视频路径显示路径，否则显示错误或失败
                textAlign: TextAlign.center, // 文本居中对齐
              ),
            ],
          ),
        ),
      ),
    );
  }
}