API 列表

    AI

    API 名称解释
    用户向服务请求识别身份证，身份证识别包括正面和背面。
    swan.ai.ocrBankCard识别银行卡并返回卡号、发卡行和卡片类型。
    对机动车驾驶证所有关键字段进行识别。
    swan.ai.ocrVehicleLicense对机动车行驶证正本所有关键字段进行识别。
    运用业界领先的深度学习技术，判断一段文本内容是否符合网络发文规范，实现自动化、智能化的文本审核。
    swan.ai.textToAudio将文本转换为可以播放的 mp3 文件。
    自定义图像审核。
    swan.ai.advancedGeneralIdentify通用物体及场景识别，即对于输入的一张图片（可正常解码，且长宽比适宜），输出图片中的多个物体及场景标签。
    用户向服务请求检测图像中的主体位置。
    swan.ai.carClassify用于检测一张车辆图片的具体车型，即对于输入的一张图片（可正常解码，且长宽比适宜），输出图片的车辆品牌及型号、颜色及年份、位置信息。
    用于菜品识别，即对于输入的一张图片（可正常解码，且长宽比适宜），输出图片的菜品名称、卡路里信息、置信度。
    swan.ai.logoClassify用于检测和识别图片中的品牌 LOGO 信息。即对于输入的一张图片（可正常解码，且长宽比适宜），输出图片中 LOGO 的名称、位置和置信度。 当效果欠佳时，可以建立子库（在控制台创建应用并申请建库）并通过调用 logo 入口接口完成自定义 logo 入库，提高识别效果。
    该请求用于识别一张图片，即对于输入的一张图片（可正常解码，且长宽比较合适），输出动物识别结果。
    swan.ai.plantClassify该请求用于识别一张图片，即对于输入的一张图片（可正常解码，且长宽比较合适），输出植物识别结果。
    获取全局唯一的语音识别器voiceRecognizer。
    swan.ai.faceDetect人脸检测，检测图片中的人脸并标记出相应的信息位置，同时可以展示出人脸的关键信息和属性信息，比如年龄，性别等。
    人脸对比，支持两张人脸图片的相似度对比，图片类型可以为：生活照，证件照，身份证芯片照或者带网纹照。
    swan.ai.faceSearch人脸搜索，传入人脸图片，支持在指定人脸图片集合中，找到与传入图片中人脸最为相似的图片。
    公安验证，基于姓名和身份证号，调取公民身份证小图（源自公安系统），将当前获取的人脸图片，与此证件小图进行对比，得出比对分数。
    swan.ai.facePersonIdmatch身份证和名字对比，验证用户输入的身份证号码和姓名是否匹配，用于判断用户信息是否真实。
    H5活体检测-语音校验码，为防止用户提交非当前操作的视频，在录制视频时，随机分配一个数字，用户需要读出这个数字，在后续识别时校验，以判断视频是否为现场录制。
    swan.ai.nlpLexerCustom词法分析，提供分词、词性标注、专名识别三大功能。

    媒体

    API 名称解释
    从本地相册选择图片或使用相机拍照。
    swan.previewImage预览图片
    获取图片信息
    swan.compressImage压缩图片接口
    保存图片到系统相册，需要用户授权。
    swan.chooseAlbum打开本地相册，相册内可以同时包含图片和视频。
    获取全局唯一的录音管理器recorderManager。
    swan.getAvailableAudioSources获取当前支持的音频输入源
    获取全局唯一的背景音频管理器 backgroundAudioManager。
    swan.createInnerAudioContext创建并返回内部 audio 上下文 innerAudioContext 对象。
    对innerAudioContext进行小程序内部的全局设置。
    swan.chooseVideo拍摄视频或从手机相册中选视频，返回视频的临时文件路径。
    保存视频到系统相册。需要用户授权。
    swan.createVideoContext创建并返回 video 上下文 videoContext 对象。通过 videoId 跟一个 video 组件绑定，通过它可以操作一个 video 组件。
    创建并返回 animation-video 上下文 animationVideo 对象。通过 animationVideoId 跟一个 animation-video 组件绑定，通过它可以操作一个 animation-video 组件。
    操作对应的 组件。 创建并返回 live-player 上下文 LivePlayerContext 对象。
    swan.createCameraContext创建并返回 camera 上下文 cameraContext对象，cameraContext 与页面的 camera 组件绑定，一个页面只能有一个 camera，通过它可以操作对应的组件。
    创建并返回 ar-camera 上下文 ARCameraContext对象，ARCameraContext 与页面的 ar-camera 组件绑定，一个页面只能有一个 ar-camera，通过它可以操作对应的组件。

    数据存储

    API 名称解释
    swan.setStorage将数据存储在本地缓存指定的 key 中。如果之前存在同名 key ，会覆盖掉原来该 key 对应的内容。这是一个异步接口。
    将数据存储在本地缓存中指定的 key 中。如果之前存在同名 key ，会覆盖掉原来该 key 对应的内容。这是一个同步接口。
    swan.getStorage从本地缓存中异步获取指定 key 对应的内容。
    从本地缓存中同步获取指定 key 对应的内容。
    swan.getStorageInfo异步获取当前 storage 的相关信息。
    同步获取当前 storage 的相关信息。
    swan.removeStorage从本地缓存中异步移除指定 key。
    从本地缓存中同步移除指定 key。
    swan.clearStorage清理本地数据缓存。
    同步清理本地数据缓存。

    位置

    API 名称解释
    swan.getLocation获取当前的地理位置、速度。当用户离开智能小程序后，此接口无法调用。
    打开地图选择位置。需要用户授权 scope.userLocation。
    swan.openLocation使用宿主 App 内置地图查看位置。
    创建并返回 map 上下文 mapContext 对象。在自定义组件下，第二个参数传入组件实例 this，以操作组件内 组件。mapContext 通过 mapId 跟一个 组件绑定，通过它可以操作对应的 组件。

    设备

    API 名称解释
    swan.getSystemInfo获取系统信息
    获取系统信息同步接口
    swan.getEnvInfoSync获取运行环境信息同步接口
    判断智能小程序的API，回调，参数，组件等是否在当前版本可用。
    swan.onMemoryWarning监听内存不足的告警事件，Android 下有告警等级划分，只有 LOW 和 CRITICAL 会回调开发者；iOS 无等级划分。
    获取网络类型
    swan.onNetworkStatusChange监听网络状态变化
    监听加速度数据，频率：5次/秒，接口调用后会自动开始监听，可使用 swan.stopAccelerometer 停止监听。
    swan.startAccelerometer开始监听加速度数据
    停止监听加速度数据
    swan.onCompassChange监听罗盘数据，频率：5次/秒，接口调用后会自动开始监听，可使用swan.stopCompass停止监听。
    开始监听罗盘数据。
    swan.stopCompass停止监听罗盘数据。
    监听设备方向变化事件。频率根据 swan.startDeviceMotionListening() 的 interval 参数。可以使用 swan.stopDeviceMotionListening() 停止监听。
    swan.startDeviceMotionListening开始监听设备方向的变化
    停止监听设备方向的变化。
    swan.getBatteryInfo支持在小程序内获取当前设备电量
    获取当前设备电量同步接口，ios系统不可用。
    swan.scanCode调起客户端扫码界面，扫码成功后返回对应的结果。
    设置屏幕亮度
    swan.getScreenBrightness获取屏幕亮度
    设置是否保持常亮状态。仅在当前智能小程序生效，离开智能小程序后设置失效。
    swan.onUserCaptureScreen监听用户主动截屏事件，用户使用系统截屏按键截屏时触发此事件。
    使手机发生较长时间的振动（400ms）
    swan.vibrateShort使手机发生较短时间的振动（15ms），仅在 iPhone 7/7 Plus 以上及 Android 机型生效。
    调用后，用户可以选择将联系人数据以“新增联系人”或“添加到已有联系人”的方式，写入手机系统通讯录，完成手机通讯录联系人和联系方式的增加。
    swan.makePhoneCall拨打电话
    设置系统剪贴板的内容
    swan.getClipboardData获取系统剪贴板内容
    向系统日历写入一个活动，之后在设定的时间提醒
    swan.deleteEventOnCalendar删除日历上的某个活动

    第三方平台

    API 名称解释
    获取第三方平台自定义的数据字段。
    swan.getExtConfigSync的同步版本。