Livestream/Livestream Push
Livestream

Start Livestream

After enabling the device livestream feature, the device automatically pushes streams to the media server and returns the authentication info of the corresponding livestream provider. You need to integrate the provider's SDK (e.g., Volcano Engine, Agora, SRS, etc.) and call its API with the authentication info to pull the livestream.

:::warning[] Note: FlightHub 2 dynamically selects livestream providers as mutual backups. Reliance on this API requires integrating multiple providers' SDKs; otherwise, you may encounter unsupported cases. :::

:::tip[] Tips:

  • camera_index can be obtained from data.list.drone.camera_list in the Get Device List Under Organization interface.
  • After 5 minutes with no viewers pulling the stream, livestream push will stop. :::
post/openapi/v2.0/live-stream/start

Request

  • Base URL
    (relative, and it does not resolve against the document’s source URL)
  • URL
    /openapi/v2.0/live-stream/start
  • Auth
    none required

Headers

X-User-Tokenstring required
X-Project-Uuidstring required

Project Number

X-Request-Idstring

Request Unique Identifier

X-Languagestring

Language

Request body

snstring required
camera_indexstring required
video_expireinteger required

Livestream push token validity; livestream will be terminated after this period

quality_type'adaptive' | 'smooth' | 'ultra_high_definition' required

Livestream Quality

Response

codeinteger

Non-zero Indicates Exception

messagestring

Message Prompt

Changes

No recorded changes to this operation across all 1 revision of this API.