Skip to content

切换指定远端用户的大小画面

说明

当房间中某个主播开启了双路编码之后,房间中其他用户通过 startRemoteView 订阅到的画面默认会是【高清大画面】。

您可以通过此接口选定希望订阅的画面是大画面还是小画面,该接口在 startRemoteView 之前和之后调用均可生效。

注意

此功能需要目标用户已经通过 enableEncSmallVideoStream 提前开启了双路编码模式,否则此调用无实际效果。

方法名

setRemoteVideoStreamType

用法

  • 用法如下:
js
module.setRemoteVideoStreamType({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    let data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数,不管成功还是失败都会返回
  complete: (res) => {
    // console.log(res)
  }
})
js
module.setRemoteVideoStreamType({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    const data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数,不管成功还是失败都会返回
  // complete: (res) => {
  //   console.log(res)
  // }
} as LevenOptions)
  • 参数说明
    参数名参数类型是否必填默认值参数描述
    paramsObject参数配置
    params.userIdString指定远端用户的 ID
    params.streamTypeString视频流类型,即选择看大画面还是小画面,默认为大画面,可选值请参考【视频流类型
    successFunction执行成功的函数
    failFunction执行失败的函数
    completeFunction执行完成的函数,不管成功还是失败都会执行

视频流类型

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

回调

  • 示例
json
{
"data": { 
  "result": 0
},
"message": "",
"code": 0
}
  • 回调说明:
    参数名参数类型参数描述
    messageString消息提示
    dataObject数据对象
    data.resultInteger设置结果
    codeInteger返回类型,0.成功,其他:失败