• 实时音视频
    • 实时音视频>客户端 API>Web

    Web

    编辑文档 更新于
    概览BRTCClientStreamLocalStreamRemoteStreamEventsBRTCErrorOption

    Client 接口提供音视频通话的核心功能,例如加入频道、发布和订阅音视频流等。

    • 你可以通过 creatClient 创建 Client 对象
    • 一个 Client 对象代表一个本地客户端

    Client对象

    let client = BRTC.createClient({'appId','h264','rtc'})

    视频编码方法 h264 或者 vp8

    会话模式,目前只支持 rtc

    Hierarchy

    Index

    Index

    join destroy fire
    leave off on
    one publish setPublishOnly
    unpublish subscribe unsubscribe
    enableSmallStream disableSmallStream setRemoteVideoStreamType
    setSmallStreamProfile    

    Methods

    join
    加入房间 

    client.join(roomId: string, userId: number, sig: string): Promise‹any›

    参数

    名称 类型 描述
    roomId string 房间id
    userId number 用户id
    sig string 签名 参考SDK 动态授权

    返回

    • Promise‹any›

    详情

    • 加入一个音视频通话房间进房代表开始一个音视频通话会话,这时候 SDK 会监听远端用户进房退房情况,若有远端用户进房并且发布流,本地会收到 ‘stream-added’ 事件
    • 进入房间后用户可以通过 publish 发布本地流
    • 该方法让用户加入通话的房间,加入房间内的每一个用户的uid必须是唯一的
    • 同一个房间内用户 ID 相同时,后进入的用户会将前一个用户踢出房间

    destroy
    销毁 client 实例 

    client.destroy(): Promise‹any›

    返回

    • Promise‹any›

    fire
    提交事件 

    client.fire(type: string ,data: any ): void

    参数

    名称 类型 描述
    type string 事件类型
    data string 事件数据

    返回

    • void

    leave
    退出房间 

    client.leave(): Promise‹any›

    返回

    • Promise‹any›

    详情

    • 退房前请确保已经通过 unpublish 取消发布本地流,若未取消发布本地流,SDK 内部会自动取消发布本地流

    off
    取消事件监听 

    client.off(type: string , fn: Function ): this

    参数

    名称 类型 描述
    type string 事件类型
    fn Function 事件回调

    返回

    详情

    • 取消事件监听,用于移除通过 on 绑定的事件
    • 只传 type 取消此事件的所有监听
    • 不传任何参数取消所有事件的监听

    on
    监听客户端对象事件 

    client.on(type: string , fn: Function ): this

    参数

    名称 类型 描述
    type string 事件类型
    fn Function 事件回调

    返回

    详情

    one
    监听一次事件 

    client.one(type: string , fn: Function ): this

    参数

    名称 类型 描述
    type string 事件类型
    fn Function 事件回调

    返回

    详情

    • 监听一次事件,执行一次之后自动取消监听

    publish
    发布本地音视频流 

    client.publish(stream: LocalStream): Promise‹any›

    参数

    名称 类型 描述
    stream LocalStream 创建的本地流对象

    返回

    • Promise‹any›

    详情

    • 该方法需要在 join 进房后调用,一次音视频会话中只能发布一个本地流。若想发布另外一个本地流,可先通过 unpublish取消发布当前本地流后再发布新的本地流
    • 在发布本地流后,可通过 removeTrack、addTrack、replaceTrack 来更新本地流中的某个音频或视频流
    • 发布本地流后远端会收到 ‘stream-added’ 事件通知

    setPublishOnly
    本地只发布一路音视频流 

    client.setPublishOnly(value: boolean ): void

    参数

    名称 类型 描述
    value boolean 是否只推流

    返回

    • void

    详情

    • 设置 client 只用于推流,一般用于推多路流的时候
    • 设置主 client 为 false,辅 client 为 true,这样辅 client 只用于推流,只会触发 ’stream-published‘ 事件,所有的流由主 client 来订阅

    unpublish
    取消发布本地流 

    client.unpublish(stream: LocalStream): Promise‹any›

    参数

    名称 类型 描述
    stream LocalStream 本地流对象

    返回

    • Promise‹any›

    详情

    • 取消发布本地流后远端会收到 ‘stream-removed’ 事件通知
    • 请在 leave 退房前取消已经发布的本地流

    subscribe
    订阅远端流 

    client.subscribe(stream: RemoteStream , options: SubscribeOptions : Promise‹any›

    参数

    名称 类型 默认值 描述
    stream RemoteStream - 需要订阅的远端流对象,由 ‘stream-added’ 事件获得
    options SubscribeOptions {audio: true, video: true} 订阅选项

    返回

    • Promise‹any›

    详情

    • 订阅远端流,可通过该订阅接口指明需要订阅音频、视频或者音视频流
    • 开发者可通过该订阅接口指明需要订阅音频、视频或者音视频流
    • 若不想接收该远端流所包含的任何音视频数据,请通过 unsubscribe 取消订阅

    unsubscribe
    取消订阅远端流 

    client.unsubscribe(stream: RemoteStream): Promise‹any›

    参数

    名称 类型 描述
    stream RemoteStream 取消订阅的远端流

    返回

    • Promise‹any›

    详情

    • RemoteStream 需要取消订阅的远端流对象,由 ‘stream-added’ 事件获得

    enableSmallStream
    开启小流 

    client.enableSmallStream(): Promise‹any›

    参数

    无

    返回

    • Promise‹any›

    详情

    • 开启大小流
    • 在发送视频端开启大小流传输模式。双流为视频大流和视频小流，其中视频大流指高分辨率、高码率的视频流，视频小流指低分辨率、低码率的视频流
    • 必须在发布之前进行设置，原因是为了避免在发布后进行设置导致大小流表现不一致
    • 开启大小流传输模式后建议不要对双流进行 track 操作（包括 addTrack / removeTrack / replaceTrack），否则会导致大流和小流的表现不一致
    • 需要大流视频宽度大于 398，高度大于 308 才能生效

    disableSmallStream
    开启小流 

    client.disableSmallStream(): Promise‹any›

    参数

    无

    返回

    • Promise‹any›

    详情

    • 关闭大小流
    • 必须在发布前或者结束发布之后进行操作，原因是为了避免在发布后进行设置导致大小流表现不一致

    setSmallStreamProfile
    设置小流推流编码参数 

    client.setSmallStreamProfile(profile: SmallStreamCodecOption): Promise‹any›

    参数

    名称 类型 描述
    profile SmallStreamCodecOption 小流编码参数

    返回

    • Promise‹any›

    详情

    • 设置小流推流参数
    • 高宽比需要与大流的高宽比保持一致

    setRemoteVideoStreamType
    设置拉取小流还是大流 

    client.setRemoteVideoStreamType(stream: RemoteStream, streamType: StreamSimulcastType): Promise‹any›

    参数

    名称 类型 描述
    stream RemoteStream 设置拉取的远端流
    streamType "small" | "big" 订阅的流类型

    返回

    • Promise‹any›

    详情

    • 接收端选择订阅大流还是小流
    • 只能在订阅之后设置
    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论