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

    Web

    编辑文档 更新于
    概览BRTCClientStreamLocalStreamRemoteStreamEventsBRTCErrorOption

    远端音视频流,通过监听 client.on('stream-added') 事件获得。
    远端流的生命周期在事件 client.on('stream-added') 到事件 client.on('stream-removed') 之间,在这两个事件之间,远端流可能会通过 client.on('stream-updated') 进行更新,比如远端用户通过增加或删除 track 后本地就会收到此通知。

    Index

    Properties

    Accessors

    Methods

    init destroy replay
    fire getAudioDeviceId getAudioLevel
    getAudioTrack getAudioVolume getStreamId
    getUserId getAudioOn setScreenProfile
    setAudioOutput getType setAudioVolume
    getVideoFrame getVideoOn getVideoTrack
    hasAudio hasVideo isPlaying
    muteAudio muteVideo resume
    stop unmuteAudio unmuteVideo
    off on one
    play getStats isSubscribed

    Properties

    streamCodecOption
    远端流配置项 

    remoteStream.streamCodecOption: streamCodecOption

    详情

    Accessors

    audioTrack
    远端音频轨道 

    remoteStream.audioTrack(): MediaStreamTrack

    返回

    • MediaStreamTrack

    videoTrack
    远端视频轨道 

    remoteStream.videoTrack(): MediaStreamTrackMediaStreamTrack

    返回

    • MediaStreamTrack

    Methods

    init
    初始化实例 

    remoteStream.init(): Promise<any>

    返回

    • Promise

    destroy
    销毁音视频流 

    remoteStream.destroy():void

    返回

    • void

    replay
    重新播放流 

    remoteStream.replay(): Promise<void>

    返回

    • Promise

    fire
    提交事件 

    remoteStream.fire(类型: string, data: any):void

    参数

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

    返回

    • void

    getAudioDeviceId
    获取当前播放的扬声器设备 id 

    remoteStream.getAudioDeviceId():string

    返回

    • string

    getAudioLevel
    获取当前音量大小 

    remoteStream.getAudioLevel():number

    返回

    • number

    详情

    • 只有当本地流或远端流中有音频数据才有效
    • 返回值在(0.0, 1.0)之间,通常认为值大于0.1为用户正在说话

    getAudioTrack
    获取音频轨道 

    remoteStream.getAudioTrack():MediaStreamTrack

    返回

    • MediaStreamTrack

    getAudioVolume
    获取当前播放音量 

    remoteStream.getAudioVolume():number

    返回

    • number

    getStreamId
    获取 stream id 

    remoteStream.getStreamId():string

    返回

    • string

    getUserId
    获取 userId 

    remoteStream.getUserId(): string

    返回

    • string

    getAudioOn
    获取流音频是否挂起 

    remoteStream.getAudioOn(): boolean

    返回

    • boolean

    setScreenProfile
    设置屏幕分享 profile 

    remoteStream.setScreenProfile(profile: ScreenProfile): void

    参数

    名称 描述
    profile 屏幕分享设置

    返回

    • void

    详情

    • 该方法需要在调用 init() 之前调用

    setAudioOutput
    设置输出扬声器设备 

    remoteStream.setAudioOutput(deviceId: string): Promise<any>

    参数

    名称 类型 描述
    deviceId string 扬声器标识

    返回

    • Promise

    getType
    获取流类型 

    remoteStream.getType(): string

    返回

    • string
    • main 主流
    • assist 辅流
    • 对应移动端推的主辅流，web 端没有辅流的概念

    setAudioVolume
    设置播放音量 

    remoteStream.setAudioVolume(volume:number): void

    参数

    名称 类型 描述
    volume number 播放音量 [0, 1]

    返回

    • void

    getVideoFrame
    截取当前流的一帧视频数据（base64 png) 

    remoteStream.getVideoFrame(): string

    返回

    • string

    详情

    • 该方法需要在 play 后调用,并且 Stream 中有视频流才有效

    getVideoOn
    获取流视频是否挂起 

    remoteStream.getVideoOn(): boolean

    返回

    • boolean

    getVideoTrack
    获取视频轨道 

    remoteStream.getVideoTrack(): MediaStreamTrack

    返回

    • MediaStreamTrack

    hasAudio
    是否有音频 

    remoteStream.hasAudio(): boolean

    返回

    • boolean

    hasVideo
    是否有视频 

    remoteStream.hasVideo(): boolean

    返回

    • boolean

    isPlaying
    流是否正在播放 

    remoteStream.isPlaying():boolean

    返回

    • boolean

    muteAudio
    禁用音频轨道 

    remoteStream.muteAudio():boolean

    返回

    • boolean

    详情

    • 对于本地流,调用该方法会停止发送音频,远端会触发 client.on(‘mute-audio’) 事件
    • 对于远端流,调用该方法会停止播放音频,但是仍然接收音频数据。

    muteVideo
    禁用视频轨道 

    remoteStream.muteVideo():boolean

    返回

    • boolean

    详情

    • 对于本地流,调用该方法会停止发送视频,远端会触发 client.on(‘mute-video’) 事件
    • 如果视频是从摄像头采集,此时摄像头灯仍然是亮着的
    • 对于远端流,调用该方法会停止播放视频,但是仍然接收视频数据

    resume
    恢复播放音视频 

    remoteStream.resume(): void

    返回

    • void

    详情

    • 在某些版本浏览器上移动传入 play 的 div 容器可能会导致音视频播放器进入 ‘PAUSED’ 状态,此时 需要调用该接口恢复播放
    • 由于浏览器自动播放策略的限制,在 play 返回 PLAY_NOT_ALLOWED 错误后需要引导用户通过手势 调用该接口恢复播放

    stop
    停止播放流 

    stop(): void

    返回

    • void

    unmuteAudio
    启用音频轨道 

    remoteStream.unmuteAudio(): boolean

    返回

    • boolean

    详情

    • 对于本地流,调用该方法会触发远端 client.on(‘unmute-audio’) 事件
    • 音频轨道默认是开启的,若你调用 muteAudio 后可用该方法重新启用音频

    unmuteVideo
    启用视频轨道 

    remoteStream.unmuteVideo(): boolean

    返回

    • boolean

    详情

    • 对于本地流,调用该方法会触发远端 client.on(‘unmute-video’) 事件
    • 视频轨道默认是开启的,若你调用 muteVideo 后可用该方法重新启用视频

    off
    取消事件监听 

    remoteStream.off(类型: string, fn: Function): this

    参数

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

    返回

    详情

    • 只传 类型 取消此事件的所有监听
    • 不传任何参数取消所有事件的监听

    on
    监听Stream事件 

    remoteStream.on(类型: string, fn: Function): this

    参数

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

    返回

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

    remoteStream.one(类型: string, fn: Function): this

    参数

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

    返回

    play
    播放远端流 

    remoteStream.play(videoId: string | HTMLDivElement , options: StreamPlayOption): Promise‹any›

    参数

    名称 类型 描述
    videoId string HTMLDivElement 挂载Dom
    Default value options StreamPlayOption 播放选项

    返回

    • Promise‹any›

    详情 由于浏览器自动播放策略的影响,调用该接口可能会返回 PLAY_NOT_ALLOWED 错误, 此时需要引导用户通过手势操作调用 resume 恢复音视频播放

    getStats
    获取流的传输信息

    remoteStream.getStats(): Promise<RemoteStreamStats>

    返回

    isSubscribed
    远端流是否已经订阅 

    remoteStream.isSubscribed(): boolean

    返回

    • boolean
    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论