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

    HarmonyOS

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

    BRTC 提供可以灵活搭配的 API 组合,为移动端到移动端以及移动端到 Web 端提供质量可靠的实时音视频通信功能。

    API 概览

    创建实例和事件回调

    函数列表 描述
    createEngine 创建 BRTC 引擎
    destroyEngine 销毁 BRTC 引擎
    on 监听事件

    房间相关接口函数

    函数列表 描述
    enterRoom 进入房间
    exitRoom 离开房间
    setDefaultStreamRecvMode 设置默认的订阅模式

    视频相关接口函数

    函数列表 描述
    startLocalPreview 开启本地视频的预览画面
    stopLocalPreview 停止本地视频采集及预览
    muteLocalVideo 暂停/恢复推送本地的视频数据
    startRemoteView 开始拉取并显示指定用户的远端画面
    stopRemoteView 停止显示远端视频画面，同时不再拉取该远端用户的视频数据流
    muteRemoteVideo 暂停/恢复接收指定的远端视频流
    setVideoEncoderParam 设置视频编码器相关参数
    setNetworkQosParam 设置网络流控相关参数
    setRenderParams 设置本地或远端用户视频画面渲染模式
    setVideoEncoderMirror 设置视频编码输出的画面方向，即设置远端用户观看到的和服务器录制的画面方向
    setVideoEncoderRotation 设置视频编码器输出的画面方向
    enableSmallVideoStream 开启大小画面双路编码模式
    setRemoteVideoStreamType 切换指定远端用户的大小画面

    音频相关接口

    函数列表 描述
    startLocalAudio 开启本地音频的采集和上行
    stopLocalAudio 关闭本地音频的采集和上行
    muteLocalAudio 静音/取消静音本地的音频
    muteRemoteAudio 静音/取消静音指定的远端用户的声音
    muteAllRemoteAudio 静音/取消静音所有远端用户的声音

    设备管理相关接口

    函数列表 描述
    getDeviceManager 获取设备管理类 BRTCDeviceManager

    屏幕分享相关接口

    函数列表 描述
    startScreenCapture 开始屏幕分享
    stopScreenCapture 停止屏幕分享

    调试相关接口函数

    函数列表 描述
    getSdkVersion 获取 SDK 版本信息
    setLogLevel 设置日志输出级别
    setConsoleEnabled 启用或禁用控制台日志打印
    setLogPath 设置日志保存路径
    setLogListener 设置日志回调
    callExperimentalApi 调用实验性 API 接口

    BrtcListener 回调

    房间事件回调

    函数列表 描述
    onEnterRoom 已加入房间的回调
    onExitRoom 本地用户离开房间的事件回调

    成员事件回调

    函数列表 描述
    onRemoteUserEnterRoom 远端用户加入当前房间通知
    onRemoteUserLeaveRoom 远端用户离开当前房间通知

    音视频事件回调

    函数列表 描述
    onUserVideoAvailable 远端用户的视频可用或不可用状态发生状态变化时通知
    onUserSubStreamAvailable 远端用户的辅流（通常是屏幕共享）的可用或不可用状态发生状态变化时通知
    onUserAudioAvailable 远端用户的音频可用或不可用状态发生状态变化时通知
    onFirstVideoFrameDecoded 远端用户视频首帧解码完毕回调通知
    onFirstAudioFrame 已接收到某个远端用户的音频首帧的回调
    onSendFirstLocalVideoFrame 已发送本地视频首帧的回调
    onSendFirstLocalAudioFrame 已发送本地音频首帧的回调

    统计和质量回调

    函数列表 描述
    onStatistics 技术指标统计回调

    屏幕分享回调

    函数列表 描述
    onScreenCaptureStarted 当屏幕分享开始时，SDK 会通过此回调通知
    onScreenCaptureStoped 当屏幕分享停止时，SDK 会通过此回调通知

    调试信息回调

    函数列表 描述
    onLog 有日志打印时的回调
    onError 错误回调，表示 SDK 不可恢复的错误，一定要监听并分情况给用户适当的界面提示

    枚举

    视频相关枚举值定义

    枚举类型  
    BrtcVideoStreamType 视频流类型
    BrtcVideoResolutionMode 视频宽高比模式
    BrtcVideoRotation 视频画面旋转方向
    BrtcVideoFillMode 视频画面填充模式

    音频相关枚举值定义

    枚举类型  
    BrtcAudioQuality 声音音质

    网络相关枚举值定义

    枚举类型  
    BrtcVideoQosPreference 网络调整策略

    其他

    枚举类型  
    BrtcLogLevel 日志级别

    类

    类名 说明
    BrtcEngineAdvancedConfig BRTC 引擎配置
    BrtcRoomParams 进房参数
    BrtcRenderParams 视频渲染参数
    BrtcNetworkQosParam 网络流控相关参数
    BrtcVideoEncParam 视频配置参数
    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论