tencent cloud

腾讯云超级应用服务

动态与公告
【2025年1月2日】关于腾讯云小程序平台更名为腾讯云超级应用服务的公告
控制台更新动态
Android SDK 更新动态
iOS SDK 更新动态
Flutter 更新动态
IDE 更新动态
基础库更新动态
产品简介
产品概述
产品优势
应用场景
购买指南
计费概述
按量计费(后付费)
续费指引
停服说明
快速入门
套餐管理
概述
控制台账号管理
存储配置
加速配置
品牌化配置
平台功能
控制台登录
用户和权限体系
小程序管理
小游戏管理
应用管理
商业化
平台管理
用户管理
团队管理
运营管理
安全中心
代码接入指引
Demo 及 SDK 获取
Android
iOS
Flutter
App 服务端接入指南
GUID 生成规则
小程序开发指南
小程序介绍与开发环境
小程序代码组成
指南
框架
组件
API
服务端
JS SDK
基础库
IDE 使用指南
小游戏开发指南
指南
API
服务端
实践教程
小程序登录实践教程
小程序订阅消息实践教程
支付相关实践教程
广告接入实践教程
小游戏订阅消息实践教程
相关协议
数据处理和安全协议

屏幕

PDF
聚焦模式
字号
最后更新时间: 2025-04-10 18:18:36

setVisualEffectOnCapture

说明:
该 API 小程序支持,小游戏暂不支持。
该 API 使用方法为 wx.setVisualEffectOnCapture(Object object)
功能说明:设置截屏/录屏时屏幕表现,仅支持在 Android 端调用。
参数及说明:Object object。
属性
类型
默认值
必填
说明
visualEffect
string
none
截屏/录屏时的表现,仅支持 none / hidden,传入 hidden 则表示在截屏/录屏时隐藏屏幕
success
function
-
接口调用成功的回调函数
fail
function
-
接口调用失败的回调函数
complete
function
-
接口调用结束的回调函数(调用成功、失败都会执行)

setScreenBrightness

该 API 使用方法为 wx.setScreenBrightness(Object object)
功能说明:设置屏幕亮度。
参数及说明:Object object。
属性
类型
默认值
必填
说明
value
number
-
屏幕亮度值,范围0 ~ 1,0最暗,1最亮。在 Android 端支持传入特殊值-1,表示屏幕亮度跟随系统变化
success
function
-
接口调用成功的回调函数
fail
function
-
接口调用失败的回调函数
complete
function
-
接口调用结束的回调函数(调用成功、失败都会执行)

setKeepScreenOn

该 API 使用方法为 wx.setKeepScreenOn(Object object)
功能说明:设置是否保持常亮状态。仅在当前小程序生效,离开小程序后设置失效。
参数及说明:Object object。
属性
类型
默认值
必填
说明
keepScreenOn
boolean
-
是否保持屏幕常亮
success
function
-
接口调用成功的回调函数
fail
function
-
接口调用失败的回调函数
complete
function
-
接口调用结束的回调函数(调用成功、失败都会执行)
示例代码:
wx.setKeepScreenOn({
keepScreenOn: true
})

onUserCaptureScreen

该 API 使用方法为 wx.onUserCaptureScreen(function listener)
说明:
该 API 小程序支持,小游戏暂不支持。
功能说明:监听用户主动截屏事件。用户使用系统截屏按键截屏时触发,只能注册一个监听。
参数及说明:function listener,用户主动截屏事件的监听函数。
示例代码:
wx.onUserCaptureScreen(function (res) {
console.log('用户截屏了')
})

onScreenRecordingStateChanged

说明:
该 API 小程序支持,小游戏暂不支持。
该 API 使用方法为 wx.onScreenRecordingStateChanged(function listener)
功能说明:监听用户录屏事件。
参数及说明:function listener,用户录屏事件的监听函数。
属性
类型
说明
state
string
录屏状态,合法值有:
start:开始录屏
stop:结束录屏
示例代码:
// 监听用户录屏事件
const handler = function (res) {
console.log(res.state)
}
wx.onScreenRecordingStateChanged(handler)

// 取消监听用户录屏事件
wx.offScreenRecordingStateChanged(handler)

offUserCaptureScreen

该 API 使用方法为 wx.offUserCaptureScreen(function callback)
说明:
该 API 小程序支持,小游戏暂不支持。
功能说明:用户主动截屏事件。取消事件监听。
参数及说明:function callback,用户主动截屏事件的回调函数。

offScreenRecordingStateChanged

说明:
该 API 小程序支持,小游戏暂不支持。
该 API 使用方法为 wx.offScreenRecordingStateChanged(function listener)
功能说明:移除用户录屏事件的监听函数。
参数及说明:function listener,onScreenRecordingStateChanged 传入的监听函数。不传此参数则移除所有监听函数。
示例代码:
// 监听用户录屏事件
const handler = function (res) {
console.log(res.state)
}
wx.onScreenRecordingStateChanged(handler)

// 取消监听用户录屏事件
wx.offScreenRecordingStateChanged(handler)
const listener = function (res) { console.log(res) }

wx.onScreenRecordingStateChanged(listener)
wx.offScreenRecordingStateChanged(listener) // 需传入与监听时同一个的函数对象

getScreenRecordingState

说明:
该 API 小程序支持,小游戏暂不支持。
该 API 使用方法为 wx.getScreenRecordingState(Object object)
功能说明:查询用户是否在录屏。
参数及说明:Object object。
属性
类型
默认值
必填
说明
success
function
-
接口调用成功的回调函数
fail
function
-
接口调用失败的回调函数
complete
function
-
接口调用结束的回调函数(调用成功、失败都会执行)
object.success 回调函数参数:Object res。
属性
类型
说明
state
string
录屏状态,合法值有:
on:开启
off:关闭
示例代码:
wx.getScreenRecordingState({
success: function (res) {
console.log(res.state)
},
})

getScreenBrightness

该 API 使用方法为 wx.getScreenBrightness(Object object)
说明:
若 Android 系统设置中开启了自动调节亮度功能,则屏幕亮度会根据光线自动调整,该接口仅能获取自动调节亮度之前的值,而非实时的亮度值。
功能说明:获取屏幕亮度。
参数及说明:Object object。
属性
类型
默认值
必填
说明
success
function
-
接口调用成功的回调函数
fail
function
-
接口调用失败的回调函数
complete
function
-
接口调用结束的回调函数(调用成功、失败都会执行)
object.success 回调函数参数:Object object。
属性
类型
说明
value
number
屏幕亮度值,范围0 ~ 1,0最暗,1最亮



帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