小程序音视频通话（for 硬件）

接入流程和常见问题也可参考微信小程序音视频通话（for 硬件） 使用手册

借助微信小程序音视频通话（for 硬件）能力，硬件开发者可以通过小程序硬件框架(WMPF)，实现智能设备和手机微信端的一对一音视频通话，满足实时触达场景，提升通话体验。

下图为手机端的示意图，授权弹窗、通话提醒、通话界面为微信提供的统一界面，硬件小程序接入微信 VOIP 通话插件后，可实现上述功能。

适用于校园话机、门禁机、智能门锁、智慧中控屏、智能电视、智能摄像头、智能音箱、智慧养老等多种设备和场景，支持硬件设备和手机端双向通话，实现通话强提醒。

以下几个环节可以同时进行，涉及到多个平台侧的审核流程，请提前预留时间。

这里指与用户微信进行通话的对端设备，并非指运行微信客户端的手机设备。

注册微信终端合作平台和微信开放平台账号、登记设备信息等环节均涉及平台审核，请提早准备。

参考文档指引，完成「微信终端合作平台 (wecooper)」企业主体账号注册、移动应用绑定和硬件注册的流程。

本步骤主要是将设备接入微信的设备体系，完成设备与 APP，以及 APP 与小程序之间的关联。

此环节涉及平台审核，请提早准备。

小程序想要使用音视频通话能力能力，需要接入设备，详见「设备接入」文档。

本步骤主要是将设备接入微信小程序的硬件能力，完成小程序与设备之间的关联。

完成接入后，开发者可获得由平台分配的 model_id 。model_id 对应一种设备类型，也是调用小程序设备能力相关接口的重要凭证。

小程序音视频通话的主要功能通过「VOIP 通话」这一小程序插件（appId: wxf830863afde621eb）提供。

登录「小程序管理后台」——「设置」——「第三方设置」——「插件管理」，点击「添加插件」，搜索并添加「VOIP 通话」插件。

设备端需要集成 VOIP SDK 进行设备验证所需的 RPMBD 服务。设备厂商需要保证设备的 RPMB 分区没有被使用过。

请在 此处 下载对应平台、版本的 rpmbd 二进制文件（名称为 rmpbd）

小程序音视频通话需要使用 EMMC/UFS 存储上的 RPMB 分区来保证设备的身份。设备厂商需要内置一个 RPMB 分区读写及通信的服务，并保证服务能够开机正常启动。

具体流程可以参考 RPMBD 服务文档

注意：

在设备端，开发者需要运行一个安卓应用（文档中也称为小程序 Launcher），用来进行设备注册、运行小程序和发起 VOIP 通话。

在安卓平台上，小程序视频通话能力是在小程序中实现的。需要由设备端运行的安卓应用拉起开发者开发的小程序来发起和接听音视频通话。

在完成 2.2 中的接入流程，并进行设备注册后，可以获得 WMPF 运行所需的 productId 、keyVersion、deviceId、signature 等硬件信息。

请参考文档中的说明，完成下列操作：

请在 此处 下载 VOIP SDK 的 aar 文件（名称为 voipsdk-x.x-release.aar）。

开发者需要在小程序的 Launcher 应用中接入 VOIP SDK，SDK 主要提供以下能力

在发起通话前，需要先完成设备注册。

具体接口和示例代码请参考 SDK 使用文档。

注意：

开发者需要开发（或使用现有）小程序，接入「VOIP 通话」插件，实现拨打和接听音视频通话的能力。

与安卓设备通话时，开发者需要使用同一个小程序，既运行在安卓设备端（设备发起或接听通话），也运行在手机端微信客户端（手机用户发起或接听通话）。

设备端和用户的手机微信客户端，都既可以作为拨打方（caller），也可以作为接听方（listener）。

完成 2.4 中的插件接入后，参考插件文档在小程序中引入插件。

设备和用户间如果要进行通话，需要用户在手机端先对设备进行授权。

用户授权前，需要在小程序中，从开发者的后台通过获取设备票据 接口拿到设备票据 snTicket。

拿到 snTicket 后，需要在小程序内调用 wx.requestDeviceVoIP 请用户进行授权。

需要基础库 >= 2.27.3 支持

注意：

开发者需要兼容用户取消授权的情况

查询当前登录的用户同意/拒绝授权了哪些设备。在手机端调用，可用于在手机端发起通话前验证授权状态。

基础库 >= 2.30.3 支持

根据 openId，查询指定用户是否授权某台设备。一般在设备端使用，可用于在设备端发起通话前（联系人页面）验证授权状态。

在用户对设备进行授权（参见 5.2）后，设备可以向已授权用户发起音视频通话。

如果要获取通话过程的各类事件，可以使用插件的 onVoipEvent 接口。详情请参考插件文档

发起通话前，一般需要用户选择拨打给的用户和通话的类型（音频/视频）。

