小程序开放平台

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

xhs.setVisualEffectOnCapture

开发
>
JS API
>
设备
>
屏幕
>
setVisualEffectOnCapture
>
更新时间:2025-04-11 19:03:56

以Promise风格调用: 不支持。

设置截屏/录屏时屏幕表现

参数

Object object

属性
类型
默认值
必填
说明
visualEffectstringnone截屏/录屏时的表现,仅支持 none / hidden,传入 hidden 则表示在截屏/录屏时隐藏屏幕
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.visualEffect 的合法值

说明
none不隐藏
hidden隐藏屏幕

object.success 回调函数

属性
类型
说明
errMsgstring

返回值

Object res

属性
类型
说明
codenumber
dataobject
msgstring

实例代码

function setVisualEffectOnCapture(visualEffect = 'none') {
  xhs.setVisualEffectOnCapture({
    visualEffect, // 截屏/录屏时的表现,可选值:'none' 或 'hidden'
    success: (res) => {
      console.log('设置截屏/录屏效果成功:', res);
    },
    fail: (err) => {
      console.error('设置截屏/录屏效果失败:', err);
    },
    complete: () => {
      console.log('设置截屏/录屏效果操作完成');
    }
  });
}

// 调用示例:设置截屏/录屏时隐藏屏幕
setVisualEffectOnCapture('hidden');

// 调用示例:设置截屏/录屏时不隐藏屏幕
setVisualEffectOnCapture('none');