API reference
Stream Embed
Embedded player configuration for a live stream
Endpoints
| Method | Path | Operation |
|---|---|---|
| PUT | /streams/{stream_id}/embed/title |
Set embed title Sets the title shown in the embedded player. Requires a token with write access to the stream (CanWriteStreams). |
| PUT | /streams/{stream_id}/embed/color |
Set embed colour scheme Sets the accent colour of the embedded player. Returns 400 when no colour is supplied. Requires a token with write acces |
| PUT | /streams/{stream_id}/embed/channel_logo |
Save embed channel logo settings Configures the channel logo overlay: image, size, position, layout and click-through URL. Requires a token with write ac |
| GET | /streams/{stream_id}/embed/assets/cover_img |
Get embed cover image Returns the cover image currently attached to the stream embed. Read-only: this is the one embed route guarded by CanRea |
| PUT | /streams/{stream_id}/embed/assets/cover_img |
Set embed cover image Attaches an already-uploaded image as the player cover, shown before playback starts. Upload the file first with POST /s |
| DELETE | /streams/{stream_id}/embed/assets/cover_img |
Remove embed cover image Detaches the cover image. The underlying asset is not deleted. Requires a token with write access to the stream (CanWrit |
| POST | /streams/{stream_id}/embed/assets/upload_url |
Create embed asset upload URL Returns a signed URL for uploading an embed asset — a cover image, brand icon or caption image. Upload the bytes to the |
| PUT | /streams/{stream_id}/embed/offline_text |
Set embed offline text Sets the message shown in the player while the stream is offline. Pass alternateText=1 to set the secondary offline mess |
| PUT | /streams/{stream_id}/embed/offline_text_mode |
Toggle offline text mode Switches between the primary and alternate offline messages. Requires a token with write access to the stream (CanWriteS |
| PUT | /streams/{stream_id}/embed/autoplay |
Toggle embed autoplay Controls whether the embedded player starts playing automatically. Requires a token with write access to the stream (Can |
| PUT | /streams/{stream_id}/embed/abr |
Toggle adaptive bitrate Enables or disables adaptive bitrate streaming in the embedded player. Requires a token with write access to the stream |
| PUT | /streams/{stream_id}/embed/live_rewind |
Toggle live rewind Enables or disables rewinding within a live stream. Requires a token with write access to the stream (CanWriteStreams). |
| PUT | /streams/{stream_id}/embed/set_uninterrupted_mode |
Toggle uninterrupted mode When enabled, the player keeps the session going across short source interruptions instead of dropping to the offline st |
| PUT | /streams/{stream_id}/embed/premier |
Toggle premiere mode Enables premiere mode, which holds viewers on a countdown until the scheduled start. Requires a token with write access |
| PUT | /streams/{stream_id}/embed/premier/text |
Set premiere text Sets the message shown during the premiere countdown. Requires a token with write access to the stream (CanWriteStreams) |
| PUT | /streams/{stream_id}/embed/set_viewers_counter |
Toggle the viewer counter Controls visibility of the live viewer count in the player. Requires a token with write access to the stream (CanWriteSt |
| PUT | /streams/{stream_id}/embed/set_pause_control |
Toggle the pause control Controls whether viewers can pause playback. Requires a token with write access to the stream (CanWriteStreams). |
| PUT | /streams/{stream_id}/embed/toggle_live_badge |
Toggle the live badge Controls visibility of the LIVE badge in the player. Requires a token with write access to the stream (CanWriteStreams). |
| PUT | /streams/{stream_id}/embed/plugins |
Set embed analytics plugins Configures third-party analytics integrations for the embedded player. Requires a token with write access to the stream |
| PUT | /streams/{stream_id}/embed/chat_config |
Set embed chat configuration Configures the chat panel shown alongside the embedded player. Requires a token with write access to the stream (CanWrit |
| PUT | /streams/{stream_id}/embed/password |
Set embed password Password-protects the embed. Send an empty string to remove the password. Requires a token with write access to the stre |
| PUT | /streams/{stream_id}/embed/domains |
Set allowed embed domains Restricts playback to the listed domains. An empty array allows every domain. Requires a token with write access to the |
| PUT | /streams/{stream_id}/embed/geo |
Set embed geo restrictions Restricts playback to the listed country codes. An empty array allows every country. Requires a token with write access |
| PUT | /streams/{stream_id}/embed/iframe_restriction |
Set iframe hosting rule Controls whether the embed may be hosted inside an iframe. Requires a token with write access to the stream (CanWriteStr |
| PUT | /streams/{stream_id}/embed/mode/cdn |
Toggle CDN embed mode Switches the embed to CDN delivery. Enabling this checks the account subscription before applying. Requires a token with |
| PUT | /streams/{stream_id}/embed/mode/external |
Toggle external embed mode Switches the embed to an external delivery source. Toggling this resets the cdnReady flag on the stream. Requires a toke |
| PUT | /streams/{stream_id}/embed/preferred_destination |
Set preferred embed destination Chooses which connected destination the embed plays back from. Requires a token with write access to the stream (CanWrit |
| POST | /streams/{stream_id}/embed/produce_direct_links |
Produce direct playback links Generates direct output links for the stream, for use outside the Livepush player. Requires a token with write access to |
| POST | /streams/{stream_id}/embed/use_direct_links_for_embed |
Toggle direct links for the embed Switches the embed to play from the direct output URL rather than the managed player source. Requires a token with write |