RtcRoomContext.changeUserVisibility收藏我的收藏
收藏
我的收藏基础库 2.68.0 开始支持本方法,这是一个异步方法。
设置用户是否对房间内其他用户可见
前提条件 | 无 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 | 无 |
支持沙盒 | 否 |
相关教程 | 无 |
语法
RtcRoomContext.changeUserVisibility(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
visible | boolean | 是 | 设置用户是否对房间内其他用户可见。 true: 可以在房间内发布音视频流,房间中的其他用户将收到用户的行为通知,例如进房、开启视频采集和退房。 false: 不可以在房间内发布音视频流,房间中的其他用户不会收到用户的行为通知,例如进房、开启视频采集和退房 | 2.68.0 | |
success | function | 否 | 接口调用成功的回调函数 | 2.68.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 2.68.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 2.68.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "changeUserVisibility:ok" | 2.68.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "changeUserVisibility:fail" + 详细错误信息 | 2.68.0 |
errMsg 参数说明
errNo | errMsg | 说明 | 最低支持版本 |
20000 | "changeUserVisibility :fail" + 详细错误信息 | 参数错误 | 2.68.0 |
错误码
errorCode | errMsg | errorType | 说明 | 最低支持版本 |
---|---|---|---|---|
115910 | changeUserVisibility:fail engine has been destroyed,please invoke tt.createRtcRoomContext create new engine | D | rtc实例已销毁 重新调用tt.createRtcRoomContext | 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名称: changeUserVisibility</view> <button class="rtc-api" type="default" size="default" bindtap="changeUserVisibility">切换用户是否对房间内其他用户可见</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, }); }, changeUserVisibility() { const visible = this.data.visible ? false : true; this.setData({ visible }); this.data.ctx.changeUserVisibility({ visible, success(res) { console.log("changeUserVisibility success ", res); }, fail(res) { console.log("changeUserVisibility fail ", res); }, complete(res) { console.log("changeUserVisibility complete ", res); }, }); }, });
点击纠错