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

    HarmonyOS

    编辑文档 更新于
    API 概览BRTCBrtcListenerBrtcDeviceManagerBrtcBeautyManagerBrtcAudioEffectManagerBrtcMediaPlayerManager枚举和类常见问题

    BrtcListener 用于给 SDK 调用者返回 SDK 接口调用的执行结果、消息、内部工作状态等回调通知，方便 SDK 调用者结合具体的业务场景进行相应处理。

    函数列表 描述
    onError 错误事件回调
    onEnterRoom 进入房间成功与否的事件回调
    onExitRoom 离开房间的事件回调
    onRemoteUserEnterRoom 远端用户加入当前房间通知
    onRemoteUserLeaveRoom 远端用户离开当前房间通知
    onUserVideoAvailable 远端用户的视频可用或不可用状态发生状态变化时通知
    onUserAudioAvailable 远端用户的音频可用或不可用状态发生状态变化时通知
    onUserSubStreamAvailable 远端用户的辅流（通常是屏幕共享）的可用或不可用状态发生状态变化时通知
    onFirstVideoFrameDecoded 远端用户视频首帧解码完毕回调通知
    onFirstAudioFrame 已接收到某个远端用户的音频首帧的回调
    onFirstVideoFrame 远端用户的视频首帧渲染的回调通知
    onSendFirstLocalVideoFrame 已发送本地视频首帧的回调
    onSendFirstLocalAudioFrame 已发送本地音频首帧的回调
    onStatistics 音视频相关的度量指标统计回调
    onScreenCaptureStarted 屏幕分享开启的事件回调
    onScreenCaptureStoped 屏幕分享停止的事件回调
    onLog 日志打印回调
    onUserVoiceVolume 音量大小的反馈回调
    onSwitchRole 切换角色的结果回调通知
    onNetworkQuality 推拉流质量简单评价通知
    onConnectionLost 与信令服务器连接断开的通知
    onTryToReconnect 与信令服务器连接开始自动重连的通知
    onConnectionRecovery 与信令服务器连接已经恢复的通知
    onSyncRoom 重连后已经和服务器进行了信息同步完毕的事件通知
    onBliveEnterRoom 互动直播模式下，进入互动直播房间的结果通知
    onBliveExitRoom 互动直播模式下，离开互动直播房间的结果通知
    onBliveSwitchRole 互动直播模式下的主播、观众角色切换结果通知
    onBliveConnectionLost 互动直播模式下，与互动直播服务器连接断开的通知
    onBliveTryToReconnect 互动直播模式下，尝试和服务器发起重连的通知
    onBliveConnectionRecovery 互动直播模式下，和服务器连接已经恢复的通知
    onMixStreamAdded 互动直播模式下，房间内有新的混流产生事件通知
    onMixStreamRemoved 互动直播模式下，房间内有混流移除的事件通知
    onMixStreamUpdate 互动直播模式下，房间内混流信息更新的事件通知
    onMixedNotification 互动直播模式下，进房成功后，服务器下发当前混流信息
    onBliveConflictLogin 互动直播模式下，有其他用户使用了相同的UID进房，已在房用户收到的登录冲突通知
    onStartTranscode 互动直播模式下，主播发起混流请求后的结果通知
    onStopTranscode 互动直播模式下，主播发起停止混流请求后的结果通知

    详细信息

    onError
    错误事件，表示 SDK 抛出的不可恢复的错误，比如进入房间失败或设备开启失败等。

    onError: (code: number, message: string)

    参数

    名称 描述
    errCode 错误码
    errMsg 错误信息

    onEnterRoom
    已加入房间的回调

    onEnterRoom: (result: number)

    参数

    名称 描述
    result result > 0 时为进房耗时（ms），result < 0 时为进房错误码

    详情

    • 调用 BRTC 中的 enterRoom 接口执行进房操作后，会收到来自 SDK 的 onEnterRoom(result) 回调

    onExitRoom
    离开房间的事件回调

    onExitRoom: (reason: number)

    参数

    名称 描述
    reason 0: 退出房间成功; 1: 被踢; 2: 房间已被关闭

    详情

    • 调用 BRTC 中的 exitRoom 接口会执行退出房间的相关逻辑，例如释放音视频设备资源和编解码器资源等，之后会通过 onExitRoom() 回调通知到您
    • 如果您要再次调用 enterRoom 或者切换到其他的音视频 SDK，建议您等待 onExitRoom() 回调到来之后再执行相关操作，否则可能会遇到例如摄像头、麦克风设备被抢占等各种异常问题

    onRemoteUserEnterRoom
    有用户加入当前房间

    onRemoteUserEnterRoom: (userId: string)

    参数

    名称 描述
    userId 远端用户 ID

    详情

    • onRemoteUserEnterRoom 和 onRemoteUserLeaveRoom 只适用于维护当前房间里的“成员列表”，如果需要显示远程画面，建议使用监听 onUserVideoAvailable() 事件回调

    onRemoteUserLeaveRoom
    有用户离开当前房间

    onRemoteUserLeaveRoom: (userId: string, reason: number)

    参数

    名称 描述
    userId 远端用户 ID
    userId 0: 主动离开房间; 1: 被踢; 2: 房间已被关闭

    onUserVideoAvailable
    远端用户是否存在可播放的主路画面（一般用于摄像头）

    onUserVideoAvailable: (userId: string, available: boolean)

    参数

    名称 描述
    userId 远端用户 ID
    available true表示可用，false表示不可用

    详情

    • 收到 onUserVideoAvailable(userid, true) 通知时，表示该路画面已经有可用的视频数据帧到达，此时，您需要调用 startRemoteView 接口加载该用户的远程画面。

    • 收到 onUserVideoAvailable(userid, false) 通知时，表示该路远程画面已被关闭，可能由于您主动 mute 了该用户的视频，或者该用户关闭了自己的视频

    • 自动订阅模式下，收到此通知表示远端用户的视频流已经到达并会被自动拉取并解码
    • 手动订阅模式下，收到此通知表示远端用户的视频流已经可用，但还需要主动触发订阅才会拉取

    onUserAudioAvailable
    远端用户是否存在可播放的音频数据

    onUserAudioAvailable: (userId: string, available: boolean)

    参数

    名称 描述
    userId 远端用户 ID
    available true表示可用，false表示不可用
    • 自动订阅模式下，收到此通知表示远端用户的音频流已经到达并会被自动拉取并解码播放
    • 手动订阅模式下，收到此通知表示远端用户的音频流已经可用，但还需要主动触发订阅才能解码播放

    onUserSubStreamAvailable
    端用户的辅流（通常是屏幕共享）的可用或不可用状态发生状态变化时通知

    onUserSubStreamAvailable: (userId: string, available: boolean)

    参数

    名称 描述
    userId 远端用户 ID
    available true表示可用，false表示不可用

    详情

    “辅路画面”一般被用于承载屏幕分享的画面。当您收到 onUserSubStreamAvailable(userId, true) 通知时，表示该路画面已经有可用的视频数据帧到达。您可以调用 startRemoteView 传入 BrtcVideoStreamTypeSub 类型来请求预览。

    onFirstVideoFrameDecoded
    远端用户的视频首帧解码完成通知

    onFirstVideoFrameDecoded: (userId: string, width: number, height: number, elapsed: number)

    参数

    名称 描述
    userId 远端用户 ID
    width 画面宽度
    height 画面高度
    elapsed 耗时

    onFirstAudioFrame
    已接收到某个远端用户的音频首帧的回调

    onFirstAudioFrame: (userId: string)

    参数

    名称 描述
    userId 远端用户 ID

    onFirstVideoFrame
    远端用户的视频首帧渲染的回调通知

    onFirstVideoFrame: (userId: string, streamType: number, width: number, height: number) => void;

    参数

    名称 描述
    userId 远端用户 ID
    streamType 流类型，参见 BrtcVideoStreamType
    width 画面宽度
    height 画面高度

    onSendFirstLocalVideoFrame
    首帧本地视频数据已经被送出

    onSendFirstLocalVideoFrame: (type: number)

    参数

    名称 描述
    type 流类型，参见 BrtcVideoStreamType

    详情

    • SDK 会在 enterRoom 并 startLocalPreview 成功后开始摄像头采集，并将采集到的画面进行编码
    • 当 SDK 成功向云端送出第一帧视频数据后，会抛出这个回调事件

    onSendFirstLocalAudioFrame
    首帧本地音频数据已经被送出

    onSendFirstLocalAudioFrame: ()

    详情

    • SDK 会在 enterRoom 并 startLocalAudio 成功后开始麦克风采集，并将采集到的声音进行编码
    • 当 SDK 成功向云端送出第一帧音频数据后，会抛出这个回调事件

    onStatistics
    音视频相关的度量指标统计回调

    onStatistics: (jsonStats: string)

    参数

    名称 描述
    statistics 统计数据信息。包括本地和远程的。JSON 字符串。

    详情

    • 如果您是熟悉音视频领域相关术语，可以通过这个回调获取 SDK 的所有技术指标。每 2 秒回调一次

    onScreenCaptureStarted
    当屏幕分享开始时，SDK 会通过此回调通知

    onScreenCaptureStarted: ()

    onScreenCaptureStoped
    当屏幕分享停止时，SDK 会通过此回调通知

    onScreenCaptureStoped: (reason: number)

    参数

    名称 描述
    reason 停止原因：
    0: 主动停止;
    3: 共享被取消;
    4: 共享被用户停止;
    5: 共享被打断;
    6: 共享因来电被终止

    onLog
    日志打印回调

    onLog: (log: string, level: number, module: string)

    参数

    名称 描述
    log 日志内容
    level 日志等级，参见 BRTCLogLevel
    module 目前为固定值 BRTC

    onUserVoiceVolume
    音量大小的反馈回调

    onUserVoiceVolume: (userVolumes: BrtcVolumeInfo[], totalVolume: number) => void;

    参数

    名称 描述
    userVolumes 所有正在说话的房间成员的音量，取值范围 0 - 100
    totalVolume 所有远端成员的总音量, 取值范围 0 - 100

    详情

    • 您可以通过调用 BRTC 中的 enableAudioVolumeEvaluation 接口来开关这个回调或者设置它的触发间隔。需要注意的是，调用 enableAudioVolumeEvaluation 开启音量回调后，无论频道内是否有人说话，都会按设置的时间间隔调用这个回调。如果没有人说话，则 userVolumes 为空，totalVolume 为 0。

    onSwitchRole
    切换角色回调

    onSwitchRole: (errCode: number, errMsg: string) => void;

    参数

    名称 描述
    errCode 错误码。当错误码不是 0 的时候，需要参考 errMsg 给出的具体错误信息判断具体原因。
    errMsg 错误信息

    onNetworkQuality
    推拉流质量简单评价通知

    onNetworkQuality: (jsonQualityArray: string) => void;

    参数

    名称 描述
    jsonQualityArray 网络质量评价信息，JSON 字符串。

    详情

    网络质量评价信息包括上行和下行的质量评价。给出的是 JSON 格式的字符串，内容是 JSON 数组。数组中的每个元素包括 userId 和 qualityLevel 两项信息。其中，网络质量从 0 ~ 6 分别代表：UNKNOWN（无信息）、EXCELLENT、GOOD、POOR、BAD、VBAD、DOWN。数字越大表明质量越糟糕。

    onConnectionLost
    SDK 跟服务器的连接断开

    onConnectionLost: () => void;

    您收到这个回调后，通常情况下不需要进行额外的处理。因为 SDK 内部会自动发起重连并尝试进行恢复。

    onTryToReconnect
    SDK 尝试重新连接到服务器

    onTryToReconnect: () => void;

    onConnectionRecovery
    SDK 跟服务器的连接恢复

    onConnectionRecovery: () => void;

    onSyncRoom
    重连后已经和服务器进行了信息同步完毕的事件通知

    onSyncRoom: () => void;

    onBliveEnterRoom
    互动直播模式下，进入互动直播房间的结果通知

    onBliveEnterRoom: (result: number) => void;

    参数

    名称 描述
    result <0 表示进房失败，result的值是错误码。
    >0 表示进房成功，result的值是进房耗时（毫秒）

    onBliveExitRoom
    互动直播模式下，离开互动直播房间的结果通知

    onBliveExitRoom: (reason: number) => void;

    参数

    名称 描述
    reason 0: 退出房间成功; 1: 被踢; 2: 房间已被关闭

    onBliveSwitchRole
    互动直播模式下的主播、观众角色切换结果通知

    onBliveSwitchRole: (role: number) => void;

    参数

    名称 描述
    role 0: 切换为观众; 1: 切换为主播

    onBliveConnectionLost
    互动直播模式下，与互动直播服务器连接断开的通知

    onBliveConnectionLost: () => void;

    onBliveTryToReconnect
    互动直播模式下，尝试和服务器发起重连的通知

    onBliveTryToReconnect: () => void;

    onBliveConnectionRecovery
    互动直播模式下，和服务器连接已经恢复的通知

    onBliveConnectionRecovery: () => void;

    onMixStreamAdded
    互动直播模式下，房间内有新的混流产生事件通知

    onMixStreamAdded: (streamId: string, streamProp: BrtcLiveMixStreamProperty) => void;

    参数

    名称 描述
    streamId 混流 ID
    streamProp 混流属性。参见BrtcLiveMixStreamProperty

    onMixStreamRemoved
    互动直播模式下，房间内有混流移除的事件通知

    onMixStreamRemoved: (roomId: string, streamId: string, customData: string) => void;

    参数

    名称 描述
    roomId 房间 ID
    streamId 混流 ID
    customData 自定义数据

    onMixStreamUpdate
    互动直播模式下，房间内混流信息更新的事件通知

    onMixStreamUpdate: (streamId: string, streamProp: BrtcLiveMixStreamProperty) => void;

    参数

    名称 描述
    streamId 混流 ID
    streamProp 混流属性。参见BrtcLiveMixStreamProperty

    onMixedNotification
    互动直播模式下，进房成功后，服务器下发当前混流信息

    onMixedNotification: (streamId: string, customData: string) => void;

    参数

    名称 描述
    streamId 混流 ID
    customData 自定义数据

    onBliveConflictLogin
    互动直播模式下，有其他用户使用了相同的UID进房，已在房用户收到的登录冲突通知

    onBliveConflictLogin: () => void;

    onStartTranscode
    互动直播模式下，主播发起混流请求后的结果通知

    onStartTranscode: (streamId: string, errCode: number, errMsg: string) => void;

    参数

    名称 描述
    streamId 混流 ID
    errCode 错误码。当错误码不是 0 的时候，需要参考 errMsg 给出的具体错误信息判断具体原因。
    errMsg 错误信息

    onStopTranscode 互动直播模式下，主播停止混流请求后的结果通知

    onStopTranscode: (streamId: string, errCode: number, errMsg: string) => void;

    参数

    名称 描述
    streamId 混流 ID
    errCode 错误码。当错误码不是 0 的时候，需要参考 errMsg 给出的具体错误信息判断具体原因。
    errMsg 错误信息
    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论