Livestreams

Livestreams allow content creators and broadcasters to engage directly with viewers, offering immediate interaction and feedback. Live streaming is vital for events, announcements, educational sessions, and entertainment, providing a platform for instantaneous communication and content delivery.

With robust tools to manage, monitor, and analyze Livestreams, our system ensures that live content is both high-quality and highly accessible, meeting the demands of diverse audiences and use cases.

Running a live stream requires a sequence of API requests, including create, start, publish, and finish. Please consult our developer documentation for a detailed tutorial on live streaming.

📄️ List livestreams

Returns all `Livestream`s.

📄️ Create livestream

Registers and configures a new `Livestream`.

📄️ Start livestream

Starts a `Livestream` and activates the live ingest.

📄️ Publish a livestream

Publishes a `Livestream` only if an active ingest is being delivered. It changes the status of the `Livestream` to `live` and updates the start timestamp of the video source to the publishing time.

📄️ Stop a livestream

Finishes a published `Livestream`, which updates the playlist URL and triggers the live-to-VOD conversion. When the live-to-VOD conversion is finished, a `Media` asset will be created.

📄️ Get livestream

Loads all details of a `Livestream`, including `inputs` and `playouts`.

📄️ Update livestream

Updates editable properties of a `Livestream`.

📄️ Delete livestream

Deletes the `Livestream` and all recorded artifacts. A `Livestream` that is currently being converted from live to VOD cannot be deleted. A `Livestream` in status `finished` was converted to a `Media` asset and cannot be deleted with this endpoint—use [deleteMedia](#tag/Media/operation/deleteMedia) with the `permanent` option to delete the finished `Livestream` and the derived `Media` asset.

📄️ Get livestream stats overview

Retrieves the current number of RTMP and HLS connections for a `Livestream`. The `primary` section contains statistics for the main `Livestream`, and the `secondary` section contains statistics for the backup `Livestream`. The `sum` section contains the aggregation of both. Call repeatedly to build statistics over time. A typical use case is displaying the current number of watching users from `sum.hlsConnections`.

📄️ Get livestream stats

Retrieves detailed `Livestream` statistics for a specific live streaming instance. Use instance `primary` for the main `Livestream` or `secondary` for the optional backup `Livestream`. Provides the complete history of statistical samples for the lifetime of the `Livestream`, sorted in descending order by createdAtUtc, ensuring the first page always contains the most recent samples. Repeatedly requesting this page supports the continuous collection of live statistics over time.