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 in a channel

Retrieve all livestreams of channel

📄️ List livestreams

This endpoint returns all `Livestreams`.

📄️ Create a livestream

Registers and configures a new `Livestream`.

📄️ Start a livestream

Starts a `Livestream` and activates the live ingest.

📄️ Publish a livestream

Publishing a `Livestream` is only possible if an active ingest is delivered. It will change the status of the `Livestream` to `live` and will update the start timestamp of the video source to the publishing time.

📄️ Stop a livestream

Finishing a published `Livestream` will update the playlist url and trigger the live-to-vod conversion. When the live-to-vod conversion is finished, a `Media` asset will be created.

📄️ Retrieve a livestream

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

📄️ Update a livestream

Update editable properties of a `Livestream`.

📄️ Delete a livestream

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

📄️ Retrieve livestream statistics overview

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

📄️ Retrieve livestream statistics

Retrieve detailed `Livestream` statistics of a specific live streaming instance. Use instance `primary` to get statistics for the main `Livestream` or instance `secondary` to get statistics of the optional backup `Livestream`. This endpoint provides the complete history of statistical samples for the lifetime of the `Livestream`. The samples are sorted in descending order by createdAtUtc, ensuring that the first page always contains the most recent samples. Repeatedly requesting this page allows for the continuous collection of live statistics over time.