setVisualEffectOnCapture
该 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)
功能说明:监听用户主动截屏事件。用户使用系统截屏按键截屏时触发,只能注册一个监听。
参数及说明:function listener,用户主动截屏事件的监听函数。
示例代码:
wx.onUserCaptureScreen(function (res) {console.log('用户截屏了')})
onScreenRecordingStateChanged
该 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)
功能说明:用户主动截屏事件。取消事件监听。
参数及说明:function callback,用户主动截屏事件的回调函数。
offScreenRecordingStateChanged
该 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 使用方法为 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最亮 |