set-channel-sink接口
修改输出视频流。
仅管理员有权限。
接口原型
| 协议 | HTTP/HTTPS POST |
| URL | ip[:port]/sc_cloud/channel/set-sink |
| 数据格式 | 请求消息：Content-Type: application/json 响应消息：Content-Type: application/json |
请求Cookies
| 名称 | 描述 |
|---|---|
| mwcloud-sid | 用于标识当前登录的字符串 |
| mwcloud-uid | 当前登录用户名 |
Request Body
| 参数 | 描述 |
|---|---|
| id | 协议流ID。执行add-channel接口生成的。可以通过get-channels接口查询到。 |
| protocol | 协议流详细信息。 |
protocol
| 参数 | 描述 |
|---|---|
| name | 输出视频流名称。 本接口不支持修改此项，可以通过set-channel-sink-name接口修改。 |
| is-enable | 输出视频流是否启动。 本接口不支持修改此项，可以通过set-channel-sink-enable接口开启/关闭。 |
| type | 协议流类型。取值如下：
|
| rtmp | type=1时，Request Body参见：RTMP/RTMPS示例。 |
| srt | type=2时，Request Body参见：SRT Caller示例。 type=3时，Request Body参见：SRT Listener示例。 |
rtmp
| 参数 | 描述 |
|---|---|
| type | 常量值：1。 |
| url | 服务器地址。 |
| key | 流密钥。 |
| is-auth | 认证状态。
|
| user | 用户名。 |
| passwd | 密码。 |
srt
| 参数 | 描述 |
|---|---|
| ip | ip地址或域名。type为SRT Listener时，ip为常量值："0.0.0.0"。 |
| port | 端口号，取值范围是1~65535。 |
| latency | 延迟时间。取值范围是20ms~8000ms，默认为120ms。 |
| bandwidth | SRT开销占总带宽的比例。取值范围是5%~100%，默认值为25%。 仅SRT Caller类型有此属性。 |
| stream-id | 流ID。 仅SRT Caller类型有此属性。 取值范围是0~256个字符。必须与发送端的Stream ID一致。 |
| enc-type | 加密类型，默认不加密。取值对应关系如下：
|
| enc-pass | 加密密码。enc-type取值不为0时，需要输入10~79位字符的密码。 |
请求示例
- RTMP/RTMPS实例：
POST /sc_cloud/channel/set-sink HTTP/1.1
Accept: application/json, text/plain, */*
Content-Type: application/json;charset=utf-8
Content-Length: 212
Cookie: mwcloud-sid=OCXWUMGEYPGIAWWOETYXPNMVHDZIAZJP; mwcloud-uid=Admin;
{
"id": 13,
"protocol": {
"id": 24,
"name": "output-rtmp-new",
"is-enable": 1,
"type": 1,
"rtmp": {
"type": 1,
"url": "rtmp://10.2.3.63/live",
"key": "addkey",
"is-auth": 1,
"user": "test",
"passwd": "12345678",
"name": "output-rtmp"
}
}
}
- SRT Caller实例：
POST /sc_cloud/channel/set-sink HTTP/1.1
Accept: application/json, text/plain, */*
Content-Type: application/json;charset=utf-8
Content-Length: 245
Cookie: mwcloud-sid=OCXWUMGEYPGIAWWOETYXPNMVHDZIAZJP; mwcloud-uid=Admin;
{
"id": 13,
"protocol": {
"id": 25,
"name": "output-srt caller",
"is-enable": 1,
"type": 2,
"srt": {
"ip": "10.0.2.3",
"port": 678,
"latency": 120,
"enc-type": 24,
"enc-pass": "passphrase",
"stream-id": "modify caller",
"bandwidth": 25,
"name": "output-srt caller-new"
}
}
}
- SRT Listener实例：
POST /sc_cloud/channel/set-sink HTTP/1.1
Accept: application/json, text/plain, */*
Content-Type: application/json;charset=utf-8
Content-Length: 206
Cookie: mwcloud-sid=OCXWUMGEYPGIAWWOETYXPNMVHDZIAZJP; mwcloud-uid=Admin;
{
"id": 13,
"protocol": {
"id": 26,
"name": "output-srt listener",
"is-enable": 1,
"type": 3,
"srt": {
"ip": "0.0.0.0",
"port": 666,
"latency": 120,
"enc-type": 16,
"enc-pass": "fsfsfffffff",
"name": "output-srt listener-new"
}
}
}
响应参数
Response Header
| 参数 | 描述 |
|---|---|
| Content-Type | 取值为：'application/json; charset=UTF-8' |
Response Body
| 参数 | 描述 |
|---|---|
| result | 返回码。
|
| method | 方法名：set-channel-sink。 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 40
Connection: keep-alive
{
"method": "set-channel-sink",
"result": 0
}