add-server 接口
修改于:V2.3
新增直播服务器,最多可同时录入16条直播配置。
配置相同的直播仅可录入一个:
- 自定义类型 RTMP 直播, URL 和 StreamKey 都相同时为同一配置
- 其它类型 RTMP 直播, StreamKey 相同时为同一配置
- RTSP 直播,端口号相同时为同一配置
- SRT Caller 直播,IP 地址、端口号和流 ID 相同时为同一配置
- SRT Listener 直播,端口号相同时为同一配置
- HLS 直播,主码流或次码流流名称相同时为同一配置
- TS over UDP 与 TS over RTP 直播,IP 地址与端口号相同时为同一配置
- NDI HX 直播,视频源名称相同时为同一配置
请求方式
GET http://ip/usapi?method=add-server&type=xxx&url=xxx&key=xxx&...
| 参数 | 说明 |
|---|---|
| method | 方法名称:add-server |
| type | 服务器类型 0: RTMP 1: Twitch 2: YouTube 3: Facebook 4: Wowza over RTMP 100: RTSP 120: SRT Caller 121: SRT ListenerP 122: Wowza over SRT 130: NDI HX 131: HLS 132: TS over UDP 133: TS over RTP 140: TVU ISS 143: YouTube HLS |
| 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 |
| RTSP直播参数 | |
| port | 端口号,默认为554 |
| max-connection | 客户端最大连接数 |
| is-auth | 认证状态 0: 无需认证 1: 需要认证,用户名和密码必填 |
| user | 用户名 |
| passwd | 密码 |
| is-main | 是否启用主码流 0: 不启用 1: 启用 |
| main-stream-name | 主码流名称,字符要求: 1、1 - 32 个字符 2、由 A-Z, a-z, 0-9, 空格 ._-+'[]() 组成,并且不能以空格开头或结束 |
| is-sub | 是否启用次码流 0: 不启用 1: 启用 |
| sub-stream-name | 次码流名称,字符要求: 1、1 - 32 个字符 2、由 A-Z, a-z, 0-9, 空格 ._-+'[]() 组成,并且不能以空格开头或结束 |
| is-audio | 是否启用音频 0: 不启用 1: 启用 |
| 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 | 选填 |
| mtu | 最大传输单元,有效值:232 ~ 1500 |
| conn-timeout | 连接超时时间,单位毫秒 |
| retry-duration | 等待重新连接时间,单位毫秒 |
| 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 有效 |
| SRT Listener直播参数 | |
| stream-index | 编码码流 0: 主码流 1: 次码流 |
| port | 端口号,默认为8000 |
| max-connection | 客户端最大连接数 |
| latency | 延迟时间,通过get-info 可以获取相关参数的取值范围 |
| bandwidth | 带宽限制,通过get-info 可以获取相关参数的取值范围 |
| aes | 加密方式 0: 不加密 16: AES-128加密 24: AES-192加密 32: AES-256加密 |
| ase-word | 加密字段 |
| mtu | 最大传输单元,有效值:232 ~ 1500 |
| audio-streams | 音频码流掩码值,若选择的音频码流为 n(n 取值范围 0~3),则 audio-streams |= (1 << n) |
| NDI HX直播参数 | |
| source-name | 视频源名称,默认为设备序列号 |
| group-name | 组名,默认为public |
| enable-discovery | 是否启用发现服务 |
| discovery-server | 发现服务器 IP 地址 |
| transport-mode | 传输模式,通过get-info 可以获取相关参数的取值范围;选择组播传输模式,组播相关设置必填 |
| mcast-addr | 组播地址 |
| mcast-mask | 组播掩码 |
| mcast-ttl | 生存时间,有效值:1 ~ 255 |
| enable-fail-over | 是否启用备用通道 |
| fail-over-ndi-name | 备用通道视频源名称 |
| fail-over-ip-addr | 备用通道 IP 地址 |
| enable-web-control | 是否显示 Web 控制 |
| audio | 音频码流 0: 音频码流1 1: 音频码流2 2: 音频码流3 3: 音频码流4 |
| HLS直播参数 | |
| stream-index | 编码码流 0: 主码流 1: 次码流 |
| stream-name | 码流名称,字符要求: 1、1 - 32 个字符 2、由 A-Z, a-z, 0-9, 空格 ._-+'[]() 组成,并且不能以空格开头或结束 |
| audio | 音频码流 0: 音频码流1 1: 音频码流2 2: 音频码流3 3: 音频码流4 |
| TS over UDP / TS over RTP直播参数 | |
| stream-index | 编码码流 0: 主码流 1: 次码流 |
| url | 服务器地址 |
| port | 端口号 |
| net-mode | 网络优先 0: 移动宽带优先 1: 有线网络优先 2: 无线网络优先 |
| audio | 音频码流 0: 音频码流1 1: 音频码流2 2: 音频码流3 3: 音频码流4 |
| is-custom-pid | 是否自定义 PID 0: 默认值 PID 1: 自定义 PID |
| pmt-pid | 节目映射 PID,取值范围 0x10~0x1FFE |
| pcr-pid | 节目时钟参考 PID,取值范围 0x10~0x1FFE |
| video-pid | 视频 PID,取值范围 0x10~0x1FFE |
| audio-pid | 音频 PID,取值范围 0x10~0x1FFE |
| TVU ISSP直播参数 | |
| port | 端口号,默认为6539 |
| stream-index | 编码码流 0: 主码流 1: 次码流 |
| audio | 音频码流 0: 音频码流1 1: 音频码流2 2: 音频码流3 3: 音频码流4 |
| YouTube HLS直播参数 | |
| 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 |
返回数据
{
"result": 0
}
| 属性 | 说明 |
|---|---|
| result | 返回状态,0:新增成功,返回其它值请参考 API 状态码 |