Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
broadcast live

Update properties of a live stream

Update a selection of live stream properties

patch/v2/sites/{site_id}/live/broadcast/streams/{stream_id}/

Path parameters

stream_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the live stream

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

Request body

stream_startstring date-time nullable

Start time for the stream in ISO 8601 format

NOTE: This value can only be changed prior to starting the stream.

stream_endstring date-time nullable

End time for the stream in ISO 8601 format

NOTE: This value can only be changed prior to stopping the stream.

enable_live_to_vodboolean nullable

Controls if a video on demand (VOD) asset is automatically created once the live stream ends

NOTE: This value can only be changed prior to stopping the stream.

live_to_vod_method'hosted_capture' | 'renditions_capture' nullable

Controls how Live-to-VOD capture is performed once the stream ends

Possible values:

  • hosted_capture: The stream is captured using the hosted capture flow.
  • renditions_capture: The stream is captured directly from the output renditions, producing a renditions (CMAF VOD) media.

NOTE: This value can only be changed prior to stopping the stream.

Response

Success

schemastring
idstring nullable

Unique identifier for this resource

createdstring date-time nullable

Timestamp of when the live stream was created

last_modifiedstring date-time nullable

Timestamp of when the live stream was last modified

typestring nullable

Unique type label for this resource

relationshipsobject nullable

Related resources

stream_type'24/7' | 'event' nullable

The type of live stream.

profile_namestring nullable

The associated Preset's name.

cluster_regionstring nullable

The associated Cluster's name.

ingest_format'hls_pull' | 'rtmp' | 'rtp' | 'rtp_fec' | 'srt' | 'srt_pull' | 'zixi_push' nullable

The ingest format used for the live stream.

dvr_window30 | 3600 | 7200 | 10800 | 14400 | 18000 | 21600 | 25200 | 28800 | 32400 | 36000 | 39600 | 43200 | 46800 | 50400 | 54000 | 57600 | 61200 | 64800 | 68400 | 72000 | 75600 | 79200 | 82800 | 86400

The DVR window set on the live stream.

use_legacy_ott_paramsboolean

Whether or not the live stream is using legacy OTT parameters. The flag configures your Media to have the legacy VCH custom params, which may be desirable when migrating to the integrated version of Broadcast Live.

enable_live_to_vodboolean

Whether or not the live stream has live to VOD enabled. With live2vod enabled, the livestream will be converted to a hosted Media at the end of the stream.

live_to_vod_method'hosted_capture' | 'renditions_capture'

Live-to-VOD capture method configured for this stream

Possible values:

  • hosted_capture: The stream is captured using the hosted capture flow.
  • renditions_capture: The stream is captured directly from the output renditions, producing a renditions (CMAF VOD) media.
mpd_profilestring nullable

The profile type of the DASH MPD for this live stream.

stream_warmupinteger nullable

Number of minutes before stream_start that the stream was configured to start early

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"
}