开发
API

tt.disableUserScreenRecord

基础库 2.7.0 开始支持本方法,低版本需做兼容处理

调用该 API 可以禁止用户录屏,该 API 仅支持在 Android 上调用。

语法

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
errNonumber错误码2.7.0

错误码说明:

errNoerrMsg说明最低支持版本
21000disableUserScreenRecord is not supported in iOS, please use onUserScreenRecord and offUserScreenRecord instead该 API 只支持 Android 系统,iOS 系统可以使用 onUserScreenRecord 和 offUserScreenRecord 来实现2.7.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

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

Bug & Tip

  • Tip:disableUserScreenRecord 只支持 Android 系统,iOS 系统可以使用 onUserScreenRecordoffUserScreenRecord 来实现禁止录屏。
  • Tip:disableUserScreenRecord 的禁止录屏效果是使当前页面录屏得到的视频为黑屏,屏幕内容不会录制,但音频内容和弹窗内容会被录制。
  • Tip:调用 disableUserScreenRecord 之后,用户在当前小程序页面无法截图。
  • Tip:建议退出不希望用户录制的页面之后,再调用 enableUserScreenRecord 恢复录屏能力。
点击纠错
评价此篇文档