1. Livestream
FlightHub 2 OpenAPI V2.0 (Public Cloud)
  • FlightHub 2 OpenAPI V2.0
    • Usage Guide
      • Authentication Tutorial
      • Error Code
    • Common
      • Common Tutorial
      • System Health & Access
        • Query FlightHub 2 System Status
        • Query System Health Status
        • Get Project Storage Upload STS Credentials
      • Security
        • SN Decrypt Echo
    • Organization & Project
      • Organization & Project Tutorial
      • Members & Permissions Management
        • Project Members
          • Add Members to Project
          • Get Project User List
          • Get Project Independent Member List
        • Organization Members
          • Get Organization User List
          • Get Current User's Organization Role
        • Roles & Permissions
          • Get Role List
          • Get Permission List
          • Get Role Permissions
      • Project Management
        • Project Collaboration
          • Get Project Quick-Join Information
        • Project Configuration
          • Get Auto Recording Config
        • Project Basic Info
          • Get Project List Under Organization
      • Organization Management
        • Organization Basic Info
          • Get Organization List
          • Get Organization Details
    • Device Management
      • Device Management Tutorial
      • Device List Management
        • Device List (Organization Scope)
          • Get Device List Under Organization
        • Device List (Project Scope)
          • Get Project Device Details
          • Get Project Device List
          • Update Device's Bound Project
          • Get Project Device History Topology
      • Device Configuration
        • Calibration & Positioning
          • Custom Network RTK Calibration
        • Pairing Management
          • Query Relay Pairing Result
          • Make Device Enter Relay Pairing Mode
      • Get HMS Information
      • Acquire Control Permission
      • Release Control Permission
      • Live View Quality Settings
      • Get Thing Model
    • Real-time Control
      • Real-time Control Tutorial
      • Control Permission Management
        • Device Control Permission
          • Query Device Control Status (Organization Device )
          • Query Device Control Status (Project Device)
        • Cloud Control Permission
          • Get Cloud Control Status
      • Payload Control
        • Camera Control
          • Aircraft Lens Switch
          • Dock Camera Switch
      • Flight Control Commands
        • General Real-time Commands
          • Query Device Command Execution
          • Send Real-time Control Command
      • Takeoff/Landing Coordination
        • Query Takeoff/Landing Coordination Area (TCA) Real-time Status
    • Livestream
      • Livestream Tutorial
      • Query Recording Tasks
        • Get Recording Tasks for Project Device
        • Get Recording Tasks for Organization Device
      • Livestream Sharing & Forwarding
        • Bypass Streaming
          • Create Stream Converter
          • Get Stream Converter List
          • Delete Stream Converter
          • Enable/Disable Stream Converter
        • Livestream Sharing
          • Get Device Livestream Share Details
          • Get Device Livestream Share List
      • Livestream Push
        • Start Livestream
    • Flight Task
      • Flight Task Tutorial
      • AI Flight Alerts
        • Query Flight Task Alert Records
        • Query AI Alert Records
      • Task Creation
        • Check Whether Flight Task Meets Dispatch Conditions
        • Create Flight Task
        • Resumable Immediate Task
      • Task Query
        • Get Recent Flight Task List
        • Get Default Task Name on Creation
        • Get Flight Task List
        • Get Flight Task Track Information
        • Get Wayline Task Details
        • Get Flight Task Information
        • Get Flight Task List
        • Get Media Resources from Flight Task
      • Flight Record
        • Get Export History
        • Get Single Flight Record Download Link
        • Get Wayline Task Operation Log
      • Task Update
        • Update Flight Task Status
    • Wayline
      • Wayline Tutorial
      • Wayline Management
        • Wayline Query
          • Get Wayline Details
          • Get Wayline List Under Project
        • Wayline Upload
          • Wayline Upload Completion Notification
    • Map
      • Map Tutorial
      • Map Annotation
        • Annotation Creation
          • Create Map Annotation
        • Annotation Update
          • Annotation Update
        • Annotation Deletion
          • Annotation Deletion
      • Airspace Safety
        • Terrain Obstacles
          • Get Offline Map URL
          • Get Offline Map Details
        • Custom Flight Area
          • Get Flight Area List (Workspace Scope)
          • Get Flight Area File URL
          • Get Flight Area List (Project Scope)
      • Airspace Warning
        • Airspace Warning
    • Model Reconstruction
      • Model Reconstruction Tutorial
      • Get Project Model List
      • Model Reconstruction
      • Get Model Details
      • Get Model File Download Link
    • Open Modeling
      • Open Modeling Tutorial
      • Start Reconstruction Task
      • Get Model Details
      • Delete Model
      • Stop Reconstruction Task
      • Get Resource Details
      • Delete Resource
      • Get Upload Credentials
      • Upload Callback
      • Get In-Progress Reconstruction Model Details
  1. Livestream

