Live Streams

Update a live stream

Updates the parameters of a previously-created live stream. This currently supports a subset of variables. Supply the live stream ID and the updated parameters and Mux will return the corresponding live stream information. The information returned will be the same after update as for subsequent get live stream requests.

patch/video/v1/live-streams/{LIVE_STREAM_ID}

Path parameters

LIVE_STREAM_IDstring required

The live stream ID

Request body

passthroughstring

Arbitrary user-supplied metadata set for the live stream. Max 255 characters. In order to clear this value, the field should be included with an empty-string value.

latency_mode'low' | 'reduced' | 'standard'

Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags.

reconnect_windownumber float

When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset.

If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams.

Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the use_slate_for_standard_latency option.

use_slate_for_standard_latencyboolean

By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream.

reconnect_slate_urlstring

The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the default slate media will be used.

max_continuous_durationinteger

The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours.

Response

OK

Changes

Changed in 12 of the 28 revisions of this API.1424

    • added the new auto enum value to the data/new_asset_settings/input/items/generated_subtitles/items/language_code response property for the response status 200

      response-property-enum-value-added

    • added the new auto enum value to the data/new_asset_settings/inputs/items/generated_subtitles/items/language_code response property for the response status 200

      response-property-enum-value-added

    • the endpoint scheme security authorizationToken was added to the API

      api-security-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new de enum value to the data/generated_subtitles/items/language_code response property for the response status 200

      response-property-enum-value-added

    • added the new es enum value to the data/generated_subtitles/items/language_code response property for the response status 200

      response-property-enum-value-added

    • added the new fr enum value to the data/generated_subtitles/items/language_code response property for the response status 200

      response-property-enum-value-added

    • added the new it enum value to the data/generated_subtitles/items/language_code response property for the response status 200

      response-property-enum-value-added

    • added the new pt enum value to the data/generated_subtitles/items/language_code response property for the response status 200

      response-property-enum-value-added

    • the endpoint scheme security accessToken was added to the API

      api-security-added

    • added the new optional request property meta

      new-optional-request-property

    • added the optional property data/meta to the response with the 200 status

      response-optional-property-added

    • added the optional property data/new_asset_settings/copy_overlays to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property data/new_asset_settings/inputs to the response with the 200 status

      response-optional-property-added

    • added the optional property data/new_asset_settings/playback_policies to the response with the 200 status

      response-optional-property-added

    • response property data/new_asset_settings/input deprecated

      response-property-deprecated

    • response property data/new_asset_settings/playback_policy deprecated

      response-property-deprecated

    • added the new optional request property new_asset_settings/meta

      new-optional-request-property

    • added the optional property data/new_asset_settings/meta to the response with the 200 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property new_asset_settings/video_quality

      new-optional-request-property

    • request property new_asset_settings/mp4_support deprecated

      request-property-deprecated

    • added the optional property data/new_asset_settings/static_renditions to the response with the 200 status

      response-optional-property-added

    • response property data/new_asset_settings/mp4_support deprecated

      response-property-deprecated

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5bc9dec57cc424See the full diff
    • removed the optional property data/new_asset_settings/advanced_playback_policy from the response with the 200 status

      response-optional-property-removed

    • added the new premium enum value to the data/new_asset_settings/encoding_tier response property for the response status 200

      response-property-enum-value-added

    • added the new optional request property new_asset_settings/master_access

      new-optional-request-property

    • added the optional property data/new_asset_settings/advanced_playback_policies to the response with the 200 status

      response-optional-property-added

    • added the optional property data/new_asset_settings/video_quality to the response with the 200 status

      response-optional-property-added

    • response property data/new_asset_settings/encoding_tier deprecated

      response-property-deprecated

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property data/new_asset_settings/advanced_playback_policy to the response with the 200 status

      response-optional-property-added

  • 6aab47a3857721See the full diff
    • added the new drm enum value to the data/new_asset_settings/playback_policy/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new drm enum value to the data/playback_ids/items/policy response property for the response status 200

      response-property-enum-value-added

    • added the optional property data/playback_ids/items/drm_configuration_id to the response with the 200 status

      response-optional-property-added