Sign in
Live Streams

Update a live stream

Use this endpoint to update the player, or to turn recording on/off (saving a copy of the livestream). NOTE: If the livestream is actively streaming, changing the recording status will only affect the NEXT stream. The public=false 'private livestream' is available as a BETA feature, and should be limited to livestreams of 3,000 viewers or fewer.

patch/live-streams/{liveStreamId}

Path parameters

liveStreamIdstring required

The unique ID for the live stream that you want to update information for such as player details, or whether you want the recording on or off.

Request body

namestring

The name you want to use for your live stream.

publicboolean

BETA FEATURE Please limit all public = false ("private") livestreams to 3,000 users. Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view.

recordboolean

Use this to indicate whether you want the recording on or off. On is true, off is false.

playerIdstring

The unique ID for the player associated with a live stream that you want to update.

Example request

{
  "name": "My Live Stream Video",
  "record": true,
  "playerId": "pl45KFKdlddgk654dspkze"
}

Response

Success

liveStreamIdstring required

The unique identifier for the live stream. Live stream IDs begin with "li."

namestring

The name of your live stream.

streamKeystring

The unique, private stream key that you use to begin streaming.

recordboolean

Whether you are recording or not.

publicboolean

BETA FEATURE Please limit all public = false ("private") livestreams to 3,000 users. Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view.

playerIdstring

The unique identifier for the player.

broadcastingboolean

Whether or not you are broadcasting the live video you recorded for others to see. True means you are broadcasting to viewers, false means you are not.

createdAtstring date-time

When the player was created, presented in ISO-8601 format.

updatedAtstring date-time

When the player was last updated, presented in ISO-8601 format.

Example response

{
  "streamKey": "cc1b4df0-d1c5-4064-a8f9-9f0368385135",
  "createdAt": "2020-01-31T10:17:47Z",
  "assets": {
    "thumbnail": "https://cdn.api.video/live/li400mYKSgQ6xs7taUeSaEKr/thumbnail.jpg",
    "iframe": "<iframe src=\\\"https://embed.api.video/live/li4pqNqGUkhKfWcBGpZVLRY5\\\" width=\\\"100%\\\" height=\\\"100%\\\" frameborder=\\\"0\\\" scrolling=\\\"no\\\" allowfullscreen=\\\"\\\"></iframe>",
    "hls": "https://live.api.video/li4pqNqGUkhKfWcBGpZVLRY5.m3u8",
    "player": "https://embed.api.video/live/li400mYKSgQ6xs7taUeSaEKr"
  },
  "public": true,
  "liveStreamId": "li400mYKSgQ6xs7taUeSaEKr",
  "record": true,
  "name": "My Live Stream",
  "playerId": "pl45d5vFFGrfdsdsd156dGhh",
  "broadcasting": true,
  "updatedAt": "2020-01-31T10:18:47Z"
}

Changes