创建码流转发器

开发中

POST

https://es-flight-api-cn.djigate.com/openapi/v0.1/live-stream/converter

创建码流转发器，调用此接口将在司空 2 上创建和存储码流转发器，可调用获取码流转发器列表获取已创建的码流转发器，然后调用开启/关闭码流转发器开启码流转发功能。

最多创建 20个码流转发器。

请求参数

Authorization

在 header 添加参数

X-User-Token

示例：

X-User-Token: ********************

Header 参数

X-Request-Id

string <uuid>

请求唯一标识

必需

默认值:

X-Language

enum<string>

可选

枚举值:

zhen

默认值:

X-Project-Uuid

string

项目编号

可选

默认值:

X-User-Token

string

必需

X-User-Token

默认值:

Body 参数application/json

converter_name

string

必需

运行中的转码器名称，此名称不能重复，同时sn/camera_index/rtmp_url三个参数不能和已创建且生效中的转码器相同。

string

必需

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

camera_index

string

必需

相机索引，此参数可通过获取设备列表中data.list.drone.camera_list.camera_index传入。

schema

string

参数

必需

schema_option

参数选项

必需

Any of

schema_option_rmtp

schema_option_gb28181

url

string

RTMP服务器地址

可选

当schema为rtmp时，必填url（推流地址）

示例

{
  "converter_name": "my_converter",
  "sn": "4SEDL9F0011RY2",
  "camera_index": "165-0-7",
  "schema": "rtmp",
  "schema_option": {
    "url": "rtmp://live.restream.io/live/re_7734128_5da13a862901ce2d4084"
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://es-flight-api-cn.djigate.com/openapi/v0.1/live-stream/converter' \
--header 'X-Request-Id;' \
--header 'X-Language: zh' \
--header 'X-Project-Uuid: {{X-Project-Uuid}}' \
--header 'Content-Type: application/json' \
--header 'X-User-Token;' \
--data-raw '{
    "converter_name": "my_converter",
    "sn": "4SEDL9F0011RY2",
    "camera_index": "165-0-7",
    "schema": "rtmp",
    "schema_option": {
        "url": "rtmp://live.restream.io/live/re_7734128_5da13a862901ce2d4084"
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

非0代表异常

必需

message

string

消息通知

必需

data

object

必需

converter_id

string

必需

转码器ID，转码器的唯一标识。

示例

{
  "code": 0,
  "message": "",
  "data": {
    "converter_id": "acfb0e79-87a7-4d61-898e-2f32792996e5"
  }
}

修改于 2025-02-08 04:16:22

码流转发错误码

开启/关闭码流转发器