Client | NERTC V4.3.0

请使用 WebRTC2.createClient 创建 Client对象，client对象指通话中的本地或远程用户，提供云信sdk的核心功能。

Hierarchy

Client

Methods

addTasks

addTasks(options: { rtmpTasks: RTMPTask[] }): Promise<undefined>

增加互动直播推流任务。见RTMPTask

Parameters
- options: { rtmpTasks: RTMPTask[] }
  - rtmpTasks: RTMPTask[]
Returns Promise<undefined>

deleteTasks

deleteTasks(options: { taskIds: string[] }): Promise<void>

删除互动直播推流任务

Parameters
- options: { taskIds: string[] }
  - taskIds: string[]
Returns Promise<void>

destroy

destroy(): void

销毁实例

Returns void

getChannelInfo

getChannelInfo(): any

获取当前通话信息

Returns any

getConnectionState

getConnectionState(): ConnectionState

主动获取网络连接状态。

推荐用于以下场景：
- 在 App 异常重启时，可以调用本接口主动获取当前客户端与服务器的连接状态，以做到本地与服务器状态的对齐。
- 在实时音视频通话等业务场景中，主动获取房间的网络连接状态，以此完成上层业务逻辑。
SDK 与服务器的连接状态，共有以下 4 种：
- DISCONNECTED：网络连接断开。该状态表示 SDK 处于：
- 调用Client.join加入房间前的初始化阶段。
- 调用Client.leave离开房间之后。
- CONNECTING：建立网络连接中。该状态表示 SDK 处于：
- 调用Client.join之后正在与指定房间建立连接。
- 通话过程中，连接中断自动重连。
- CONNECTED：已连接。该状态表示用户已经成功加入房间，可以在房间内发布或订阅媒体流。
- DISCONNECTING：正在断开连接。
- 在调用 Client.leave 的时候为此状态。
Returns ConnectionState

getLocalAudioStats

getLocalAudioStats(): Promise<any>

获取本地发布流的音频统计数据

Returns Promise<any>

getLocalVideoStats

getLocalVideoStats(mediaType?: "audio" | "video" | "screen"): Promise<any>

获取本地发布流的视频统计数据

Parameters
- Optional mediaType: "audio" | "video" | "screen"
Returns Promise<any>

getRemoteAudioStats

getRemoteAudioStats(): Promise<any>

获取远端订阅流的音频统计数据

Returns Promise<any>

getRemoteVideoStats

getRemoteVideoStats(mediaType?: "audio" | "video" | "screen"): Promise<any>

获取远端订阅流的视频统计数据

Parameters
- Optional mediaType: "audio" | "video" | "screen"
Returns Promise<any>

getSessionStats

getSessionStats(): Promise<any>

获取与会话的连接状况统计数据

Returns Promise<any>

getSystemStats

getSystemStats(): Promise<any>

获取系统电量

Returns Promise<any>

getTransportStats

getTransportStats(): Promise<any>

获取与网关的连接状况统计数据

Returns Promise<any>

join

join(options: JoinOptions): Promise<any>

加入频道

Parameters
- options: JoinOptions
Returns Promise<any>

leave

leave(): Promise<void>

离开频道

Returns Promise<void>

on

on(event: "client-role-changed", callback: (evt: { role: "host" | "audience" }) => void): void
on(event: "stream-added", callback: (evt: { stream: Stream }) => void): void
on(event: "stream-subscribed", callback: (evt: { mediaType: MediaType; stream: Stream }) => void): void
on(event: "stream-removed", callback: (evt: { stream: Stream }) => void): void
on(event: "active-speaker", callback: (evt: { uid: number }) => void): void
on(event: "volume-indicator", callback: (evt: { level: number; uid: number }) => void): void
on(event: "active-speaker", callback: (evt: { uid: number }) => void): void
on(event: "peer-online", callback: (evt: { uid: number }) => void): void
on(event: "peer-leave", callback: (evt: { uid: number }) => void): void
on(event: "mute-audio", callback: (evt: { uid: number }) => void): void
on(event: "unmute-audio", callback: (evt: { uid: number }) => void): void
on(event: "mute-video", callback: (evt: { uid: number }) => void): void
on(event: "unmute-video", callback: (evt: { uid: number }) => void): void
on(event: "mute-screen", callback: (evt: { uid: number }) => void): void
on(event: "unmute-screen", callback: (evt: { uid: number }) => void): void
on(event: "client-banned", callback: (evt: { uid: number }) => void): void
on(event: "channel-closed", callback: () => void): void
on(event: "stopScreenSharing", callback: (evt: {}) => void): void
on(event: "connection-state-change", callback: (evt: { curState: ConnectionState; prevState: ConnectionState }) => void): void
on(event: "error", callback: (errorName: string) => void): void
on(event: "warning", callback: (evt: { code: number; reason: string }) => void): void
on(event: "audioTrackEnded"): void
on(event: "videoTrackEnded"): void
on(event: "rtmp-state", callback: (state: RTMPTaskState) => void): void
on(event: "network-quality", callback: (netStatus: NetStatusItem[]) => void): void
on(event: "exception", callback: (exceptionEvent: ClientExceptionEvt) => void): void

