荧幕

setVisualEffectOnCapture

TIP

該API使用方法為： wx.setVisualEffectOnCapture(Object object)
該API小程序支持，小遊戲暫不支持

• 功能說明： 設定截圖/錄屏時荧幕表現，僅支持在Android端調用
• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  visualEffect	string	none	否	截圖/錄屏時的表現，僅支持none / hidden，傳入hidden則表示在截圖/錄屏時隱藏荧幕
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

setScreenBrightness

TIP

該API使用方法為： wx.setScreenBrightness(Object object)

• 功能說明： 設定荧幕亮度
• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  value	number	-	是	荧幕亮度值，範圍0 ~ 1，0最暗，1最亮。 在Android端支持傳入特殊值-1，表示荧幕亮度跟隨系統變化
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

setKeepScreenOn

TIP

該API使用方法為： wx.setKeepScreenOn(Object object)

• 功能說明： 設定是否保持常亮狀態。 僅在當前小程序生效，離開小程序後設定失效

• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  keepScreenOn	boolean	-	是	是否保持荧幕常亮
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• 示例代碼：

wx.setKeepScreenOn({
  keepScreenOn: true
})

onUserCaptureScreen

TIP

該API使用方法為： wx.onUserCaptureScreen(function listener)
該API小程序支持，小遊戲暫不支持

• 功能說明： 監聽用戶主動截圖事件。 用戶使用系統截圖按鍵截圖時觸發，只能注册一個監聽

• 參數及說明： function listener。用戶主動截圖事件的監聽函數

• 示例代碼：

wx.onUserCaptureScreen(function (res) {
  console.log('user capture screen')
})

onScreenRecordingStateChanged

TIP

該API使用方法為： wx.onScreenRecordingStateChanged(function listener)
該API小程序支持，小遊戲暫不支持

• 功能說明： 監聽用戶錄屏事件

• 參數及說明： function listener。用戶錄屏事件的監聽函數

  内容	類型	說明
  state	string	錄屏狀態，合法值有： 1.start: 開始錄屏 2.stop: 結束錄屏

• 示例代碼：

const handler = function (res) {
  console.log(res.state)
}
wx.onScreenRecordingStateChanged(handler)

wx.offScreenRecordingStateChanged(handler)

offUserCaptureScreen

TIP

該API使用方法為： wx.offUserCaptureScreen(function callback)
該API小程序支持，小遊戲暫不支持

• 功能說明： 用戶主動截圖事件。 取消事件監聽
• 參數及說明： function listener。用戶主動截圖事件的回呼函數

offScreenRecordingStateChanged

TIP

該API使用方法為： wx.offScreenRecordingStateChanged(function listener)
該API小程序支持，小遊戲暫不支持

• 功能說明： 移除用戶錄屏事件的監聽函數

• 參數及說明： 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) // Pass the same function object used for listening.

getScreenRecordingState

TIP

該API使用方法為： wx.getScreenRecordingState(Object object)
該API小程序支持，小遊戲暫不支持

• 功能說明： 査詢用戶是否在錄屏

• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• object.success回呼函數參數： Object res。

  内容	類型	說明
  state	string	錄屏狀態，合法值有： 1.on: 開啟 2.off: 關閉

• 示例代碼：

wx.getScreenRecordingState({
  success: function (res) {
    console.log(res.state)
  },
})

getScreenBrightness

TIP

該API使用方法為： wx.getScreenBrightness(Object object)

TIP

若Android系統設置中開啟了自動調節亮度功能，則荧幕亮度會根據光線自動調整，該接口僅能獲取自動調節亮度之前的值，而非實时的亮度值

• 功能說明： 獲取荧幕亮度

• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• object.success回呼函數參數： Object res。

  内容	類型	說明
  value	number	荧幕亮度值，範圍0 ~ 1，0最暗，1最亮