You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/服务端 OpenAPI 参考/附录
附录
最近更新时间：2024.10.24 17:17:32首次发布时间：2023.12.15 16:52:28
我的收藏

Region 对照表

Typeregion备注
TOS
  • 0： cn-beijing，华北 2（北京）
  • 1：cn-guangzhou，华南 1（广州）
  • 2：cn-shanghai，华东 2（上海）
  • 3：ap-southeast-1，亚太东南（柔佛）
  • 根据你开启的 TOS 资源，选择对应的选项。否则可能导致上传不成功。
  • 如果选择海外 Region，建议接口的请求接入地址设为 open-ap-singapore-1.volcengineapi.com 以获得最佳体验。
Vod
  • 0: cn-north-1
  • 1: ap-southeast-1
根据你开启的 VoD 资源，选择对应的选项。否则可能导致上传不成功。
Amazon S3
  • 0：us-east-1，美国东部（弗吉尼亚北部）
  • 1：us-east-2，美国东部（俄亥俄）
  • 2：us-west-1，美国西部（加利福尼亚北部）
  • 3：us-west-2，美国西部（俄勒冈）
  • 4：eu-west-1，欧洲（爱尔兰）
  • 5：eu-west-2，欧洲（伦敦）
  • 6：eu-west-3，欧洲（巴黎）
  • 7：eu-central-1，欧洲（法兰克福）
  • 8：ap-southeast-1，亚太地区（新加坡）
  • 9：ap-southeast-2，亚太地区（悉尼）
  • 10：ap-northeast-1，亚太地区（东京）
  • 11：ap-northeast-2，亚太地区（首尔）
  • 12：sa-east-1，南美洲（圣保罗）
  • 13：ca-central-1，加拿大（中部）
  • 14：ap-south-1，亚太地区（孟买）
  • 15：cn-north-1，中国（北京）【AWS中国】
  • 16：cn-northwest-1，中国（宁夏）【AWS中国】
  • 17：us-gov-east-1，AWS GovCloud（美国东部）
  • 18：ap-east-1，亚太地区（香港）
  • 19：eu-south-1，欧洲（米兰）
  • 20：ap-northeast-3，亚太地区（大阪）
  • 21：eu-north-1，欧洲（斯德哥尔摩）
  • 22：me-south-1，中东（巴林）
  • 23：us-gov-west-1，AWS GovCloud（美国西部）
  • 24：af-south-1，非洲（开普敦）
详情可参看 AWS 区域终端节点 、终端节点和配额和 国内终端节点
  • 7，9，17，23 对应地域暂不支持。
  • 如果选择海外 Region，建议接口的请求接入地址设为 open-ap-singapore-1.volcengineapi.com 以获得最佳体验。
阿里云OSS
  • 0：oss-cn-hangzhou
  • 1：oss-cn-shanghai
  • 2：oss-cn-qingdao
  • 3：oss-cn-beijing
  • 4：oss-cn-zhangjiakou
  • 5：oss-cn-huhehaote
  • 6：oss-cn-wulanchabu
  • 7：oss-cn-shenzhen
  • 8：oss-cn-heyuan
  • 9：oss-cn-guangzhou
  • 10：oss-cn-chengdu
  • 11：oss-cn-hongkong
  • 12：oss-us-west-1
  • 13：oss-us-east-1
  • 14：oss-ap-southeast-1
  • 15：oss-ap-southeast-2
  • 16：oss-ap-southeast-3
  • 17：oss-ap-southeast-5
  • 18：oss-ap-northeast-1
  • 19：oss-ap-south-1
  • 20：oss-eu-central-1
  • 21：oss-eu-west-1
  • 22：oss-me-east-1
  • 23：oss-ap-southeast-6
详情可参看阿里云访问域名和数据中心
  • 16 对应地域暂不支持。
  • 如果选择海外 Region，建议接口的请求接入地址设为 open-ap-singapore-1.volcengineapi.com 以获得最佳体验。
华为云
  • 1：cn-north-4，华北-北京四
  • 3：cn-north-9，华北-乌兰察布一
  • 5：cn-east-3，华东-上海一
  • 6：cn-south-1，华南-广州
  • 11：cn-southwest-2，西南-贵阳一
  • 14：ap-southeast-1，中国-香港
  • 详情可参看 华为云地区和终端节点
腾讯云
  • 1：ap-beijing，北京
  • 2：ap-nanjing，南京
  • 3：ap-shanghai，上海
  • 4：ap-guangzhou，广州
  • 5：ap-chengdu，成都
  • 6：ap-chongqing，重庆
  • 7：ap-shenzhen-fsi，深圳金融
  • 8：ap-shanghai-fsi，上海金融
  • 9：ap-beijing-fsi，北京金融
  • 10：ap-hongkong，中国香港
详情可参看腾讯云地域和访问域名
七牛云
  • 0：cn-east-1，华东-浙江
  • 1：cn-east-2，华东-浙江2
  • 2：cn-north-1，华北-河北
  • 3：cn-south-1，华南-广东
详情可参看七牛云服务域名
VeImageX
  • 0：cn-north-1
  • 1：ap-singapore-1

如果选择海外 Region，建议接口的请求接入地址设为 open-ap-singapore-1.volcengineapi.com 以获得最佳体验。

质量数据相关 Indicator

