api.video
  1. Live
api.video
  • Account
    • Show account
      GET
  • Analytics
    • List live stream player sessions
      GET
    • List player session events
      GET
    • List video player sessions
      GET
  • Authentication
    • Authenticate
      POST
    • Refresh token
      POST
  • Live
    • List all live streams
      GET
    • Create live stream
      POST
    • Delete a live stream
      DELETE
    • Show live stream
      GET
    • Update a live stream
      PATCH
    • Delete a thumbnail
      DELETE
    • Upload a thumbnail
      POST
  • Players
    • List all players
      GET
    • Create a player
      POST
    • Delete a player
      DELETE
    • Show a player
      GET
    • Update a player
      PATCH
    • Delete logo
      DELETE
    • Upload a logo
      POST
  • Videos - Delegated upload
    • Upload with an upload token
      POST
    • List all active upload tokens.
      GET
    • Generate an upload token
      POST
    • Delete an upload token
      DELETE
    • Show upload token
      GET
  • Videos
    • List all videos
    • Create a video
    • Delete a video
    • Show a video
    • Update a video
    • Upload a video
    • Show video status
    • Pick a thumbnail
    • Upload a thumbnail
  • Captions
    • List video captions
    • Delete a caption
    • Show a caption
    • Update caption
    • Upload a caption
  • Chapters
    • List video chapters
    • Delete a chapter
    • Show a chapter
    • Upload a chapter
  • Webhooks
    • List all webhooks
    • Create Webhook
    • Delete a Webhook
    • Show Webhook details
  1. Live

Update a live stream

PATCH
/live-streams/{liveStreamId}
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.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://ws.api.video/live-streams/li400mYKSgQ6xs7taUeSaEKr' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My Live Stream Video",
    "playerId": "pl45KFKdlddgk654dspkze",
    "public": true,
    "record": true
}'
Response Response Example
200 - response
{
    "assets": {
        "hls": "https://live.api.video/li400mYKSgQ6xs7taUeSaEKr.m3u8",
        "iframe": "<iframe src=\"https://embed.api.video/live/li400mYKSgQ6xs7taUeSaEKr\" width=\"100%\" height=\"100%\" frameborder=\"0\" scrolling=\"no\" allowfullscreen=\"\"></iframe>",
        "player": "https://embed.api.video/live/li400mYKSgQ6xs7taUeSaEKr",
        "thumbnail": "https://cdn.api.video/live/li400mYKSgQ6xs7taUeSaEKr/thumbnail.jpg"
    },
    "broadcasting": false,
    "createdAt": "2020-01-31T10:17:47.000Z",
    "liveStreamId": "li400mYKSgQ6xs7taUeSaEKr",
    "name": "Live Stream From the browser",
    "public": true,
    "record": true,
    "streamKey": "30087931-229e-42cf-b5f9-e91bcc1f7332",
    "updatedAt": "2020-03-09T13:19:43.000Z"
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠400Bad Request
Modified at 2023-08-15 05:52:15
Previous
Show live stream
Next
Delete a thumbnail
Built with