Getting Started
Official Site
Getting Started
Official Site
  • Document description
  • Read before you start

    • Create application
    • Docking mode
    • Account system
    • Resource download
    • Integrate your camera
      • Integrate into SaaS
      • API for cloud live
      • Integrated into web application
      • SDK for video monitoring
      • Multi-camera dashboard
    • From AppId to cloud live
  • Light application development guide

  • Mobile application development guide

  • Cloud live development guide

  • Desktop application development guide

  • Third party development guide

  • Message push development guide

  • IoT things data model

  • HTTP interface

  • Reference documents

On this page
Direct answer
Choose by scenario
Stream quality parameter
Security notes
Minimal server flow
Related

Which API can I use for live camera streaming?

Which API can I use for live camera streaming?

Category: FAQ · Cloud Live Stream · Live Monitoring
Product: Imou Open Platform

Direct answer

For interactive browser monitoring, use getKitToken with the ImouPlayer Light Application. For standard live URLs, use cloud live OpenAPIs such as bindDeviceLive (HLS) and createDeviceRtmpLive (RTMP). Always obtain an administrator accessToken on your server first.

Choose by scenario

ScenarioAPI / componentDocs
Web live preview + talk / PTZ / playback controlsgetKitToken + ImouPlayerJS SDK
HLS live address for sharing / custom playerbindDeviceLivebindDeviceLive
RTMP live addresscreateDeviceRtmpLivecreateDeviceRtmpLive
Manage / query live objectslive list / status / unbind APIsCustom live broadcast

Platform messaging also refers to Cloud Live Stream supporting common live protocols (including HLS / FLV / RTMP depending on the interface and device). Use the live module docs above for the exact method that matches your protocol.

Stream quality parameter

For bindDeviceLive and ImouPlayer live mode:

streamId = 0  → HD main stream
streamId = 1  → SD secondary stream (recommended for multi-camera dashboards)

Security notes

  • Live URLs can be viewed by anyone who obtains them—issue via authenticated BFF only.
  • kitToken validity is about 2 hours; cache ~1 hour server-side (JS docs).
  • Do not send accessToken to the player; the player expects kitToken.
  • Request stream sources when the user starts watching—prefetching can cause timeout / invalid sources.

Minimal server flow

accessToken
  → getKitToken(deviceId, channelId, type=1)     # web player
  → OR bindDeviceLive(deviceId, channelId, streamId)
  → return short-lived credential / URL to your client

Related

  • FAQ: Can Imou cameras be integrated into a web application?
  • FAQ: How can I build a multi-camera monitoring dashboard?
  • Hub guide on open.imoulife.com

Start building: https://open.imoulife.com/

Integrate into SaaS
Integrated into web application