Livestream Tutorial

Overview#

The Livestream module covers two scenarios: "Real-time Livestream Control" and "Livestream Sharing & Forwarding". It provides capabilities to query device real-time livestream status, maintain the stream converter list, and query livestream share links.
"Real-time Livestream Control" is used to query a device's current livestream / recording status (project scope, organization scope), commonly used for ops dashboards and project pages.
"Livestream Sharing & Forwarding" is used to query and manage livestream share links, as well as query and delete created stream converters (bypass streaming).
Creation and start/stop actions of bypass streaming currently reside in the "Livestream Management" module; this module covers only query and deletion.

Interface Usage Flow#

Real-time livestream status query:
Livestream share query:
Bypass streaming (stream converter) maintenance:
Call steps:
1.
To check whether a device is currently livestreaming or recording: at the project scope, call Get Recording Tasks for Project Device (GET /openapi/v2.0/devices/{sn}/streams); at the organization scope, call Get Recording Tasks for Organization Device (GET /openapi/v2.0/organizations/{uuid}/devices/{sn}/streams).
2.
To manage livestream share links within a project: call Get Device Livestream Share List (GET /openapi/v2.0/live-shares) to obtain the list, and Get Device Livestream Share Details (GET /openapi/v2.0/live-shares/{sn}) to obtain the latest share details for the specified device.
3.
To maintain stream converters for bypass streaming: call Get Stream Converter List (GET /openapi/v2.0/stream-converters) to query existing converters and their streaming parameters and running status, and Delete Stream Converter (DELETE /openapi/v2.0/stream-converters/{converter_id}) to delete converters no longer in use.

Create Stream Converter (Livestream Management)#

Overview#

The Livestream Management module supports livestream push and bypass streaming.
Livestream push enables real-time livestreaming of the aircraft's stream to users.
Bypass streaming forwards the aircraft's stream to a third-party cloud platform.

Interface Usage Flow#

Livestream push sequence diagram:



Bypass streaming sequence diagram:

Start Livestream (Livestream Push)#

Livestream Push Tutorial#

Overview#

The Livestream Push module is used to start the real-time livestream of the aircraft camera. Once started, the device automatically pushes the stream to the media server, and the interface returns the pull authentication info of the corresponding livestream provider. The third-party cloud needs to integrate the provider's SDK (e.g., Volcano Engine, Agora, SRS, etc.) and use this authentication info to pull the livestream.
FlightHub 2 dynamically selects livestream providers as mutual backups. It is recommended to integrate multiple providers' SDKs at the same time; otherwise, you may encounter unsupported providers.
camera_index info can be obtained from data.list.drone.camera_list in Get Project Device List (GET /openapi/v2.0/project/device).
When there are no viewers pulling the stream for 5 minutes, FlightHub 2 automatically stops the livestream push.

Interface Usage Flow#

Call steps:
1.
Use Get Project Device List (GET /openapi/v2.0/project/device) to obtain the target aircraft's sn and camera_index.
2.
Call Start Livestream (POST /openapi/v2.0/live-stream/start), passing sn, camera_index, video_quality, and other parameters to start the livestream.
3.
Take the provider type and authentication info from the response and integrate the corresponding provider's SDK to complete stream pulling and playback.
Modified at 2026-05-26 14:32:16
Previous
Query Takeoff/Landing Coordination Area (TCA) Real-time Status
Next
Get Recording Tasks for Project Device
Built with