v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB

live channels

Update a live channel

Updates live channel metadata and settings, such as the content protection rule, DVR, latency, publishing mode, reconnect window, simulcast targets, and text tracks (captions, subtitles)

patch/v2/sites/{site_id}/channels/{channel_id}/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

channel_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the live channel

Headers

Jw-Dry-Runboolean

Set the Jw-Dry-Run header to true if you want to validate your payload, but do not want the server to actually store the changes.

Request body

Example request

{
  "metadata": {
    "custom_params": {
      "param1": "value1"
    },
    "dvr": "on",
    "latency": "default",
    "reconnect_window": 60,
    "simulcast_targets": [
      {
        "stream_key": "ABCDEF123456",
        "stream_url": "rtmps://live.fb",
        "title": "My Facebook Simulcast"
      }
    ],
    "tags": [
      "sports",
      "football"
    ],
    "text_tracks": [
      {
        "label": "English captions",
        "srclang": "en",
        "track_kind": "captions"
      }
    ],
    "title": "Your live channel title"
  },
  "relationships": {
    "protection_rule": {
      "id": "Ny05CEfj"
    }
  }
}

Response

Resource successfully updated

schemastring

idstring

Unique identifier for a resource

createdstring

Date and time at which the resource was created

last_modifiedstring

Date and time at which the resource was most recently modified

typestring

Name of the type of resource.

preview_urlstring

URL pointing to a preview of the stream

This is only present when channel has a preview status.

status'creating' | 'active' | 'idle'

stream_keystring

Example response

{
  "schema": "https://schema.jwplayer.com/types/thumbnail.json",
  "id": "Ny05CEfj",
  "created": "2019-09-25T15:29:11.042095+00:00",
  "last_modified": "2019-09-25T15:29:11.042095+00:00",
  "relationships": {
    "protection_rule": {
      "id": "Ny05CEfj"
    }
  },
  "metadata": {
    "custom_params": {
      "param1": "value1"
    },
    "dvr": "on",
    "latency": "default",
    "reconnect_window": 60,
    "simulcast_targets": [
      {
        "stream_key": "ABCDEF123456",
        "stream_url": "rtmps://live.fb",
        "title": "My Facebook Simulcast"
      }
    ],
    "tags": [
      "sports",
      "football"
    ],
    "text_tracks": [
      {
        "label": "English captions",
        "srclang": "en",
        "track_kind": "captions"
      }
    ],
    "title": "Your live channel title"
  },
  "preview_url": "https://api.mux.com/video/v1/314159265358979323846264.m3u8",
  "recent_events": [
    {
      "media_id": "Ny05CEfj",
      "status": "idle"
    }
  ],
  "status": "idle",
  "stream_key": "123456ABCDEF"
}