GameRecorder.start(Object object)

基础库 2.8.0 开始支持,低版本需做兼容处理

开始录制游戏画面

参数

Object object

属性 类型 默认值 必填 说明 最低版本
fps number 24 视频 fps
duration number 7200 视频的时长限制,单位为秒(s)。最大值 7200,最小值 5,到达指定时长后不会再录入。但还需要手动调用 GameRecorder.stop() 来结束录制。
bitrate number 1000 视频比特率(kbps),默认值1000,最大值 3000,最小值 600
gop number 12 视频关键帧间隔
hookBgm boolean true 是否录制游戏音效 2.10.0

错误

错误码 错误信息 说明
wx.error.GameRecorder_UnknownError unknown error 未知错误,没有被归纳到的错误
wx.error.GameRecorder_InternalFailed internal failed 游戏画面录制 SDK 内部错误
wx.error.GameRecorder_NotSupported frame not supported 当前设备不支持录制游戏画面
wx.error.GameRecorder_StartDurationInvalid duration invalid duration 参数不合法
wx.error.GameRecorder_StartBitRateInvalid bitrate invalid bitrate 参数不合法
wx.error.GameRecorder_StartFPSInvalid fps invalid fps 参数不合法
wx.error.GameRecorder_StartGOPInvalid gop invalid gop 参数不合法
wx.error.GameRecorder_StartWhileAlreadyStartRecording start while already start recording 在已经开始录制的情况下调用 start
wx.error.GameRecorder_StartWhilePaused start while already paused 在已经暂停录制的情况下调用 start,此时只能调用 resume 恢复录制
wx.error.GameRecorder_PauseWhileNotStartRecording pause while not start recording 在还没有开始录制的情况下调用 pause
wx.error.GameRecorder_PauseWhileAlreadyPaused pause while already paused 在已经暂停录制的情况下调用 pause
wx.error.GameRecorder_ResumeWhileNotStartRecording resume while not start recording 在还没有开始录制的情况下调用 resume
wx.error.GameRecorder_ResumeWhileRecording resume while recording 在录制中调用 resume,调用 resume 只能在暂停状态下
wx.error.GameRecorder_AbortWhileNotStartRecording abort while not start recording 在还没有开始录制的情况下调用 abort
wx.error.GameRecorder_StopWhileNotStartRecording stop while not start recording 在还没有开始录制的情况下调用 stop
wx.error.GameRecorder_NoVideo no recorded video 在还没有一个录制好的对局回放的情况下发起分享
wx.error.GameRecorder_BGMNotFound bgm not found share.bgm 指定的额背景音乐不存在
wx.error.GameRecorder_TimeRangeInvalid time range invalid share.timeRange 不合法
wx.error.GameRecorder_EditDurationOutOfLimit duration out of limit share.timeRange 的所有片段的总和超出上限
wx.error.GameRecorder_TimeRangeTooShort time range too short.It should be longer than 2s share.timeRange 太短