实时音视频 RTC实时音视频 RTC

更新时间:2021/06/28 GMT+08:00
分享

客户端对象(Client)

本章节介绍了Web SDK的Client接口详情。

表1 Client接口

接口

描述

join

加入房间。调用该接口让用户加入指定房间,进行音频/视频通话。

leave

离开房间。用户结束通话后须调用该接口离开房间。

publish

加入房间后,发布本地流。

unpublish

取消发布本地流。

subscribe

订阅远端音视频媒体流。

unsubscribe

取消订阅远端音视频媒体。

switchRole

切换用户角色。

on

注册客户端对象事件回调接口。

off

取消注册客户端对象事件回调接口。

getConnectionState

获取客户端连接状态。

getTransportStats

获取当前网络传输状况统计数据。

getLocalAudioStats

获取本地音频统计数据。

getLocalVideoStats

获取本地视频统计数据。

getRemoteAudioStats

获取远端音频统计数据。

getRemoteVideoStats

获取远端视频统计数据。

enableTopThreeAudioMode

开启音频最大三方模式。该接口为1.2.0版本新增。

setVolume4TopThree

设置音频最大三方模式的音量值。该接口为1.4.0版本新增。

muteAudio4TopThree

开启/禁用音频最大三方模式的所有音轨。该接口为1.4.0版本新增。

enableStreamStateDetection

开启/关闭视频码流状态探测功能。该接口为1.4.0版本新增。

join

async join(roomId: string, options: JoinConfig): Promise<void>

功能说明

加入房间。该接口让用户加入一个房间,进行音频/视频通话。

请求参数

  • roomId:必选,string[64]类型,房间ID,房间唯一标识符。
  • options:必选,JoinConfig类型,加入房间配置。
    JoinConfig定义为:{
    • userId:必选,string[64]类型,用户标识,userId 需要保证应用内唯一。
    • userName:可选,string[64]类型,用户昵称。
    • signature:必选,string[512]类型,鉴权签名字串,具体生成方法请参见接入鉴权
    • ctime:必选,鉴权签名时间戳。string类型,UTC时间戳,单位秒。
    • role:必选,number类型,用户角色,可以标识媒体方向。role的枚举值包括:
      • 0: 表示joiner,能够发送音视频和接受音视频。
      • 1: 表示publisher, 只发送自己的音视频媒体,不接收别人的音视频。
      • 2: 表示player,只接受别人的音视频,不发送自己的音视频媒体。

        }

返回参数

Promise<void>:返回一个Promise对象。

注意事项

  • roomId支持的字符包括:a-z、A-Z、0-9
  • userId支持的字符包括:a-z、A-Z、0-9、连接符 '-'、下划线 '_'

leave

async leave(): Promise<void>

功能说明

离开房间,用户结束通话后须调用该接口离开房间。

请求参数

返回参数

Promise<void>:返回一个Promise对象。

publish

publish(stream: Stream): Promise<void>

功能说明

加入房间后,可以调用该接口发布本地流。只有角色为“joiner”“publisher”才能发布本地流。

请求参数

stream:必选,Stream类型。

返回参数

Promise<void>:返回一个Promise对象。

unpublish

unpublish(stream: Stream): Promise<void>

功能说明

取消发布本地流。

请求参数

stream:必选,Stream类型。

返回参数

Promise<void>:返回一个Promise对象。

subscribe

async subscribe(stream: RemoteStream, option?:SubscribeOption): Promise<void>

功能说明

订阅远端音视频媒体流。订阅远端媒体流成功后,会收到 Client.on('stream-subscribed') 事件通知。然后可以对流进行播放。

请求参数
  • stream:必选,RemoteStream类型。
  • option:可选,SubscribeOption类型,表示订阅视频或音频的选项,如果不传则订阅音频和分辨率最高的视频。

SubscribeOption类型定义如下:

