视频画面截图

说明

您可以通过本接口截取本地的视频画面，远端用户的主路画面以及远端用户的辅路（屏幕分享）画面。

方法名

snapshotVideo

用法

• 用法如下：

uniapp

module.snapshotVideo({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    let data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数，不管成功还是失败都会返回
  complete: (res) => {
    // console.log(res)
  }
})

uniappx

module.snapshotVideo({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    const data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数，不管成功还是失败都会返回
  // complete: (res) => {
  //   console.log(res)
  // }
} as LevenOptions)

• 参数说明

  参数名	参数类型	是否必填	默认值	参数描述
  params	Object	是	无	参数配置
  params.sourceType	String	否	无	画面来源，可选择截取视频流画面（TRTC_SNAPSHOT_SOURCE_TYPE_STREAM）、视频渲染画面（TRTC_SNAPSHOT_SOURCE_TYPE_VIEW）或 采集画面（TRTC_SNAPSHOT_SOURCE_TYPE_CAPTURE），采集画面截图更清晰，可选值请参考【视频截图数据源类型】
  params.streamType	String	否	无	视频流类型，可选择截取主路画面（TRTC_VIDEO_STREAM_TYPE_BIG，常用于摄像头）或辅路画面（TRTC_VIDEO_STREAM_TYPE_SUB，常用于屏幕分享）。，可选值请参考【视频流类型】
  params.userId	String	否	无	用户 ID，如指定空置表示截取本地的视频画面。
  success	Function	否	无	执行成功的函数
  fail	Function	否	无	执行失败的函数
  complete	Function	否	无	执行完成的函数，不管成功还是失败都会执行

视频截图数据源类型

名称	描述
TRTC_SNAPSHOT_SOURCE_TYPE_STREAM	从视频流中截取原生的视频内容，截取的内容不受渲染控件的显示控制
TRTC_SNAPSHOT_SOURCE_TYPE_VIEW	从渲染控件中截取显示的视频内容，可以做到用户所见即所得的效果，但如果显示区域过小，截取出的图片也会很小
TRTC_SNAPSHOT_SOURCE_TYPE_CAPTURE	从采集控件中截取采集到的视频内容，可以截取采集出来的高清截图

视频流类型

名称	描述
TRTC_VIDEO_STREAM_TYPE_BIG	高清大画面，一般用来传输摄像头的视频数据
TRTC_VIDEO_STREAM_TYPE_SMALL	低清小画面：小画面和大画面的内容相互，但是分辨率和码率都比大画面低，因此清晰度也更低
TRTC_VIDEO_STREAM_TYPE_SUB	辅流画面：一般用于屏幕分享，同一时间在同一个房间中只允许一个用户发布辅流视频，其他用户必须要等该用户关闭之后才能发布自己的辅流

回调

• 示例

{
"data": {},
"message": "",
"code": 0
}

• 回调说明：

  参数名	参数类型	参数描述
  message	String	消息提示
  data	Object	数据对象
  code	Integer	返回类型，0.成功，其他：失败