小程序开放平台

文档中心
基础
路由
跳转
转发
界面
网络
支付
数据缓存
媒体
位置
开放接口
设备
剪贴板
网络
电话
内存
扫码
屏幕
setVisualEffectOnCapture
getScreenRecordingState
onUserCaptureScreen
offUserCaptureScreen
XHSML
性能
第三方平台
文件
数据分析
画布

xhs.getScreenRecordingState

开发
>
JS API
>
设备
>
屏幕
>
getScreenRecordingState
>
更新时间:2025-04-11 19:05:18

以Promise风格调用: 不支持。

查询用户是否在录屏

参数

Object object

属性
类型
默认值
必填
说明
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性
类型
说明
statusstring录屏状态
errMsgstring
status 的合法值
合法值
说明
on开启
off关闭

返回值

Object res

属性
类型
说明
codenumber
dataobject
msgstring

实例代码

function getScreenRecordingState() {
  xhs.getScreenRecordingState({
    success: (res) => {
      console.log('查询录屏状态成功:', res);
      if (res.status === 'on') {
        console.log('录屏状态: 开启');
      } else if (res.status === 'off') {
        console.log('录屏状态: 关闭');
      }
    },
    fail: (err) => {
      console.error('查询录屏状态失败:', err);
    },
    complete: () => {
      console.log('查询录屏状态操作完成');
    }
  });
}

// 调用示例
getScreenRecordingState();