本地用户角色发生了变化

Parameters
- event: "client-role-changed"
- callback: (evt: { role: "host" | "audience" }) => void
  - - (evt: { role: "host" | "audience" }): void
    - Parameters
      - evt: { role: "host" | "audience" }
        
        role: "host" | "audience"
        
        变化后的角色
      Returns void
Returns void
远端用户发布了一个流的通知。

Parameters
- event: "stream-added"
- callback: (evt: { stream: Stream }) => void
  - - (evt: { stream: Stream }): void
    - Parameters
      - evt: { stream: Stream }
        
        stream: Stream
        
        新增的远端流
      Returns void
Returns void
远端用户发布的一路音视频轨道被订阅了。

Parameters
- event: "stream-subscribed"
- callback: (evt: { mediaType: MediaType; stream: Stream }) => void
  - - (evt: { mediaType: MediaType; stream: Stream }): void
    - Parameters
      - evt: { mediaType: MediaType; stream: Stream }
        
        mediaType: MediaType
        
        被订阅的音视频轨道
        
        stream: Stream
        
        被订阅的远端流
      Returns void
Returns void
该事件表示指定远端流被移除了

Parameters
- event: "stream-removed"
- callback: (evt: { stream: Stream }) => void
  - - (evt: { stream: Stream }): void
    - Parameters
      - evt: { stream: Stream }
        
        stream: Stream
        
        远端流
      Returns void
Returns void
该事件会返回当前频道内声音最大的用户的uid。

Parameters
- event: "active-speaker"
- callback: (evt: { uid: number }) => void
  - - (evt: { uid: number }): void
    - Parameters
      - evt: { uid: number }
        
        uid: number
        
        主播uid
      Returns void
Returns void
该事件会返回当前频道内的用户及音量。

Parameters
- event: "volume-indicator"
- callback: (evt: { level: number; uid: number }) => void
  - - (evt: { level: number; uid: number }): void
    - Parameters
      - evt: { level: number; uid: number }
        
        level: number
        
        音量
        
        uid: number
        
        主播uid
      Returns void
Returns void
该事件会返回当前频道内声音最大的用户的uid。

Parameters
- event: "active-speaker"
- callback: (evt: { uid: number }) => void
  - - (evt: { uid: number }): void
    - Parameters
      - evt: { uid: number }
        
        uid: number
        
        主播uid
      Returns void
Returns void
该事件表示有主播加入房间

Parameters
- event: "peer-online"
- callback: (evt: { uid: number }) => void
  - - (evt: { uid: number }): void
    - Parameters
      - evt: { uid: number }
        
        uid: number
        
        主播uid
      Returns void
Returns void
该事件表示有主播离开房间

Parameters
- event: "peer-leave"
- callback: (evt: { uid: number }) => void
  - - (evt: { uid: number }): void
    - Parameters
      - evt: { uid: number }
        
        uid: number
        
        主播uid
      Returns void
Returns void
该事件表示指定主播将麦克风静音

Parameters
- event: "mute-audio"
- callback: (evt: { uid: number }) => void
  - - (evt: { uid: number }): void
    - Parameters
      - evt: { uid: number }
        
        uid: number
        
        主播uid
      Returns void
Returns void
该事件表示指定主播将麦克风取消静音

Parameters
- event: "unmute-audio"
- callback: (evt: { uid: number }) => void
  - - (evt: { uid: number }): void
    - Parameters
      - evt: { uid: number }
        
        uid: number
        
        主播uid
      Returns void
Returns void
该事件表示指定主播将视频静音

Parameters
- event: "mute-video"
- callback: (evt: { uid: number }) => void
  - - (evt: { uid: number }): void
    - Parameters
      - evt: { uid: number }
        
        uid: number
        
        主播uid
      Returns void
Returns void
该事件表示指定主播将视频取消静音

