RtcRoomContext.kickOutUser

基础库 3.250.12 开始支持，低版本需做兼容处理。

解释：指定踢出房间内某个成员。当有成员被踢出时，会通过 rtc-room 组件的 bindstatechange 事件监听返回信息。

方法参数

Object object

object 参数说明

属性名类型必填默认值说明
userIdNumber是要踢出房间的成员 id
successFunction否接口调用成功的回调函数
failFunction否接口调用失败的回调函数
completeFunction否接口调用结束的回调函数（调用成功、失败都会执行）

代码示例

  • SWAN
  • JS
  1. <view class="wrap" bindstatechange="handleStateChange">
  2.     <rtc-room id="myRoom">
  3.         <rtc-room-item
  4.             type="local"
  5.             userId="{{localUserId}}"
  6.             class="local-view">
  7.         </rtc-room-item>
  8.         <rtc-room-item
  9.             type="remote"
  10.             userId="{{remoteUserId}}"
  11.             class="remote-view">
  12.         </rtc-room-item>
  13.     </rtc-room>
  14.     <button bindtap="kickOutUser">取消订阅远端音视频流</button>
  15. </view>
  1. Page({
  2.     onReady(e) {
  3.         // 使用此API需要小程序主体开通实时音视频通话鉴权
  4.         this.rtcRoomContext = swan.createRtcRoomContext('myRoom');
  5.         console.log('这是一个 RtcRoomContext 实例:', this.rtcRoomContext);
  6.         this.enterRoom();
  7.     },
  8.     enterRoom() {
  9.         this.rtcRoomContext.enterRoom({
  10.             roomName: 'roomName',
  11.             userId: 1234567,
  12.             displayName: 'displayName',
  13.             sdkAppId: 'xxxxxx',
  14.             token: 'xxxxxx',
  15.             success: res => {
  16.                 console.log('enterRoom success: ', res);
  17.             },
  18.             fail: err => {
  19.                 console.log('enterRoom fail: ', err);
  20.             }
  21.         });
  22.     },
  23.     kickOutUser() {
  24.         this.rtcRoomContext.kickOutUser({
  25.             // 需要 userId 为 2345678 的成员在房间内
  26.             userId: 2345678, 
  27.             success: res => {
  28.                 console.log('kickOutUser success: ', res);
  29.             },
  30.             fail: err => {
  31.                 console.log('kickOutUser fail: ', err);
  32.             }
  33.         });
  34.     },
  35.     handleStateChange(e) {
  36.         let data = e.detail;
  37.         if(data.msg === 'REMOTE_USER_KICKOUT') {
  38.             console.log('有成员被踢出房间');
  39.         }
  40.     }
  41. });