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

    Web

    编辑文档 更新于
    概览BRTCClientStreamLocalStreamRemoteStreamEventsBRTCErrorOption

    ClientOptions

    名称 类型 描述
    appId string appId（应用标识/应用 id ）
    codec "h264" | "vp8" 编码方式
    mode "rtc" 直播模式，默认 rtc 模式，目前只支持 rtc 模式

    Device

    名称 类型 描述
    default boolean 是否是系统默认设备
    deviceId string 设备标识
    groupId string 设备分组 id,来自同一个硬件的两个设备具有相同的 groupId
    index number 设备索引
    kind "videoinput" | "audioinput" | "audiooutput" 设备类型
    name string 设备名称

    Server

    名称 类型 描述
    area string server 区域
    name string server 名称

    StreamCodecOption

    名称 类型 描述
    audioBitrate number 音频码率
    bitrate number 视频码率
    frameRate number 视频帧率
    height number 视频高度
    width number 视频宽度

    StreamDeviceOption

    名称 类型 描述
    audio boolean 是否有音频
    audioSource MediaStreamTrack 音频源
    cameraId string 摄像头设备标识 Device.deviceId
    microphoneId string 麦克风设备标识 Device.deviceId
    screen boolean 是否是屏幕分享
    video boolean 是否有视频
    videoSource MediaStreamTrack 视频源
    echoCancellation boolean 是否开启回声消除（默认开启）
    autoGainControl boolean 是否开启自动增益（默认开启）
    noiseSuppression boolean 是否开启自动降噪（默认开启）
    videoHint "motion" 流畅 | "detail" 清晰 | "text" 清晰 视频自适应模式
    audioHint "speech" 演讲 | "speech-recognition" 语音识别 | "music" 音乐 音频自适应模式

    StreamPlayOption

    名称 类型 描述
    fit "cover" | "contain" video fit 类型
    muted boolean 静音播放
    rotateX number 水平旋转
    rotateY number 垂直旋转

    SubscribeOptions

    名称 类型 描述
    audio boolean 是否订阅音频
    video boolean 是否订阅视频

    AudioProfile

    音频 Profile 采样率 声道 码率
    standard (默认项) 48000 单声道 40
    high 48000 单声道 128

    VideoProfile

    视频 Profile 分辨率(宽 × 高) 帧率 码率
    120p 160 × 120 15 100
    180p 320 × 180 15 200
    240p 320 × 240 15 200
    360p 640 × 360 15 400
    480p (默认项。也可自定义，如下) 640 × 480 15 500
    720p 1280 × 720 15 1000
    1080p 1920 × 1080 15 2000
    1440p 2560 × 1440 30 4680
    4K 3840 × 2160 30 9000
    自定义名称 类型 描述
    width number 视频宽度
    height number 视频高度
    frameRate number 帧率
    bitrate number 比特率 kbps

    ScreenProfile

    名称 类型 描述
    profile 480p | 480p_2 | 720p | 720p_2 | 1080p | 1080p_2 屏幕共享 Profile，默认使用 1080p。也可自定义分辨率、帧率和码率
    名称 类型 描述
    width number 视频宽度
    height number 视频高度
    frameRate number 帧率
    bitrate number 比特率 kbps
    屏幕共享 Profile 分辨率(宽 × 高) 帧率 码率
    480p 640 × 480 5 500
    480p_2 640 × 480 30 600
    720p 1280 × 720 5 800
    720p_2 1280 × 720 30 2000
    1080p 1920 × 1080 5 1200
    1080p_2 1920 × 1080 30 3000

    LocalStreamStats

    名称 类型 描述
    audioBytesSent number 音频发送字节数
    audioPacketsLost number 音频丢包数
    audioPacketsSent number 音频包发送数
    rtt number rtt 网络延时
    videoBytesSent number 视频发送字节数
    videoPacketsLost number 视频丢包数
    videoPacketsSent number 视频包发送数
    height number 视频高度
    width number 视频宽度

    RemoteStreamStats

    名称 类型 描述
    audioBytesSent number 音频接收字节数
    audioPacketsLost number 音频丢包数
    audioPacketsReceived number 音频包接收数
    rtt number rtt 网络延时
    videoBytesReceived number 视频接收字节数
    videoPacketsLost number 视频丢包数
    videoPacketsReceived number 视频包接收数
    height number 视频高度
    width number 视频宽度

    SmallStreamCodecOption

    名称 类型 描述
    width number 小流视频宽度
    height number 小流视频高度
    bitrate number 小流视频码率

    SupportResult

    名称 类型 描述
    result boolean 检测结果
    detail object 检测详细结果
    detail.isBrowserSupported boolean 当前浏览器是否是 SDK 支持的浏览器
    detail.isWebRTCSupported boolean 当前浏览器是否支持 WebRTC
    detail.isMediaDevicesSupported boolean 当前浏览器是否支持获取媒体设备及媒体流
    detail.isH264EncodeSupported boolean 当前浏览器上行是否支持 H264 编码
    detail.isH264DecodeSupported boolean 当前浏览器下行是否支持 H264 解码
    detail.isVp8EncodeSupported boolean 当前浏览器上行是否支持 VP8 编码
    detail.isVp8DecodeSupported boolean 当前浏览器下行是否支持 VP8 解码
    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论