根据业务场景不同，发起通话前的流程（如选择联系人和房间类型）可以在小程序的另一个页面中或者安卓应用中进行。

适用于用户发起通话前的页面（如联系人选择等）是小程序页面时。

发起通话时，设备端需要在之前的页面中调用插件的 initByCaller 接口获取 groupId，然后跳转到插件的发起通话页面。

适用于用户发起通话前的页面（如联系人选择等）是安卓应用页面时。

发起通话时，需要安卓应用调用 WMPF LaunchWxaApp 接口拉起小程序，path 直接使用插件的拨打页面 plugin-private://wxf830863afde621eb/pages/call-page-plugin/call-page-plugin?isCaller=1&roomType=${roomType}，roomType 按用户实际选择填写。路径后可以带自定义参数，如 &a=1

这种情况下，开发者可以直接在小程序 App.onShow 或插件 callPageOnShow 事件回调时调用 initByCaller，插件会直接进入拨打状态，不需要额外进行页面跳转。

建议开发者使用 5.5.2 的「小程序预热」能力加快小程序的启动速度。

注意

用户在手机端可以收到「响铃+振动」的强提醒通知，点击接听按钮后，会启动小程序并直接进入「VOIP 通话」插件页面接听通话。完成通话后，会跳转到开发者配置的页面。

开发者可以自定义接听页面按钮，以及通话结束跳转页。详情请参考插件文档

在用户对设备进行授权（参见 5.2）后，可以向设备发起音视频通话。

此时，设备端会收到一条 WMPF 的推送消息，开发者需要在收到消息后拉起小程序的指定页面让用户接听通话。

如果要获取通话过程的各类事件，可以使用插件的 onVoipEvent 接口。详情请参考插件文档

发起通话前，一般需要用户在小程序中选择拨打的设备和通话的类型（音频/视频）。

发起通话时，开发者需要先从后台拿到从设备端获取的 pushToken，并在小程序中调用插件的 initByCaller 接口获取 groupId，然后跳转到插件的发起通话页面。

注意

在手机端发起通话后，设备端会收到一条 WMPF 的推送消息。开发者应该进行以下处理：

1) 绑定消息监听

开发者需要在 WMPF 中调用 SetPushMsgCallback 注册消息监听。注意，这一步必须在通话发起前进行。

2) 展示来电通知/提醒（可选）

收到消息后，开发者可以根据产品需要展示来电通知（样式可以自定义），也可直接拉起小程序让用户进行接听。

3) 打开小程序接听

推送消息为 JSON 字符串，解析后格式如下

开发者需要使用上述参数，调用 WMPF LaunchWxaApp 接口打开小程序的接听界面。

注意

要让用户的接听和拨打体验更加流畅，关键是要缩短接听和拨打时小程序启动和一些网络请求的耗时。

小程序的冷启动需要一定的时间，尤其是在性能较差的设备上，启动耗时可能会偏长。影响用户拨打和接听音视频通话的体验。

建议开发者参考《启动性能优化文档》优化小程序的启动耗时。

在设备端 WMPF，我们额外提供了「小程序预热」的能力，在用户使用小程序前，就预先将小程序在后台以无界面的形式启动并常驻运行，以便用户使用时可以直接把小程序切前台，而不需要完整进行冷启动流程。流程如下：

小程序开发者需要对预热启动的情况进行识别和适配：

注意

如果做了小程序预热，无需再进行环境预加载

如果因为设备资源紧张等原因，不便通过预热的方式将小程序后台常驻，也可以使用 PreloadRuntime 接口对小程序环境进行预加载。这个接口只会预创建一个基础的小程序运行环境和小程序基础库，不会启动某个具体的小程序。

默认情况下，调用 WMPF CloseWxaApp 接口关闭小程序时，会直接销毁小程序的实例，下次使用需要重新冷启动（或预热）。

建议开发者在关闭小程序时，传入 keepRunning 为 true，此时小程序会直接切后台，下次使用时可以直接复用，避免重复冷启动或重复预热。

调用插件 initByCaller 发起通话时使用的 caller_ticket 和 pushToken 这类票据都需要从微信后台获取，如果在用户点击后再获取，可能会延长发起通话的耗时。

建议开发者在用户发起通话的前置页面（例如：联系人页面等）提前准备好这些参数，如果用户在票据有效期内发起通话，不需要重新获取。

接听方收到消息推送点击接听后，默认打开的是正式版的小程序。

在开发阶段，建议在调用 wmpfVoip.initByCaller 时额外传入 miniprogramState 参数指定打开开发版小程序。

注意：

设备端发起通话时必须处于未登录状态。需要提前在有登录态的情况提前启动过开发版小程序完成代码包下载，再退出登录。步骤如下

1) WMPF 获取不到正确的摄像头，或摄像头画面旋转

可以使用 InitGlobalConfig 接口指定小程序使用的摄像头三元组（productId、vendorId、serialNumber），也可以指定摄像头画面的旋转角度。