参数名返回值描述
join_room_success_rate此 AppId 在某一进房时间内的进房成功率（%）。例如，5s_join_room_success_rate 表示进房时间在 5s 内的进房成功率。进房时间的默认值为 5s。
stall_rate此 AppId 对应档位的卡顿率（%）。例如，80ms_audio_stall_rate 表示通话过程中，音频卡顿在 80ms 以内的时间占比。
若同时有音视频，则分别返回音频和视频的指标。
  • audio_stall_rate：音频卡顿率。卡顿时间的默认值为 80ms。
  • video_stall_rate：视频卡顿率。卡顿时间的默认值为 500ms。
    • first_frame_send_success_rate此 AppId 的首帧发送成功率（%）。若同时有音视频，则分别返回音频和视频的指标。
  • audio_first_frame_send_success_rate：音频首帧发送成功率
  • video_first_frame_send_success_rate：视频首帧发送成功率
    • first_frame_recv_success_rate此 AppId 的首帧解码成功率（%）。若同时有音视频，则分别返回音频和视频的指标
  • audio_first_frame_recv_success_rate：音频首帧解码成功率
  • video_first_frame_recv_success_rate：视频首帧解码成功率
    • network_trans_delay此 AppId 对应档位的网络传输延时达标率（%）。例如，400ms_network_trans_delay 表示通话过程中，两方的传输延时在 400ms 之内的时间占比。
  • audio_network_trans_delay：音频网络传输时延达标率。传输延时的默认值为 400ms。
  • video_network_trans_delay：视频网络传输时延达标率。传输延时的默认值为 400ms。

    • 离线运营数据相关 Indicator

    Indicator 值返回值备注
    user_count此 AppId 应用在所选日期通话总人数通话人数按用户id去重。
    例如：用户 A 在所选日期进入2个不同的房间，则通话人数计为1。
    session_count此 AppId 应用在所选日期通话进出人次用户每新进入房间一次，记一次进出
    peak_concurrent_user此 AppId 应用在所选日期达到的最大同时在线人数同时在线用户数的峰值，用户可在不同房间中
    room_count此 AppId 应用在所选日期所创建的房间数从有用户进入房间到所有用户退出，记为一个房间
    high_concurrency_room此 AppId 应用在所选日期所有的高并发房间数最高同时在线用户数大于等于100的房间数
    peak_concurrent_room此 AppId 应用在所选日期最大同时在线房间数同时进行中房间的峰值
    avg_call_count此 AppId 应用在所选日期用户人均通话次数人均通话次数=通话进出人次/通话人数
    per_call_time该此 AppId 应用在所选日期用户人均单次通话时长单次通话时长 = 通话总时长（一个用户进入多个房间会重复计算）/通话进出人次
    例如：
    用户 A 从10:00:00-10:10:00在房间1拉用户 B 的音视频流，同时从 10:00:00-10:05:00 在房间2拉用户 C 的音频流，则用户 A 的通话总时长为 (10+5) = 15 分钟。用户 A 的单次通话时长为 (15/2) = 7.5 分钟。
    用户 D 从 10:00:00-10:09:00 在房间1拉用户 B 的视频流，则用户 D 的通话时长为 9 分钟。
    则整体单次通话时长为 (15+9)/3 = 8 分钟
    avg_call_time此 AppId 应用在所选日期用户人均通话时长人均通话时长 = 通话时长（一个用户同时进入多个房间只计算一次）/通话人数
    例如：
    用户 A 从 10:00:00-10:10:00 在房间1拉用户 B 音视频流，同时从 10:00:00-10:05:00 在房间2拉用户 C 的音视频流，则用户 A 的通话时长是 10 分钟。
    用户 D 从 10:00:00-10:08:00 在房间1拉用户 E 的视频流，同时从 10:00:00-10:08:00 在房间2拉用户 F 的视频流，则用户 D 的通话时长为 8 分钟。
    人均通话时长为 9 分钟。
    total_online_time此 AppId 应用在所选日期总房间在线时长每个房间从第一个用户进入到最后一个用户退出的时间记为每个房间的在线时间，统计区间所有房间在线时长的总和记为总房间在线时长
    avg_online_time此 AppId 应用在所选日期房间平均在线时长总房间在线时长 / 总房间数
    从有用户进入房间到所有用户退出，记为一个房间。
    avg_user_count此 AppId 应用在所选日期房间平均在线人数总通话人数按照用户id和房间id去重 / 总房间数

    实时运营数据相关 Indicator

    Indicator 值解释返回值
    online_user_count在线用户数此 AppId 应用下在线用户数
    online_room_count在线房间数该此 AppId 应用下在线房间数

    指标列表

    指标名称单位
    App 的 CPU 使用率%
    系统 CPU 使用率%
    音频采集音量——
    音频播放音量——
    音频发送码率Kbps
    音频接收码率Kbps
    音频上行网络延时ms
    音频上行丢包率%
    音频下行网络延时ms
    音频下行丢包率%
    音频卡顿时长ms
    视频发送分辨率的宽——
    视频发送分辨率的高——
    视频接收分辨率的宽——
    视频接收分辨率的高——
    视频采集帧率fps
    视频大流发送帧率fps
    视频小流发送帧率fps
    视频接收帧率fps
    视频大流发送码率Kbps
    视频小流发送码率Kbps
    视频接收码率Kbps
    视频上行网络延时ms
    视频上行丢包率%
    视频下行网络延时ms
    视频下行丢包率%
    视频卡顿时长ms