start-test-server 接口
修改于:V2.3
对服务器进行推流测试,同时间仅可对一路直播进行测试,测试过程中可以调用 stop-test-server 接口进行取消;当测试时间达到 20 秒时,自动停止直播测试。
请求方式
GET http://ip/usapi?method=start-test-server&type=xxx&url=xxx&key=xxx&...
参数 | 说明 |
---|---|
method | 方法名称:start-test-server |
type | 服务器类型 0: RTMP 1: Twitch 2: YouTube 3: Facebook 4: Wowza over RTMP 120: SRT Caller 122: Wowza over SRT |
name | 服务器名称,字符要求: 1、1 - 32 个字符 2、由 A-Z, a-z, 0-9, 空格 ._-+'[]() 组成,并且不能以空格开头或结束 |
RTMP直播参数 | |
stream-index | 编码码流 0: 主码流 1: 次码流 |
url | 服务器地址 |
key | 流秘钥 |
is-auth | 认证状态 0: 无需认证 1: 需要认证,用户名和密码必填 |
user | 用户名 |
passwd | 密码 |
token | Token |
event-data | 直播事件 |
net-mode | 网络优先 0: 移动宽带优先 1: 有线网络优先 2: 无线网络优先 |
audio | 音频码流 0: 音频码流1 1: 音频码流2 2: 音频码流3 3: 音频码流4 |
SRT Caller直播参数 | |
stream-index | 编码码流 0: 主码流 1: 次码流 |
url | 服务器地址 |
port | 端口号 |
latency | 延迟时间,通过get-info 可以获取相关参数的取值范围 |
bandwidth | 带宽限制,通过get-info 可以获取相关参数的取值范围 |
aes | 加密方式 0: 不加密 16: AES-128加密 24: AES-192加密 32: AES-256加密 |
ase-word | 加密字段 |
stream-id | 选填 |
net-mode | 网络优先 0: 移动宽带优先 1: 有线网络优先 2: 无线网络优先 |
audio-streams | 音频码流掩码值,若选择的音频码流为 n(n 取值范围 0~3),则 audio-streams |= (1 << n) |
token | Token,仅服务器类型为 Wowza over SRT 有效 |
event-data | 直播事件,仅服务器类型为 Wowza over SRT 有效 |
返回数据
{
"result": 0
}
属性 | 说明 |
---|---|
result | 返回状态。 0:开始测试 1:操作重复 -9:系统忙 返回其它值请参考 API 状态码 |
测试过程状态
通过 get-status 接口可以获取到 living-test 信息,如下:
"living-test": {
"result": 27,
"upload-bps": 0,
"percent": 0,
"net": 0,
"client-id": ""
}
属性 | 说明 |
---|---|
result | 操作状态。 27:初始状态 5:操作取消 2:测试中状态 0:操作成功 返回其它值请参考 API 状态码 |
percent | 测试进度:20 表示 20% |
upload-bps | 上传速度 |
net | 网络类型 |
client-id | 保留属性 |
进行测试后,需要调用 clear-test-server 接口将测试状态重置为初始状态(27)。