互动直播>客户端 API>Web

Web

编辑文档 更新于
概览BLiveClientStreamLocalStreamRemoteStreamEventsBLiveErrorOption

ClientOptions

名称 类型 描述
appId string appId（应用标识/应用 id ）
codec "h264" | "vp8" 编码方式,目前只支持h264
mode "rtc" 直播模式，默认 rtc 模式，目前只支持 rtc 模式
role "anchor" 'audience' 用户角色，anchor 是主播角色，audience 是观众角色，主播角色推拉 rtc 流，观众角色不能推流，只能拉合流(https-flv)

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 视频源

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 200
180p 320 × 180 15 350
240p 320 × 240 15 400
360p 640 × 360 15 800
480p (默认项。也可自定义，如下) 640 × 480 15 900
720p 1280 × 720 15 1500
1080p 1920 × 1080 15 2000
1440p 2560 × 1440 30 4860
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 900
480p_2 640 × 480 30 1000
720p 1280 × 720 5 1200
720p_2 1280 × 720 30 3000
1080p 1920 × 1080 5 1600
1080p_2 1920 × 1080 30 4860

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 视频宽度

MixTranscodeParams

名称 类型 描述
taskId string 合流任务 id 存在时表示更新该合流任务
mode number 布局方式: 1-自定义布局(默认) 2-画廊布局 3-演讲布局 4-悬浮布局
forceMix boolean 单路流时是否强制转码
fitMode number 填充方式: 0-aspectFit(补黑边, 默认), 1-aspectFill(裁剪), 2-fill(拉伸填充)
videoWidth number 视频宽度
videoHeight number 视频高度
videoBitrate number 视频码率
videoFramerate number 视频帧率
color string 填充背景色(默认补黑边)
videoGOP number 关键帧间隔
customData string 用户自定义信息
mixUsers MixUser[] 窗口布局

MixUser

名称 类型 描述
userId string user id
width number 当前 user 显示宽度
height number 当前 user 显示高度
x number 当前 user 显示横坐标（相对于左上角定位）
y number 当前 user 显示纵坐标（相对于左上角定位）
zOrder number 当前 user 显示 z 坐标（显示优先级））
fitMode number 当前 user 填充方式: 0-aspectFit(补黑边, 默认), 1-aspectFill(裁剪), 2-fill(拉伸填充)
color string 当前 user 填充背景色(默认补黑边)
videoGOP number 关键帧间隔
streamId string 当前 user 参与混流的 streamId
{{allComment[version]}} ×
  • 暂无评论
  • {{comment.author}}
    {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
    {{comment.content}}
您需要 后才能评论