Skip to Content
Mux Docs: Home
Update a live stream's embedded subtitles
put

Configures a live stream to receive embedded closed captions. The resulting Asset's subtitle text track will have closed_captions: true set.

Request body params

Describe the embedded closed caption contents of the incoming live stream.

embedded_subtitles[].name
string

A name for this live stream closed caption track.

embedded_subtitles[].passthrough
string

Arbitrary user-supplied metadata set for the live stream closed caption track. Max 255 characters.

embedded_subtitles[].language_code
string
(default: en)

The language of the closed caption stream. Value must be BCP 47 compliant.

embedded_subtitles[].language_channel
string
(default: cc1)
Possible values: "cc1""cc2""cc3""cc4"

CEA-608 caption channel to read data from.

Request path & query params
LIVE_STREAM_ID
string

The live stream ID

put
200
/video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles
Request
(application/json)
{
  "embedded_subtitles": [
    {
      "passthrough": "Example"
    }
  ]
}
Response
(application/json)
{
  "data": {
    "stream_key": "acaf2ca1-ba9c-5ffe-8c9c-a02bbf0009a6",
    "status": "idle",
    "reconnect_window": 60,
    "playback_ids": [
      {
        "policy": "public",
        "id": "HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018"
      },
      {
        "policy": "public",
        "id": "4O902oOPU100s7XIQgOeY01U7dHzYlBe26zi3Sq01EJqnxw"
      }
    ],
    "new_asset_settings": {
      "playback_policies": [
        "public"
      ]
    },
    "id": "ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag",
    "created_at": "1609937654",
    "embedded_subtitles": [
      {
        "name": "English CC",
        "language_code": "en",
        "language_channel": "cc1",
        "passthrough": "Example"
      }
    ],
    "latency_mode": "standard",
    "max_continuous_duration": 43200
  }
}