开始码流转发 - 司空云端互联

请求参数

Header 参数

X-Organization-Key

string

组织密钥

必需

默认值:

Body 参数application/json

region

string

必需

创建 Converter 的区域，请保证设置的region 与你的 CDN 源站在同一个区域。目前支持以下区域： cn：中国大陆 ap：除中国大陆以外的亚洲区域 na：北美 eu：欧洲

converter_name

string

必需

运行中的转码器名称，此名称不能重复，否则会报213025错误，同时sn/camera/rtmp_url三个参数也不能和已创建且生效中的转码器相同，否则会报21328错误

sn

string

必需

码流源设备的sn序列号，如机场设备SN或者飞机设备SN

camera

string

必需

格式: {{type}}-{{subtype}}-{{gimbalindex}}(165-0-7) 参考：https://developer.dji.com/doc/cloud-api-tutorial/cn/overview/product-support.html

video

string

必需

固定填("normal-0")

idle_timeout

integer

可选

废弃 (不再推荐使用)，Converter 处于空闲状态的最大时长（秒）。空闲是指直播源下线，比如机场关机或者飞行器与机场断开连接。当 Converter 处于空闲状态时长大于 idleTimeout，Converter 自动销毁，推流停止。取值范围为 [5,300]。默认值为 300。

region_hint_ip

string

可选

CDN源站IP地址，必须为有效的IPV4地址。该参数可以保障RTMP流的稳定性

video_quality

integer

可选

{"0":"自适应","1":"流畅","2":"标清","3":"高清","4":"超清"}

bypass_option

object

可选

url

string

RTMP地址（不拼接）

可选

如果填写此url，则会覆盖rtmp_url的配置。此url需以"rtmp://"开头，为完整转推地址。此地址不会被拼接其他字段。

rtmp_url

string

RTMP地址（拼接）

可选

此rtmp_url需以"rtmp://"开头，会被拼接上path作为转推地址。例如，设置"rtmp_url"为"rtmp://xxx"，实际转推地址为"rtmp://xxx/{{device_sn}}_{{camera_id}}"。
如果不填写rtmp_url，则必须在司空2的组织管理页面配置RTMP Server，否则接口将报错。

示例

{
  "region": "cn",
  "converter_name": "test",
  "sn": "6QCD0000000000",
  "camera": "165-0-7",
  "video": "normal-0",
  "idle_timeout": 500,
  "video_quality": 0,
  "bypass_option": {
    "url": "rtmp://xx.xx.xx"
  },
  "rtmp_url": "rtmp://xx.xx.xx"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/manage/api/v1.0/stream-converters' \
--header 'X-Organization-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "region": "cn",
    "converter_name": "test",
    "sn": "6QCD0000000000",
    "camera": "165-0-7",
    "video": "normal-0",
    "idle_timeout": 500,
    "video_quality": 0,
    "bypass_option": {
        "url": "rtmp://xx.xx.xx"
    },
    "rtmp_url": "rtmp://xx.xx.xx"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

code

integer

必需

message

string

必需

data

object

必需

converter_id

string

转码器ID

必需

create_ts

integer

必需

创建 Converter 时的 Unix 时间戳（秒）

update_ts

integer

必需

最近一次更新 Converter 配置时的 Unix 时间戳（秒）

converter_state

string

必需

Converter 的运行状态： connecting: 正在连接声网推流服务器和 CDN 服务器。 running: 正在进行推流。 failed: 推流失败。

示例

{
  "code": 0,
  "message": "OK",
  "data": {
    "code": 0,
    "message": "OK",
    "data": {
      "converter_id": "160FDCB4E94171AB9F7A86A5F5B1C990",
      "create_ts": 1704167612,
      "update_ts": 1704167612,
      "converter_state": "running"
    },
    "converter_id": "160FDCB4E94171AB9F7A86A5F5B1C990",
    "create_ts": 1704167612,
    "update_ts": 1704167612,
    "converter_state": "running"
  }
}

🟠401未授权

🟠404记录不存在