API Reference for web - Interface: RTCRemoteUser

更新时间: 2023-10-23 16:45:52

# Interface: RTCRemoteUser

interface/ClientInterface.RTCRemoteUser

频道内的远端用户信息,可以通过 Client.remoteUsers 或者 Client.on("user-joined") 等事件获取。. 该对象描述了频道内远端用户的当前状态,包括远端用户 ID、远端是否发布了音频或视频等。 如果检测到远端用户已经发布,可以将这个对象传入 Client.subscribe 中发起订阅,订阅成功后可以通过本对象的 audioTrack 或者 videoTrack 字段获取远端音视频轨道对象用于播放。

# Properties

# audioTrack

Optional audioTrack: RemoteAudioTrack

如果成功订阅了远端用户的音频,这里会保存远端的音频轨道对象。


# hasAudio

hasAudio: boolean

远端当前是否在发送音频。

  • true: 远端用户在发送音频。
  • false: 远端用户没有在发送音频。

# hasVideo

hasVideo: boolean

远端当前是否在发送视频。

  • true: 远端用户在发送视频。
  • false: 远端用户没有在发送视频。

# uid

uid: string

远端用户的用户 ID。


# videoTrack

Optional videoTrack: RemoteVideoTrack

如果成功订阅了远端用户的视频,这里会保存远端的视频轨道对象。