Parameters
- event: "unmute-video"
- callback: (evt: { uid: number }) => void
  - - (evt: { uid: number }): void
    - Parameters
      - evt: { uid: number }
        
        uid: number
        
        主播uid
      Returns void
Returns void
该事件表示指定主播将屏幕共享静音

Parameters
- event: "mute-screen"
- callback: (evt: { uid: number }) => void
  - - (evt: { uid: number }): void
    - Parameters
      - evt: { uid: number }
        
        uid: number
        
        主播uid
      Returns void
Returns void
该事件表示指定主播将屏幕共享取消静音

Parameters
- event: "unmute-screen"
- callback: (evt: { uid: number }) => void
  - - (evt: { uid: number }): void
    - Parameters
      - evt: { uid: number }
        
        uid: number
        
        主播uid
      Returns void
Returns void
该事件表示指定主播被踢出房间

Parameters
- event: "client-banned"
- callback: (evt: { uid: number }) => void
  - - (evt: { uid: number }): void
    - Parameters
      - evt: { uid: number }
        
        uid: number
        
        主播uid
      Returns void
Returns void
该事件表示房间已关闭

Parameters
- event: "channel-closed"
- callback: () => void
  - - (): void
    - Returns void
Returns void
该事件表示本地的屏幕共享停止了

Parameters
- event: "stopScreenSharing"
- callback: (evt: {}) => void
  - - (evt: {}): void
    - Parameters
      - evt: {}
      Returns void
Returns void
与服务器的连接状态发生了变化。

Parameters
- event: "connection-state-change"
- callback: (evt: { curState: ConnectionState; prevState: ConnectionState }) => void
  - - (evt: { curState: ConnectionState; prevState: ConnectionState }): void
    - Parameters
      - evt: { curState: ConnectionState; prevState: ConnectionState }
        
        curState: ConnectionState
        
        变化后的状态
        
        prevState: ConnectionState
        
        变化前的状态
      Returns void
Returns void
客户端遇到错误。可能有：
- SOCKET_ERROR: 连接错误。
- RELOGIN_ERROR: 重连失败。
Parameters
- event: "error"
- callback: (errorName: string) => void
  - - (errorName: string): void
    - Parameters
      - errorName: string
      Returns void
Returns void
客户端遇到警告。可能有：
- 406：ability not support。当前客户端设备视频编解码能力与房间不匹配，例如设备不支持 VP8 等编码类型。在此房间中可能无法成功进行视频编解码，即本端可能无法正常显示某些远端的视频画面，同样远端也可能无法显示本端画面。
Parameters
- event: "warning"
- callback: (evt: { code: number; reason: string }) => void
  - - (evt: { code: number; reason: string }): void
    - Parameters
      - evt: { code: number; reason: string }
        
        code: number
        
        reason: string
      Returns void
Returns void
音频轨道结束。造成的原因可能是设备被拔出。

Parameters
- event: "audioTrackEnded"
Returns void
视频频轨道结束。造成的原因可能是设备被拔出。

Parameters
- event: "videoTrackEnded"
Returns void
该事件表示推流状态发生了变化

Parameters
- event: "rtmp-state"
- callback: (state: RTMPTaskState) => void
  - - (state: RTMPTaskState): void
    - Parameters
      - state: RTMPTaskState
      Returns void
Returns void
该事件展示了对端的网络状态

Parameters
- event: "network-quality"
- callback: (netStatus: NetStatusItem[]) => void
  - - (netStatus: NetStatusItem[]): void
    - Parameters
      - netStatus: NetStatusItem[]
      Returns void
Returns void
该事件展示了目前频道内的异常

Parameters
- event: "exception"
- callback: (exceptionEvent: ClientExceptionEvt) => void
  - - (exceptionEvent: ClientExceptionEvt): void
    - Parameters
      - exceptionEvent: ClientExceptionEvt
      Returns void
Returns void

publish

publish(stream: Stream): Promise<undefined>

发布视频

Parameters
- stream: Stream
Returns Promise<undefined>

setChannelProfile

setChannelProfile(options: { mode: "rtc" | "live" }): void

设置房间模型

Parameters
- options: { mode: "rtc" | "live" }
  - mode: "rtc" | "live"
Returns void

setClientRole

setClientRole(role: "host" | "audience"): Promise<undefined>

设置用户角色。默认情况下用户以主播角色加入房间。

在加入房间前，用户可以调用本接口设置本端模式为观众或主播模式。在加入房间后，用户可以通过本接口切换用户模式。

