Sign in
Live Streams

Update a live stream

Updates the livestream object.

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

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. Learn more about the Private Video feature here.

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",
  "restreams": [
    {
      "name": "My RTMP server",
      "serverUrl": "rtmp://my.broadcast.example.com/app",
      "streamKey": "dw-dew8-q6w9-k67w-1ws8"
    }
  ]
}

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

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. Learn more about the Private Video feature here.

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": "dw-dew8-q6w9-k67w-1ws8",
  "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,
  "restreams": [
    {
      "streamKey": "dw-dew8-q6w9-k67w-1ws8",
      "serverUrl": "rtmp://my.broadcast.example.com/app",
      "name": "My RTMP server"
    },
    {
      "streamKey": "dw-dew8-q6w9-k67w-1ws8",
      "serverUrl": "rtmp://my.broadcast.example.com/app",
      "name": "My RTMP server"
    }
  ],
  "liveStreamId": "li400mYKSgQ6xs7taUeSaEKr",
  "record": true,
  "name": "My Live Stream",
  "playerId": "pl45d5vFFGrfdsdsd156dGhh",
  "broadcasting": true,
  "updatedAt": "2020-01-31T10:18:47Z"
}

Changes