Unique identifier for the Live Stream. Max 255 characters.

Time the Live Stream was created, defined as a Unix timestamp (seconds since epoch).

Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming.

The Asset that is currently being created if there is an active broadcast.

An array of strings with the most recent Asset IDs that were created from this Live Stream. The most recently generated Asset ID is the last entry in the list.

idle indicates that there is no active broadcast. active indicates that there is an active broadcast and disabled status indicates that no future RTMP streams can be published.

An array of Playback ID objects. Use these to create HLS playback URLs. See Play your videos for more details.

Unique identifier for the PlaybackID

• public playback IDs are accessible by constructing an HLS URL like https://stream.mux.com/${PLAYBACK_ID}

• signed playback IDs should be used with tokens https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}. See Secure video playback for details about creating tokens.

• drm playback IDs are protected with DRM technologies. See DRM documentation for more details.

The DRM configuration used by this playback ID. Must only be set when policy is set to drm.

The settings to be used when creating a new asset. You can use any of the usual settings when creating an asset normally, with the exception to not include file url for creating the asset in input. You could optionally add overlay_setting and input urls to add Subtitles / Captions.

Arbitrary user-supplied metadata set for the asset. Max 255 characters.

The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted.

Describes the embedded closed caption configuration of the incoming live stream.

A name for this live stream closed caption track.

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

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

CEA-608 caption channel to read data from.

Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with generated_subtitles configured will automatically receive two text tracks. The first of these will have a text_source value of generated_live, and will be available with ready status as soon as the stream is live. The second text track will have a text_source value of generated_live_final and will contain subtitles with improved accuracy, timing, and formatting. However, generated_live_final tracks will not be available in ready status until the live stream ends. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.

A name for this live stream subtitle track.

Arbitrary metadata set for the live stream subtitle track. Max 255 characters.

The language to generate subtitles in.

Unique identifiers for existing Transcription Vocabularies to use while generating subtitles for the live stream. If the Transcription Vocabularies provided collectively have more than 1000 phrases, only the first 1000 phrases will be included.

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. Max: 1800s (30 minutes).

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.

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.

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. If this is not set, the default slate media will be used.

Each Simulcast Target contains configuration details to broadcast (or "restream") a live stream to a third-party streaming service. See the Stream live to 3rd party platforms guide.

ID of the Simulcast Target

Arbitrary user-supplied metadata set when creating a simulcast target.

The current status of the simulcast target. See Statuses below for detailed description.

• idle: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state.
• starting: The simulcast target transitions into this state when the parent live stream transition into connected state.
• broadcasting: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service.
• errored: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. When a simulcast target has this status it will have an error_severity field with more details about the error.

Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. Only used for RTMP(s) simulcast destinations.

The RTMP(s) or SRT endpoint for a simulcast destination.

• For RTMP(s) destinations, this should include the application name for the third party live streaming service, for example: rtmp://live.example.com/app.
• For SRT destinations, this should be a fully formed SRT connection string, for example: srt://srt-live.example.com:1234?streamid={stream_key}&passphrase={srt_passphrase}.

Note: SRT simulcast targets can only be used when an source is connected over SRT.

The severity of the error encountered by the simulcast target. This field is only set when the simulcast target is in the errored status. See the values of severities below and their descriptions.

• normal: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. A simulcast may transition back into the broadcasting state if a connection with the service can be re-established.
• fatal: The simulcast target is incompatible with the current input to the parent live stream. No further attempts to this simulcast target will be made for the current live stream asset.

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.

True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours.

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

Unique key used for encrypting a stream to a Mux SRT endpoint.

The protocol used for the active ingest stream. This is only set when the live stream is active.