{

  • video:可选,boolean类型,表示是否订阅视频,默认为false。
  • audio: 可选,boolean类型,表示是否订阅音频,默认为false。
  • resolutionIds: 可选。string[]类型,video为true的时候有效。表示要订阅的分辨率id的视频。resolutionId可通过接口getStreamInfo接口获取。如果不传resolutionIds,则默认订阅分辨率最高的一个视频。该参数1.8.0版本新增。

}

返回参数

Promise<void>:返回一个Promise对象。

注意事项

subscribeOption中“video”“audio”不能同时为“false”

unsubscribe

async unsubscribe(stream: Stream,option?:UnsubscriptionOption): Promise<void>

功能说明

取消订阅远端音视频媒体流。

请求参数

  • stream:必选,RemoteStream类型,远端流对象,通过stream-added事件获得。
  • option:可选。表示取消订阅的选项,如果不传,则取消订阅音频和所有分辨率的视频,为UnsubscriptionOption类型。

    UnsubscriptionOption定义如下:

    {

    • video:可选,boolean类型,表示是否取消订阅视频,默认为false。
    • audio:可选,boolean类型,表示是否取消订阅音频,可选,默认为false。
    • resolutionIds:可选,string[]类型,在video为true的时候有效,表示取消订阅的分辨率Id的视频。resolutionId通过接口getStreamInfo获取。如果resolutionIds不传,则取订阅看所有分辨率的视频。

    }

返回参数

Promise<void>:返回一个Promise对象。

switchRole

async switchRole(role: UserRoleType): Promise<void>

功能说明

切换用户角色,本方法用于加入房间成功之后修改角色。

请求参数

role:必选,UserRoleType类型。

UserRoleType表示整数枚举类型,支持的枚举值如下:
  • 0:表示joiner,能够发送音视频和接受音视频。
  • 1:表示publisher,只发送自己的音视频媒体,不接收别人的音视频。
  • 2:表示player,只接受别人的音视频,不发送自己的音视频媒体。

返回参数

Promise<void>:返回一个Promise对象。

on

on(event: string, handler: function): void

功能说明

注册客户端对象事件回调接口。

请求参数
  • event:必选,string类型,事件名称。详细事件列表请参见ClientEvent
  • handler:必选,function类型,事件处理方法。

返回参数

off

off(event: string, handler: function): void

功能说明

取消事件绑定。

请求参数
  • event:必选,string类型,事件名称。详细事件列表请参见ClientEvent
  • handler:必选,function类型,事件处理方法。

返回参数

getConnectionState

getConnectionState(): ConnectionState

功能说明

获取客户端连接状态。

请求参数

返回参数

ConnectionState:webSocket的连接状态,string类型,取值如下:
  • CONNECTING:连接建立中。
  • CONNECTED:连接已建立。
  • RECONNECTING:重新连接中。
  • DISCONNECTED:连接已断开。

getTransportStats

getTransportStats(): Promise<TransportStats>

功能说明

获取当前网络传输状况统计数据,该方法需要publish后调用。双流场景,默认获取主流最高分辨率视频的统计值。

请求参数

返回参数

TransportStats当前支持的属性包括:rtt表示往返时延。

getLocalAudioStats

getLocalAudioStats(): Promise<Map<string, LocalAudioStats>>

功能说明

获取本地音频统计数据。

请求参数

返回参数

  • string:表示userId。
  • LocalAudioStats:表示本地音频统计指标,包含如下属性:
    • bytesSent:必选,number类型。表示已发送字节数。
    • packetsSent:必选,number类型。表示已发送包数。

getLocalVideoStats

getLocalVideoStats(resolutionId?:string): Promise<Map<string, AllLocalVideoStats>>

功能说明

获取本地视频统计数据。

请求参数

resolutionId:可选,string类型。指定分辨率id的视频,如果不指定,默认选择分辨率最高的视频。该参数1.8.0版本新增。

