抖音开放平台Logo
控制台

tt.disableUserScreenRecord
收藏
我的收藏

基础库 2.7.0 开始支持本方法，这是一个异步方法。

调用该 API 可以禁止用户录屏，iOS 从基础库 2.98.0 开始支持 tt.disableUserScreenRecord。

前提条件无
业务背景无
使用限制无
注意事项
  • disableUserScreenRecord 的禁止录屏效果
    1. ios：当前页面无法录屏；
    2. 安卓：录屏得到的视频为黑屏，屏幕内容不会录制，但音频内容和弹窗内容会被录制；
  • 调用 disableUserScreenRecord 之后，安卓用户在当前小程序页面无法截图。
  • 建议退出不希望用户录制的页面之后，再调用 enableUserScreenRecord 恢复录屏能力。
支持沙盒
否
相关教程无

语法

tt.disableUserScreenRecord(options)

参数说明

options 为 object 类型，属性如下：

属性名类型默认值必填说明最低支持版本
successfunction否
接口调用成功的回调函数
2.7.0
failfunction否
接口调用失败的回调函数
2.7.0
completefunction否
接口调用结束的回调函数（调用成功、失败都会执行）
2.7.0

回调成功

object 类型，属性如下：

属性名类型说明最低支持版本
errMsgstring

"disableUserScreenRecord:ok"

2.7.0

回调失败

object 类型，属性如下：

属性名类型说明最低支持版本
errMsgstring

"disableUserScreenRecord:fail" + 详细错误信息

2.7.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.disableUserScreenRecord({
  success(res) {
    console.log("disableUserScreenRecord 调用成功", res);
    tt.showToast({
      title: "禁止录屏成功",
      duration: 2000,
    });
  },
  fail(res) {
    console.log("disableUserScreenRecord 调用失败", res);
  },
});