NEW FlightHub 2 OpenAPI V1.0
  1. Bypass Streaming
NEW FlightHub 2 OpenAPI V1.0
  • Root Directory
    • authentication
      • Authentication Tutorial
    • System Service
      • Query FlightHub 2 system status
    • Organize Projects
      • Organize Project Tutorial
      • Get the list of projects under the organization
      • Get the list of devices under the organization
      • Obtain the list of devices under the project
      • Obtain storage upload credentials for the project
      • Add personnel to the project
    • Device Management
      • Device Management Tutorial
      • Device Model Retrieval
      • HMS Information Retrieval
      • Real-time control command distribution
      • Dock camera switch
      • Aircraft Lens Switching
      • Control acquisition
      • Release control
      • Video transmission clarity settings
      • Custom Network RTK Calibration
    • Livestream Management
      • Livestream Management Tutorial
      • Livestream Push
        • Start livestream
      • Bypass Streaming
        • Stream forwarding error code
        • Create Stream Forwarder
          POST
        • Enable/Disable stream forwarder
          PUT
        • Get stream transcoder list
          GET
        • Delete stream forwarder
          DELETE
    • Task Management
      • Task Management Tutorial
      • Create Flight Task
      • Updated flight task status
      • Obtain flight task list
      • Obtain media resources generated by the Flight task
      • Obtain Flight task trajectory information
      • Obtain Flight task information
    • Flight Route Management
      • Flight 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
      • Get Model Details
      • Model reconstruction
    • Annotation Management
      • Annotation Management Tutorial
      • Create map annotation
  1. Bypass Streaming

Enable/Disable stream forwarder

Developing
PUT
/openapi/v0.1/live-stream/converter/{converter_id}
Enable and disable the stream forwarder. After creating the stream forwarder, you can call this interface to enable it. Once enabled, the device will automatically forward streams when it comes online.
1.
When you need to create a transcoder, use this interface without adding the converter_id parameter, and also do not add the auto_push_stream parameter, to create a transcoder.
2.
After creating the transcoder, you can call this interface again, which will trigger automatic streaming. At this point, you need to add the converter_id parameter, with the value being the converter_id returned upon successful transcoder creation, and set auto_push_stream to true to enable stream forwarding.

Request

Path Params
converter_id
string 
required
Stream Forwarder ID
Header Params
X-Request-Id
string <uuid>
required
Request Unique Identifier
X-Language
enum<string> 
optional
Allowed values:
zhen
Default:
zh
X-Project-Uuid
string 
optional
Project Number
Default:
{{X-Project-Uuid}}
Body Params application/json
auto_push_stream
boolean 
required
true: Enable auto-forwarding; false: Turn off auto forwarding;
Example
{
    "auto_push_stream": true
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/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' \
--data-raw '{
    "auto_push_stream": true
}'

Responses

🟢200Success
application/json
Body
code
integer 
required
Non-zero indicates an exception
message
string 
required
Message Notification
Example
{
    "code": 0,
    "message": "OK"
}
Previous
Create Stream Forwarder
Next
Get stream transcoder list
Built with