返回参数

  • string:userId。
  • AllLocalVideoStats:本地视频统计指标。包含如下属性:
    • mainStream:必选,类型为LocalVideoStats,本地主流的统计数据。
    • subStream:必选,类型为LocalVideoStats,本地辅流的统计数据。
    LocalVideoStats包含如下属性:
    • bytesSent:必选,number类型,已发送字节数。
    • packetsSent:必选,number类型,已发送包数。
    • framesEncoded:必选,number类型,已编码帧数。
    • framesSent:必选,number类型,已发送帧数。
    • frameWidth:必选,number类型,视频宽度。
    • frameHeight:必选,number类型,视频高度。

【注意事项】

该接口仅在本地流发布且被远端订阅后才可调用。

getRemoteAudioStats

getRemoteAudioStats(): Promise<Map<string, RemoteAudioStats>>

功能说明

获取远端音频统计数据。

请求参数

返回参数

  • string:userId。
  • RemoteAudioStats:远端音频统计指标。包含如下属性:
    • bytesReceived:必选,number类型,已接收字节数。
    • packetsReceived:必选,number类型,已接收包数。
    • packetsLost:必选,number类型,丢包数。

getRemoteVideoStats

getRemoteVideoStats(resolutionId?:string): Promise<Map<string, AllRemoteVideoStats>>

功能说明

获取远端视频统计数据。

请求参数

resolutionId:可选,string类型。指定分辨率id的视频,如果不指定,默认选择分辨率最高的视频。该参数1.8.0版本新增。

返回参数

  • string:userId。
  • AllRemoteVideoStats:本地视频统计指标。包含如下属性:
    • mainStream:必选,类型为RemoteVideoStats,远端主流的统计数据。
    • subStream:必选,类型为RemoteVideoStats,远端辅流的统计数据。

    RemoteVideoStats包含如下属性:

    • bytesReceived:必选,number类型,已接收字节数。
    • packetsReceived:必选,number类型,已接收包数。
    • packetsLost:必选,number类型,丢包数。
    • framesDecoded:必选,number类型,已解码帧数。
    • frameWidth:必选,number类型,视频宽度。
    • frameHeight:必选,number类型,视频高度。

enableTopThreeAudioMode

enableTopThreeAudioMode(enable: boolean): boolean

功能说明

设置是否开启音频最大三方模式。

请求参数

enable:必选,boolean类型,true表示开启音频最大三方,false表示不开启。

返回参数

boolean类型,true表示开启成功,false表示开启失败。

注意事项

该接口需在加入房间前设置,1.2.0版本新增。

setVolume4TopThree

setVolume4TopThree(volume: number): void

功能说明

设置音频最大三方模式的音量值。

请求参数

volume:必选,number类型,取值为[0,100],音频最大三方模式的音量值。

返回参数

注意事项

该接口需要在enableTopThreeAudioMode后设置,1.4.0版本新增。

muteAudio4TopThree

muteAudio4TopThree(enable: boolean): void

功能说明

开启/禁用音频最大三方模式的音轨。

请求参数

enable:必选,boolean类型,true表示禁用音频最大三方模式的音轨,false表示开启音频最大三方模式的音轨。

返回参数

注意事项

该接口需要在enableTopThreeAudioMode后设置,1.4.0版本新增。

enableStreamStateDetection

async enableStreamStateDetection(enable: boolean, interval: number): Promise<void>

功能说明

开启/关闭视频码流状态探测功能,开启后可探测房间内任意其他已订阅用户是否处于视频无码流的状态,若有用户处于视频无码流状态,可收到stream-interrupted事件,若有用户视频码流恢复,可收到stream-recovered事件。

请求参数

  • enable:必选,boolean类型,true表示开启视频码流状态探测,false表示关闭视频码流状态探测。
  • interval:必选,number类型,单位:秒 (s) ,取值为[1,60]。视频无码流状态的判断时间。推荐设置为3s。

返回参数

Promise<void>:返回一个Promise对象。

注意事项

该接口需在加入房间后设置,1.4.0版本新增。

分享:

    相关文档

    相关产品