添加 RTMP 直播推流
1.接口描述
接口说明:添加 RTMP 直播推流配置。
请求方式:
- 固件版本 V2.6.0 及以上:POST [ip]/mwapi/V2.0/stream/add-rtmp
- 固件版本 V2.5.0 及以下:POST [ip]/mwapi/add-rtmp
管理员权限 | 登录认证 |
---|---|
否 | 是 |
2.输入参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
type | 是 | Int | 推流类型 1:RTMP |
name | 是 | String | 推流服务器名称 |
url | 是 | String | 推流地址 |
streamKey | 是 | 推流秘钥 | |
authentication | 是 | Int | 是否需要鉴权 true:是;false:否 |
userName | 否 | String | 用户名,仅在需要鉴权时生效 |
password | 否 | String | 密码,仅在需要鉴权时生效 |
autoSwitch | 是 | Int | 是否配置为自动推流,可通过按键启动其开始直播推流 true:是;false:否 |
encoder | 是 | EncoderData | 编码配置参数 |
EncoderData
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
codeType | 是 | Int | 编码类型 0:H.264 |
encodingMode | 是 | Int | 码率模式 0:VBR;1:CBR |
videoBitrate | 是 | Int | 视频编码位率,单位 Kbps |
profile | 是 | Int | 编码档次 0:Baseline;1:Main Profile;2:High Profile |
audioBitrate | 是 | Int | 音频编码参数 48:48Khz,aac,48bps 64:48Khz,aac,64bps 96:48Khz,aac,96bps 128:48Khz,aac,128bps 192:48Khz,aac,192bps 256:48Khz,aac,256bps |
keyframeInterval | 是 | Int | 关键帧间隔,单位:秒 |
duration | 是 | Int | 视频帧率 166666:60 FPS;333333:30 FPS |
resolution | 是 | Int | 视频分辨率 1920x1080:1080p; 1280x720:720p |
3.输出参数
参数名称 | 类型 | 描述 |
---|---|---|
status | Int | 状态码 |
message | String | 状态描述 |
4.示例
添加 RTMP 直播推流配置。
输入示例
{
"type": 1,
"name": "RTMP Server (2)",
"url": "10.10.4.7/live",
"streamKey": "123",
"authentication": true,
"userName": "user",
"password": "123",
"autoSwitch": true,
"encoder": {
"codeType": 0,
"encodingMode": 1,
"videoBitrate": 2048,
"profile": 0,
"audioBitrate": 128,
"keyframeInterval": 2,
"duration": 166666,
"resolution": "1920x1080"
}
}
输出示例
{
"message": "success",
"status": 0
}
5.错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 定义 | 说明 |
---|---|---|
7 | MW_STATUS_INVALID_ARG | 参数缺失 |
1001 | MW_STATUS_SAME_NAME | 已存在同名配置 |
1002 | MW_STATUS_AUTO_LIMIT | 自动推流任务数量超限 |