全新司空 2 OpenAPI V1.0(openapi-translation)
  1. Stream forwarding (only supports private cloud)
全新司空 2 OpenAPI V1.0(openapi-translation)
  • Root Directory
    • Authentication and Authorization
      • Authentication Authorization Tutorial
    • System Services
      • FlightHub 2 Public Cloud Access Point Information
      • Query FlightHub 2 System Status
    • Organization Projects
      • Organization Project Tutorial
      • Get the List of Projects Under the Organization
      • Get the List of Devices Under the Organization
      • Get the List of Devices Under the Project
      • Obtain the storage upload credentials for the project
      • Add Members to the Project
    • Livestream Management
      • Live streaming management tutorial
      • Push Livestream
        • Enable Livestream
      • Stream forwarding (only supports private cloud)
        • Stream Forwarding Error Code
        • Create Stream Forwarder
          POST
        • Enable/Disable Stream Forwarder
          PUT
    • Annotation Management
      • Annotation management tutorial
      • Create Map Annotations
    • Task Management
      • Task management tutorial
      • Create Flight Tasks
      • Update Flight Task Status
      • Get the Flight Task List
      • Get Media Files Generated by the Flight Task
      • Get Flight Trajectory Information
    • Device Management
      • Device management tutorial
      • Get Device Properties
      • Get HMS Information
      • Switch Dock Cameras
      • Switch Aircraft Cameras
      • Custom Network RTK Calibration
      • Specify device to enter relay frequency pairing mode (only supports private cloud and relay)
      • Query relay frequency pairing result (only supports private cloud and relay)
    • Route Management
      • Route management tutorial
      • Flight Route Upload Completion Notification
      • Get the List of Flight Routes Under the Project
      • Get Flight Route Details
    • Model Management
      • Model management tutorial
      • Model reconstruction coordinate system
      • Get the List of Models Under the Project
      • Mapping
      • Get the Model Details
      • Get Model File Download URL
    • Open modeling
      • Open modeling tutorial
      • Model Reconstruction Error Code
      • Algorithm parameter introduction
      • Get upload credential
      • Upload callback
      • Get resource details
      • Delete resource
      • Start reconstruction task
      • Stop reconstruction task
      • Get the Model Details
      • Delete Models
  • Get the Stream Transcoder List
    GET
  • Send Real-Time Control Command
    POST
  • Delete Stream Forwarder
    DELETE
  • Acquire Control
    POST
  • Release Control
    DELETE
  • Video Transmission Quality Settings
    PUT
  • Get the Flight Task Information
    GET
  1. Stream forwarding (only supports private cloud)

Create Stream Forwarder

开发中
POST
/openapi/v0.1/live-stream/converter
Create stream forwarder, calling this interface will create and store stream forwarder on Sikong 2. You can call Obtain stream forwarder list to get the created stream forwarder, then call Enable/Disable stream forwarder to enable stream forwarding feature.
Create up to 20 stream forwarders.

请求参数

Authorization
在 header 添加参数
X-User-Token
示例:
X-User-Token: ********************
Header 参数

Body 参数application/json

示例
{
    "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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/openapi/v0.1/live-stream/converter' \
--header 'X-Request-Id: {{$string.uuid}}' \
--header 'X-Language: zh' \
--header 'X-Project-Uuid: {{X-Project-Uuid}}' \
--header 'X-User-Token: <api-key>' \
--header 'Content-Type: application/json' \
--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"
    }
}'

返回响应

🟢200Success
application/json
Body

示例
{
    "code": 0,
    "message": "",
    "data": {
        "converter_id": "acfb0e79-87a7-4d61-898e-2f32792996e5"
    }
}
修改于 2025-04-29 08:42:42
上一页
Stream Forwarding Error Code
下一页
Enable/Disable Stream Forwarder
Built with