用户角色支持设置为主播（host）或观众(audience)，主播和观众的权限不同：
- 主播：可以操作摄像头等音视频设备、发布流、配置互动直播推流任务、上下线对房间内其他用户可见。
- 观众：观众只能接收音视频流，不支持操作音视频设备、配置互动直播推流任务、上下线不通知其他用户。
注意：

可以在加入房间之前或者之后设置。

相关回调：

如果您在加入房间后调用该方法切换用户角色，调用成功后，会触发以下回调：
- 主播切换为观众，本地触发client-role-changed回调，远端触发peer-offline回调
- 观众切换为主播，本地触发client-role-changed回调，远端触发peer-online回调
Parameters
- role: "host" | "audience"
  用户角色。可设置为：
  - host：直播模式中的主播，可以发布和接收音视频流。如果用户之前已经发布了音频或视频，切换到主播时会自动恢复发布音频或视频流。
  - audience: 直播模式中的观众，只能接收音视频流。主播模式切换到观众模式后，会自动停止发送音视频流。
Returns Promise<undefined>

setLocalMediaPriority

setLocalMediaPriority(options: MediaPriorityOptions): void

设置本地用户的媒体流优先级。

如果某个用户的优先级为高，那么该用户媒体流的优先级就会高于其他用户，弱网环境下 SDK 会优先保证其他用户收到的、高优先级用户的媒体流的质量。
note
- 请在加入房间（join）前调用此方法。
- 一个音视频房间中只有一个高优先级的用户。建议房间中只有一位用户调用 setLocalMediaPriority 将本端媒体流设为高优先级，否则需要开启抢占模式，保证本地用户的高优先级设置生效。
Parameters
- options: MediaPriorityOptions
  
  优先级设置。
Returns void

setRemoteVideoStreamType

setRemoteVideoStreamType(stream: Stream, highOrLow: number): Promise<void>

中途更新订阅的视频分辨率。

Parameters
- stream: Stream
- highOrLow: number
Returns Promise<void>

subscribe(stream: Stream): Promise<void>

订阅远端音视频流

Parameters
- stream: Stream
Returns Promise<void>

unpublish

unpublish(stream: Stream, type?: null): Promise<undefined>

取消发布本地音视频流

Parameters
- stream: Stream
- Optional type: null
Returns Promise<undefined>

unsubscribe

unsubscribe(stream: Stream): Promise<void>

取消订阅远端音视频流

Parameters
- stream: Stream
Returns Promise<void>

updateTasks

updateTasks(options: { rtmpTasks: RTMPTask[] }): Promise<void>

更新互动直播推流任务

Parameters
- options: { rtmpTasks: RTMPTask[] }
  - rtmpTasks: RTMPTask[]
Returns Promise<void>

Hierarchy

Index

Methods

Methods

addTasks

Parameters

options: { rtmpTasks: RTMPTask[] }

rtmpTasks: RTMPTask[]

Returns Promise<undefined>

deleteTasks

Parameters

options: { taskIds: string[] }

taskIds: string[]

Returns Promise<void>

destroy

Returns void

getChannelInfo

Returns any

getConnectionState

主动获取网络连接状态。

Returns ConnectionState

getLocalAudioStats

Returns Promise<any>

getLocalVideoStats

Parameters

Optional mediaType: "audio" | "video" | "screen"

Returns Promise<any>

getRemoteAudioStats

Returns Promise<any>

getRemoteVideoStats

Parameters

Optional mediaType: "audio" | "video" | "screen"

Returns Promise<any>

getSessionStats

Returns Promise<any>

getSystemStats

Returns Promise<any>

getTransportStats

Returns Promise<any>

join

Parameters

options: JoinOptions

Returns Promise<any>

leave

Returns Promise<void>

on

Parameters

event: "client-role-changed"

callback: (evt: { role: "host" | "audience" }) => void

Parameters

evt: { role: "host" | "audience" }

role: "host" | "audience"

Returns void

Returns void

Parameters

event: "stream-added"

callback: (evt: { stream: Stream }) => void

Parameters

evt: { stream: Stream }

stream: Stream

Returns void

Returns void

Parameters

event: "stream-subscribed"

callback: (evt: { mediaType: MediaType; stream: Stream }) => void

Parameters

evt: { mediaType: MediaType; stream: Stream }

mediaType: MediaType

stream: Stream

Returns void

Returns void

Parameters

event: "stream-removed"

callback: (evt: { stream: Stream }) => void

Parameters

evt: { stream: Stream }

stream: Stream

Returns void

Returns void

Parameters