RtcRoomContext.changeStreamSubscribeState
收藏
我的收藏

基础库 2.68.0 开始支持本方法,这是一个异步方法。

开启/关闭订阅流

前提条件
业务背景
使用限制
注意事项
支持沙盒
相关教程

语法

RtcRoomContext.changeStreamSubscribeState(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
stateenum0
订阅/取消订阅发布流,0 :取消订阅,1:订阅。
2.68.0
userIdstring
用户 id
2.68.0
streamTypeenum

控制流类型。audio:只控制音频;video: 只控制视频;both: 同时控制音频和视频;

2.68.0
successfunction
接口调用成功的回调函数
2.68.0
failfunction
接口调用失败的回调函数
2.68.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
2.68.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"changeStreamSubscribeState:ok"
2.68.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"changeStreamSubscribeState:fail" + 详细错误信息
2.68.0

errMsg 参数说明

errNo

errMsg

说明

最低支持版本

20000

"changeStreamSubscribeState:fail"  + 详细错误信息

参数错误

2.68.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

<view class="title">rtc 组件</view> <view class="rtc-container"> <view>{{ error }}</view> <rtc-room tt:for="{{userIdList}}" tt:key="item.userId" id="{{ item.userId }}" class="rtc-item {{ item.class }}" userId="{{ item.userId }}" device-position="front" bindtap="scaleCamera" binderror="handleError" mode="{{ item.mode }}"> </rtc-room> </view> <view class="title">房间信息</view> <view class="rtc-api-name">appId</view> <view class="room-message">{{ appId }}</view> <view class="rtc-api-name">token</view> <view class="room-message token">{{ token }}</view> <view class="rtc-api-name">roomId</view> <view class="room-message">{{ roomId }}</view> <view class="rtc-api-name">useId</view> <view class="room-message">{{ userId }}</view> <view class="title">rtc Api</view> <view class="rtc-api-name">api名称: changeStreamSubscribeState</view> <button class="rtc-api" type="default" size="default" bindtap="changeStreamSubscribeState">切换开启/关闭订阅流</button>
import { RTC_APP_ID } from "../../utils/constant"; Page({ data: { ctx: null, userIdList: [], videoState: 0, audioState: 0, streamPublishState: 0, streamSubscribeState: 0, screenSubscribeState: 0, visible: false, device: "speakerphone", appId: RTC_APP_ID, // 每个应用的唯一标识符,由 RTC 控制台随机生成的。不同的 AppId 生成的实例在 RTC 中进行音视频通话完全独立,无法互通。 token: "", roomId: "", userId: "", camera: "front", scaleUserId: "", error: "no error", }, onLoad(options) { const { userId, roomId, token } = options; this.setData({ userId, roomId, token: decodeURIComponent(token), }); this.data.ctx = tt.createRtcRoomContext({ appId: this.data.appId, }); }, changeStreamSubscribeState() { const streamSubscribeState = this.data.streamSubscribeState ? 0 : 1; this.setData({ streamSubscribeState }); this.data.ctx.changeStreamSubscribeState({ state: streamSubscribeState, userId: this.data.userId === "user1" ? "user2" : "user1", streamType: "both", success(res) { console.log("changeStreamSubscribeState success ", res); }, fail(res) { console.log("changeStreamSubscribeState fail ", res); }, complete(res) { console.log("changeStreamSubscribeState complete ", res); }, }); }, });