PATCH
/
stream
/
{id}
Authorization
Path
Body
curl --request PATCH \
  --url https://livepeer.studio/api/stream/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "creatorId": {
    "type": "unverified",
    "value": "<string>"
  },
  "record": true,
  "suspended": true,
  "multistream": {
    "targets": [
      {
        "id": "PUSH123",
        "profile": "720p"
      }
    ]
  },
  "playbackPolicy": {
    "type": "public",
    "webhookId": "<string>",
    "webhookContext": {}
  },
  "profiles": [
    {
      "width": 129,
      "name": "720p",
      "height": 129,
      "bitrate": 401,
      "fps": 1,
      "fpsDen": 2,
      "gop": "<string>",
      "profile": "H264Baseline",
      "encoder": "h264"
    }
  ]
}'
This response has no body data.

Authorizations

Authorization
string
headerrequired

Bearer api-key

Path Parameters

id
string
required

ID of the stream

Body

application/json
creatorId
record
boolean

Should this stream be recorded? Uses default settings. For more customization, create and configure an object store.

suspended
boolean

If currently suspended

multistream
object
playbackPolicy
object

Whether the playback policy for a asset or stream is public or signed

profiles
object[]

Was this page helpful?

Retrieve a streamTerminates a stream