# GameRecorder.on

# GameRecorder.on(string event, function callback)

注册监听录制事件的回调函数。当对应事件触发时,回调函数会被执行。

# 参数

# string event

事件名

event 的合法值

说明 最低版本
start 录制开始事件。当调用 GameRecorder.start() 且客户端真正开始了对游戏画面录制时触发该事件。
stop 录制结束事件。当调用 GameRecorder.stop() 且客户端真正停止了对游戏画面录制时触发该事件。
pause 录制暂停事件。当调用 GameRecorder.pause() 且客户端真正暂停了对游戏画面录制时触发该事件。
resume 录制恢复事件。当调用 GameRecorder.resume() 且客户端真正恢复了对游戏画面录制时触发该事件。
abort 录制取消事件。当调用 GameRecorder.abort() 且客户端真正取消了对游戏画面录制时触发该事件。
error 错误事件。当录制和分享过程中发生错误时触发该事件。录制是指当调用 GameRecorder 的接口进行录制。

# function callback

事件触发时执行的回调函数

# 事件参数

除了 error stop 事件外,其他事件都是无参的

error

属性 类型 说明
code number 错误码
msg string 错误信息
const recorder = ks.getGameRecorder()
recorder.on('error', res => {
  console.log('错误码', res.error.code)
  console.log('错误信息', res.error.msg)

  // 对错误码进行判断
  if (res.error.code === ks.error.GameRecorder_StartWhileAlreadyStartRecording) {

  }
})

stop

属性 类型 说明
result object 录屏结束返回的数据对象,录制成功时可以获取到videoID
const recorder = ks.getGameRecorder()
recorder.on('stop', res => {
  console.log(`videoID is ${res.videoID}`)
})