Documentation

Classes

Classes

Client
Stream
WebRTC2

Events

active-speaker

该事件会返回当前频道内声音最大的用户的uid。

Type: object
Properties:
Name Type Description
uid number

主播uid

client-banned

该事件表示指定主播被踢出房间

Type: object
Properties:
Name Type Description
uid number

主播uid

client-banned

该事件表示指定主播被踢出房间

Type: object
Properties:
Name Type Description
uid number

主播uid

client-role-changed

本地用户角色发生了变化

Type: object
Properties:
Name Type Description
role 'host' | 'audience'

变化后的角色

mute-audio

该事件表示指定主播将麦克风静音

Type: object
Properties:
Name Type Description
uid number

主播uid

mute-video

该事件表示指定主播将视频静音

Type: object
Properties:
Name Type Description
uid number

主播uid

peer-leave

该事件表示有主播离开房间

Type: object
Properties:
Name Type Description
uid number

主播uid

peer-online

该事件表示有主播加入房间

Type: object
Properties:
Name Type Description
uid number

主播uid

stopScreenSharing

该事件表示本地的屏幕共享停止了

Type: object

stream-added

远端用户发布了一个流的通知。
收到远端流之后，可通过 Client#subscribe 订阅远端流。

Type: object
Properties:
Name Type Description
stream Stream

新增的远端流

stream-removed

该事件表示指定远端流被移除了

Type: object
Properties:
Name Type Description
stream Stream

远端流

stream-subscribed

订阅远端流成功的通知。
订阅远端流成功后，可通过 Stream#setRemoteRenderMode 设置远端渲染宽高等属性，通过 Stream#play 播放远端流。

Type: object
Properties:
Name Type Description
stream Stream

新订阅远端流

unmute-audio

该事件表示指定主播将麦克风取消静音

Type: object
Properties:
Name Type Description
uid number

主播uid

unmute-video

该事件表示指定主播将视频取消静音

Type: object
Properties:
Name Type Description
uid number

主播uid