视图采集插件使用说明

环境需求

最低支持: HarmonyOS开发者版本（即API版本）5.0.1(API 13 Release)

安装SDK

此包为视图采集的插件包，请首先确保安装了核心SDK包@tingyun/sdk-core才能使用

远程安装

进入工程根目录，执行以下命令

ohpm install @tingyun/sdk-plugin-record

如果需要安装指定版本的插件, 可手动指定版本（<version>为具体的版本号）

ohpm install @tingyun/sdk-plugin-record@<version>

内网仓库安装

内网环境用户建议将涉及到的har包上传至企业内网仓库后，通过内网仓库完成安装操作

在听云控制台管理-下载中心-App端-Harmony中下载最新SDK，解压下载的zip，将tingyun-core_version.har和tingyun-plugin-record_version.har上传至企业内网仓库 进入工程根目录，执行以下命令

ohpm install @tingyun/sdk-plugin-record

如果需要安装指定版本的插件, 可手动指定版本（<version>为具体的版本号）

ohpm install @tingyun/sdk-plugin-record@<version>

初始化插件

在SDK初始化时引入插件

import tingyun from '@tingyun/sdk-core'
import ViewRecordPlugin from '@tingyun/sdk-plugin-record'

tingyun.init({
  // ...
  // 引入视图采集插件
  plugins: [ViewRecordPlugin()],
  viewRecord: {
    // 首次启动是否开启视图采集
    enabled: true
  }
})

调用API打开视图采集

视图采集即使在服务端和开关打开后依然需要用户手动调用开启:

import tingyun from '@tingyun/core';

// 开始视图采集
tingyun.startViewRecord();

其他API:

// 停止视图采集
tingyun.pauseViewRecord();
// 恢复视图采集
tingyun.resumeViewRecord();

注：

1. startViewRecord只能调用一次，且必须在pauseViewRecord和resumeViewRecord之前调用
2. 在SDK初始化之前，您可以调用视图采集API进行预配置。SDK启动时会自动使用最后一次API调用的状态作为视图采集的初始状态

隐私控制

遮罩指定页面

可以通过SDK init 配置或平台下发配置, 平台下发配置优先

SDK init 配置

tingyun.init({
  // ...
  viewRecord: {
    pageBlacklist: ['page1', 'page2']
  }
})

遮罩指定组件ID

可以通过SDK init 配置或平台下发配置, 平台下发配置优先

注意：组件ID遮罩仅支持主窗口中的组件。

tingyun.init({
  // ...
  viewRecord: {
    viewIdBlacklist: ['view1', 'view2']
  }
})

遮罩指定区域

SDK 提供API addViewRecordMaskArea 和 removeViewRecordMaskArea 用于添加和移除遮罩区域

添加遮罩区域：

import tingyun from '@tingyun/core';

tingyun.addViewRecordMaskArea({
  id: 'mask1',
  rect: {
    // 相对于屏幕左上角的横坐标, 单位: px
    x: 0,
    // 相对于屏幕左上角的纵坐标, 单位: px
    y: 0,
    // 遮罩矩形区域宽度, 单位: px
    width: 100,
    // 遮罩矩形区域高度, 单位: px
    height: 100
  }
})

移除遮罩区域：

import tingyun from '@tingyun/core';

tingyun.removeViewRecordMaskArea('mask1')

针对某个窗口禁止截图

通过windowClass.setPrivacyMode(true)设置窗口隐私模式，SDK将不会对该窗口进行视图采集

通过暂停和恢复API控制

可以通过调用tingyun.pauseViewRecord()暂停视图采集，调用tingyun.resumeViewRecord()恢复采集