暂停/恢复发布本地的视频流

说明

该接口可以暂停（或恢复）发布本地的视频画面，暂停之后，同一房间中的其他用户将无法继续看到自己画面。

该接口在指定 TRTC_VIDEO_STREAM_TYPE_BIG 时等效于 startLocalPreview + stopLocalPreview 这两个接口，但具有更好的响应速度。

因为 startLocalPreview + stopLocalPreview 需要打开和关闭摄像头，而打开和关闭摄像头都是硬件设备相关的操作，非常耗时。

相比之下， muteLocalVideo 只需要在软件层面对数据流进行暂停或者放行即可，因此效率更高，也更适合需要频繁打开关闭的场景。

当暂停/恢复发布指定 TRTC_VIDEO_STREAM_TYPE_BIG 后，同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。

当暂停/恢复发布指定 TRTC_VIDEO_STREAM_TYPE_SUB 后，同一房间中的其他用户将会收到 onUserSubStreamAvailable 回调通知。

方法名

muteLocalVideo

用法

• 用法如下：

uniapp

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

uniappx

module.muteLocalVideo({
  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.mute	Boolean	否	无	true：暂停；false：恢复。
  params.streamType	String	否	无	要暂停/恢复的视频流类型（仅支持 TRTC_VIDEO_STREAM_TYPE_BIG 和 TRTC_VIDEO_STREAM_TYPE_SUB），可选值请参考【视频流类型】
  success	Function	否	无	执行成功的函数
  fail	Function	否	无	执行失败的函数
  complete	Function	否	无	执行完成的函数，不管成功还是失败都会执行

视频流类型

• 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.成功，其他：失败