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

    Electron

    编辑文档 更新于
    BRTCBRTCCallBack对象和枚举BRTCError

    对象和枚举 定义了一些配置参数和文件夹包含 SDK 接口的入参及出参的类的定义。

    详细信息

    枚举

    视频相关枚举值定义  
    BRTCVideoResolution 视频分辨率
    BRTCVideoResolutionMode 视频宽高比模式
    BRTCVideoStreamType 视频流类型
    BRTCVideoFillMode 视频画面填充模式
    BRTCVideoRotation 视频画面旋转方向
    BRTCVideoMirrorMode 本地视频预览镜像类型
    BRTCSnapshotSourceType 视频截图来源
    网络相关枚举值定义  
    BRTCQosControlMode 流控模式
    BRTCVideoQosPreference 画质偏好
    声音相关枚举值定义  
    BRTCAudioQuality 声音音质
    设备相关枚举值定义  
    BRTCMediaDeviceType 设备类型
    BRTCDeviceState 设备操作
    渲染相关枚举值定义  
    BRTCVideoRenderType 渲染方式
    用户相关枚举值定义  
    BRTCRoleType 用户角色
    Log 相关枚举值定义  
    BRTCLogLevel Log 级别

    详细信息

    BRTCVideoResolution
    视频分辨率

    变量名 值 描述
    BRTCVideoResolution_120_120 1 建议码率 VideoCall:80kbps LIVE:120kbps
    BRTCVideoResolution_160_160 3 建议码率 VideoCall:100kbps LIVE:150kbps
    BRTCVideoResolution_270_270 5 建议码率 VideoCall:200kbps LIVE:120kbps
    BRTCVideoResolution_480_480 7 建议码率 VideoCall:350kbps LIVE:120kbps
    BRTCVideoResolution_160_120 50 建议码率 VideoCall:100kbps LIVE:150kbps
    BRTCVideoResolution_240_180 52 建议码率 VideoCall:150kbps LIVE:225kbps
    BRTCVideoResolution_280_210 54 建议码率 VideoCall:200kbps LIVE:300kbps
    BRTCVideoResolution_320_240 56 建议码率 VideoCall:250kbps LIVE:375kbps
    BRTCVideoResolution_400_300 58 建议码率 VideoCall:300kbps LIVE:450kbps
    BRTCVideoResolution_480_360 60 建议码率 VideoCall:400kbps LIVE:600kbps
    BRTCVideoResolution_640_480 62 建议码率 VideoCall:600kbps LIVE:900kbps
    BRTCVideoResolution_960_720 64 建议码率 VideoCall:1000kbps LIVE:1500kbps
    BRTCVideoResolution_160_90 100 建议码率 VideoCall:150kbps LIVE:250kbps
    BRTCVideoResolution_256_144 102 建议码率 VideoCall:200kbps LIVE:300kbps
    BRTCVideoResolution_320_180 104 建议码率 VideoCall:250kbps LIVE:400kbps
    BRTCVideoResolution_480_270 106 建议码率 VideoCall:350kbps LIVE:550kbps
    BRTCVideoResolution_640_360 108 建议码率 VideoCall:550kbps LIVE:900kbps
    BRTCVideoResolution_960_540 110 建议码率 VideoCall:850kbps LIVE:1300kbps
    BRTCVideoResolution_1280_720 112 建议码率 VideoCall:1200kbps LIVE:1800kbps
    BRTCVideoResolution_1920_1080 114 建议码率 VideoCall:2000kbps LIVE:3000kbps

    详情

    • 此处仅定义横屏分辨率，如需使用竖屏分辨率（例如360 × 640），需要同时指定 BRTCVideoResolutionMode 为 Portrait

    BRTCVideoResolutionMode
    视频宽高比模式

    变量名 值 描述
    BRTC_VIDEO_RESOLUTION_MODE_PORTRAIT 0 竖屏分辨率
    BRTC_VIDEO_RESOLUTION_MODE_LANDSCAPE 1 横屏分辨率

    详情

    • 横屏分辨率：BRTCVideoResolution_640_360 + BRTCVideoResolutionModeLandscape | 640 × 360
    • 竖屏分辨率：BRTCVideoResolution_640_360 + BRTCVideoResolutionModePortrait | 360 × 640

    BRTCVideoStreamType
    视频流类型

    变量名 值 描述
    BRTC_VIDEO_STREAM_TYPE_BIG 0 主画面视频流
    BRTC_VIDEO_STREAM_TYPE_SMALL 1 小画面视频流
    BRTC_VIDEO_STREAM_TYPE_SUB 2 辅流（屏幕分享）

    详情

    • BRTC 内部有三种不同的音视频流，分别是：
      • 主画面：最常用的一条线路，一般用来传输摄像头的视频数据
      • 小画面：跟主画面的内容相同，但是分辨率和码率更低
      • 辅流画面：一般用于屏幕分享，以及远程播片（例如老师放一段视频给学生）
    • 如果主播的上行网络和性能比较好，则可以同时送出大小两路画面
    • SDK 不支持单独开启小画面，小画面必须依附于主画面而存在

    BRTCVideoRenderMode
    视频画面填充模式

    变量名 值 描述
    BRTC_VIDEO_RENDER_MODE_FILL 0 图像铺满屏幕，超出显示视窗的视频部分将被裁剪
    BRTC_VIDEO_RENDER_MODE_FIT 1 图像长边填满屏幕，短边区域会被填充黑色

    详情

    • 如果画面的显示分辨率不等于画面的原始分辨率，就需要您设置画面的填充模式:
      • BRTCVideoFillMode_Fill，图像铺满屏幕，超出显示视窗的视频部分将被裁剪，画面显示可能不完整
      • BRTCVideoFillMode_Fit，图像长边填满屏幕，短边区域会被填充黑色，画面的内容完整

    BRTCVideoRotation
    视频画面旋转方向

    变量名 值 描述
    BRTC_VIDEO_ROTATION_0 0 不旋转
    BRTC_VIDEO_ROTATION_90 1 顺时针旋转90度
    BRTC_VIDEO_ROTATION_180 2 顺时针旋转180度
    BRTC_VIDEO-ROTATION_270 3 顺时针旋转270度

    详情

    • BRTC SDK 提供了对本地和远程画面的旋转角度设置 API，下列的旋转角度都是指顺时针方向的

    BRTCVideoMirrorMode
    本地视频预览镜像类型

    变量名 值 描述
    BRTC_VIDEO_MIRROR_MODE_DISABLED 0 关闭镜像
    BRTC_VIDEO_MIRROR_MODE_ENABLED 1 启用镜像

    BRTCSnapshotSourceType
    视频截图来源

    变量名 值 描述
    BRTC_SNAPSHOT_SOURCE_TYPE_STREAM 0 从视频流上截取视频画面
    BRTC_SNAPSHOT_SOURCE_TYPE_VIEW 1 从渲染 View 上截取视频画面

    BRTCQosControlMode
    流控模式

    变量名 值 描述
    BRTC_QOS_CONTROL_MODE_CLIENT 0 客户端控制（用于 SDK 开发内部调试，客户请勿使用）
    BRTC_QOS_CONTROL_MODE_SERVER 1 云端控制 （默认）

    详情

    • SDK 内部需要时刻根据网络情况调整内部的编解码器和网络模块，以便能够对网络的变化做出反应
    • 为了支持快速算法升级，SDK 内部设置了两种不同的流控模式：
      • ModeServer：云端控制，默认模式，推荐选择
      • ModeClient：本地控制，用于 SDK 开发内部调试，客户请勿使用

    BRTCVideoQosPreference
    画质偏好

    变量名 值 描述
    BRTC_VIDEO_QOS_PREFERENCE_SMOTTH 1 弱网下保流畅
    BRTC_VIDEO_QOS_PREFERENCE_CLEAR 2 弱网下保清晰，默认值

    详情

    • 指当 BRTC SDK 在遇到弱网络环境时，您期望“保清晰”或“保流畅”，两种模式均会优先保障声音数据的传输
      • Smooth：弱网下优先流畅性，当用户网络较差的时候画面也会比较模糊
      • Clear：默认值，弱网下优先清晰度，当用户网络较差的时候会出现卡顿，但画面清晰度不会大幅缩水

    BRTCAudioQuality
    声音音质

    变量名 值 描述
    BRTC_AUDIO_QUALITY_SPEECH 1 流畅音质：采样率：16k；单声道；音频裸码率：16kbps；适合语音通话为主的场景，比如在线会议，语音通话
    BRTC_AUDIO_QUALITY_DEFAULT 2 默认音质：采样率：48k；单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之
    BRTC_AUDIO_QUALITY_MUSIC 3 高音质：采样率：48k；双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，比如K歌、音乐直播等

    详情

    • 音频音质用来衡量声音的保真程度，BRTCAudioQualitySpeech 适用于通话场景，BRTCAudioQualityMusic 适用于高音质音乐场景

    BRTCLogLevel
    Log 级别

    变量名 值 描述
    BRTC_LOG_LEVEL_VERBOSE 0 输出所有级别的 Log
    BRTC_LOG_LEVEL_DEBUG 1 输出 DEBUG，INFO，WARNING，ERROR 级别的 Log
    BRTC_LOG_LEVEL_INFO 2 输出 INFO，WARNING，ERROR 级别的 Log
    BRTC_LOG_LEVEL_WARN 3 只输出WARNING，ERROR 级别的 Log
    BRTC_LOG_LEVEL_ERROR 4 只输出ERROR 级别的 Log
    BRTC_LOG_LEVEL_FATAL 5 输出 FATAL 级别的 Log
    BRTC_LOG_LEVEL_NONE 6 不输出 Log

    详情

    • 不同的日志等级定义了不同的详实程度和日志数量，推荐一般情况下将日志等级设置为：BRTCLogLevelInfo

    BRTCMediaDeviceType
    设备类型

    变量名 值 描述
    BRTC_MEDIA_DEVICE_TYPE_UNKNOWN -1 未知类型
    BRTC_MEDIA_DEVICE_TYPE_MIC 0 麦克风
    BRTC_MEDIA_DEVICE_TYPE_SPEAKER 1 扬声器或者听筒
    BRTC_MEDIA_DEVICE_TYPE_CAMERA 2 摄像头

    BRTCDeviceState
    设备操作

    变量名 值 描述
    BRTC_DEVICE_STATE_ADD 0 添加设备
    BRTC_DEVICE_STATE_REMOVE 1 移除设备
    BRTC_DEVICE_STATE_ACTIVE 2 设备已启用

    BRTCVideoRenderType
    渲染类型

    变量名 值 描述
    BRTC_VIDEO_RENDER_TYPE_WEBGL 0 使用 WebGL 渲染视频画面
    BRTC_VIDEO_RENDER_TYPE_CANVAS 1 使用 Canvas 渲染视频画面

    BRTCRoleType
    角色类型

    变量名 值 描述
    BRTC_ROLE_ANCHOR 20 主讲，一般既推流也拉流
    BRTC_ROLE_AUDIENCE 21 观众，一般只拉流

    AudioMusicParam

    背景音乐参数数据结构

    变量名 类型 描述
    id number 音乐 ID
    path string 音乐文件路径
    loopCount number 音乐循环播放的次数
    publish boolean 是否将音乐传到远端
    isShortFile boolean 播放的是否为短音乐文件
    startTimeMS number 音乐开始播放时间点，单位毫秒

    VideoCodecParams

    视频编码参数数据结构

    变量名 类型 描述
    codec BRTCVideoCodec 视频编码格式
    bitrate number 码率
    width number 视频宽
    height number 视频高
    frameRate number 帧率
    resolutionMode BRTCVideoResolutionMode 宽高比模式

    BRTCRenderParams

    视频渲染参数数据结构

    变量名 类型 描述
    rotation BRTCVideoRotation 视频画面旋转方向，默认值为 BRTCVideoRotation0
    fillMode BRTCVideoFillMode 视频画面填充模式，默认值为 BRTCVideoFillMode_Fit
    mirrorType BRTCVideoMirrorMode 视频画面镜像模式，默认值为 BRTCVideoMirrorTypeDisable
    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论