Mux

Mux Live Streams API

A Live Stream represents a unique live stream of video being pushed to Mux. It includes configuration details (a Stream Key) for live broadcasting software/hardware and a Playback ID for playing the stream anywhere. Currently, RTMP is the only supported method of ingesting video. Use rtmp://global-live.mux.com:5222/app with the Live Stream's Stream Key for getting the video into Mux, and use https://stream.mux.com with the Live Stream's Playback ID for playback. A Live Stream can be used once for a specific event, or re-used forever. If you're building an application like Facebook Live or Twitch, you could create one Live Stream per user. This allows them to configure their broadcasting software once, and the Live Stream Playback ID will always show their latest stream. Each RTMP session creates a new video asset automatically. You can set up a webhook to be notified each time a broadcast (or Live Stream RTMP session) begins or ends with the video.live_stream.active and video.live_stream.idle events respectively. Assets that are created from a Live Stream have the same behavior as other Assets you create. Learn more about [how to go live in our guides](https://docs.mux.com/guides/start-live-streaming).

OpenAPI Specification

mux-com-live-streams-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Mux Animated Images Live Streams API
  description: Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
  version: v1
  contact:
    name: Mux DevEx
    url: https://docs.mux.com
    email: devex@mux.com
servers:
- url: https://api.mux.com
  description: Mux Production API
- url: https://image.mux.com
- url: https://stream.mux.com
- url: https://stats.mux.com
tags:
- name: Live Streams
  description: 'A Live Stream represents a unique live stream of video being pushed to Mux. It includes configuration details (a Stream Key) for live broadcasting software/hardware and a Playback ID for playing the stream anywhere. Currently, RTMP is the only supported method of ingesting video. Use rtmp://global-live.mux.com:5222/app with the Live Stream''s Stream Key for getting the video into Mux, and use https://stream.mux.com with the Live Stream''s Playback ID for playback.


    A Live Stream can be used once for a specific event, or re-used forever. If you''re building an application like Facebook Live or Twitch, you could create one Live Stream per user. This allows them to configure their broadcasting software once, and the Live Stream Playback ID will always show their latest stream.


    Each RTMP session creates a new video asset automatically. You can set up a webhook to be notified each time a broadcast (or Live Stream RTMP session) begins or ends with the video.live_stream.active and video.live_stream.idle events respectively. Assets that are created from a Live Stream have the same behavior as other Assets you create.


    Learn more about [how to go live in our guides](https://docs.mux.com/guides/start-live-streaming).'
  x-displayName: Live Streams
paths:
  /video/v1/live-streams:
    post:
      tags:
      - Live Streams
      summary: Create a Live Stream
      description: Creates a new live stream. Once created, an encoder can connect to Mux via the specified stream key and begin streaming to an audience.
      operationId: create-live-stream
      servers:
      - url: https://api.mux.com
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLiveStreamRequest'
            example:
              playback_policies:
              - public
              new_asset_settings:
                playback_policies:
                - public
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiveStreamResponse'
              example:
                data:
                  stream_key: abcdefgh
                  status: idle
                  reconnect_window: 60
                  playback_ids:
                  - policy: public
                    id: HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018
                  new_asset_settings:
                    playback_policies:
                    - public
                  id: ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag
                  created_at: '1609937654'
                  latency_mode: standard
                  max_continuous_duration: 43200
      security:
      - accessToken: []
      - authorizationToken: []
    get:
      tags:
      - Live Streams
      summary: List Live Streams
      description: Lists the live streams that currently exist in the current environment.
      operationId: list-live-streams
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/stream_key'
      - name: status
        in: query
        description: Filter response to return live streams with the specified status only
        required: false
        schema:
          $ref: '#/components/schemas/LiveStreamStatus'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLiveStreamsResponse'
              example:
                data:
                - stream_key: 831b5bde-cd8a-5bc4-115d-4ba34b19f481
                  status: idle
                  reconnect_window: 60
                  playback_ids:
                  - policy: public
                    id: HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018
                  new_asset_settings:
                    playback_policies:
                    - public
                  id: ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag
                  created_at: '1609937654'
                  latency_mode: standard
                  max_continuous_duration: 43200
                - stream_key: d273c65e-1fc8-27dc-e9ef-56144cbceb3a
                  status: idle
                  reconnect_window: 60
                  recent_asset_ids:
                  - SZs02xxHgYdkHp00OSCjJiHUHqzVQZNU332XPXRxe341o
                  - e4J9cwb5tjVxMeeV8201dC00i800ThPKKGT2SEN002dHH2s
                  playback_ids:
                  - policy: public
                    id: 00zOcribkUmXqXHzBTpflk2771BRTcKATqPjWf7JHpuM
                  new_asset_settings:
                    playback_policies:
                    - public
                  id: B65hEUWW01ErVKDDGImKcBquYhwEAkjW6Ic3lPY0299Cc
                  created_at: '1607587513'
                  latency_mode: standard
                  max_continuous_duration: 43200
      security:
      - accessToken: []
      - authorizationToken: []
  /video/v1/live-streams/{LIVE_STREAM_ID}:
    get:
      tags:
      - Live Streams
      summary: Retrieve a Live Stream
      description: Retrieves the details of a live stream that has previously been created. Supply the unique live stream ID that was returned from your previous request, and Mux will return the corresponding live stream information. The same information is returned when creating a live stream.
      operationId: get-live-stream
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiveStreamResponse'
              example:
                data:
                  stream_key: 831b5bde-cd8a-5bc4-115d-4ba34b19f481
                  status: idle
                  reconnect_window: 60
                  playback_ids:
                  - policy: public
                    id: HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018
                  new_asset_settings:
                    playback_policies:
                    - public
                  id: ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag
                  created_at: '1609937654'
                  latency_mode: standard
                  max_continuous_duration: 43200
      security:
      - accessToken: []
      - authorizationToken: []
    delete:
      tags:
      - Live Streams
      summary: Delete a Live Stream
      description: Deletes a live stream from the current environment. If the live stream is currently active and being streamed to, ingest will be terminated and the encoder will be disconnected.
      operationId: delete-live-stream
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      responses:
        '204':
          description: No Content
      security:
      - accessToken: []
      - authorizationToken: []
    patch:
      tags:
      - Live Streams
      summary: Update a Live Stream
      description: 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.
      operationId: update-live-stream
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLiveStreamRequest'
            example:
              latency_mode: standard
              reconnect_window: 30
              max_continuous_duration: 1200
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiveStreamResponse'
              example:
                data:
                  stream_key: 831b5bde-cd8a-5bc4-115d-4ba34b19f481
                  status: idle
                  reconnect_window: 30
                  playback_ids:
                  - policy: public
                    id: HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018
                  new_asset_settings:
                    playback_policies:
                    - public
                  id: ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag
                  created_at: '1609937654'
                  latency_mode: standard
                  max_continuous_duration: 1200
      security:
      - accessToken: []
      - authorizationToken: []
  /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids:
    post:
      tags:
      - Live Streams
      summary: Create a Live Stream Playback ID
      description: Create a new playback ID for this live stream, through which a viewer can watch the streamed content of the live stream.
      operationId: create-live-stream-playback-id
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePlaybackIDRequest'
            example:
              policy: signed
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePlaybackIDResponse'
              example:
                data:
                  policy: public
                  id: 4O902oOPU100s7XIQgOeY01U7dHzYlBe26zi3Sq01EJqnxw
      security:
      - accessToken: []
      - authorizationToken: []
  /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}:
    get:
      tags:
      - Live Streams
      summary: Retrieve a Live Stream Playback ID
      description: Fetches information about a live stream's playback ID, through which a viewer can watch the streamed content from this live stream.
      operationId: get-live-stream-playback-id
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      - $ref: '#/components/parameters/playback_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLiveStreamPlaybackIDResponse'
              example:
                data:
                  policy: public
                  id: 4O902oOPU100s7XIQgOeY01U7dHzYlBe26zi3Sq01EJqnxw
      security:
      - accessToken: []
      - authorizationToken: []
    delete:
      tags:
      - Live Streams
      summary: Delete a Live Stream Playback ID
      description: Deletes the playback ID for the live stream. This will not disable ingest (as the live stream still exists). New attempts to play back the live stream will fail immediately. However, current viewers will be able to continue watching the stream for some period of time.
      operationId: delete-live-stream-playback-id
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      - $ref: '#/components/parameters/playback_id'
      responses:
        '204':
          description: No Content
      security:
      - accessToken: []
      - authorizationToken: []
  /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key:
    post:
      tags:
      - Live Streams
      summary: Reset a Live Stream's Stream Key
      description: Reset a live stream key if you want to immediately stop the current stream key from working and create a new stream key that can be used for future broadcasts.
      operationId: reset-stream-key
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiveStreamResponse'
              example:
                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'
                  latency_mode: standard
                  max_continuous_duration: 43200
      security:
      - accessToken: []
      - authorizationToken: []
  /video/v1/live-streams/{LIVE_STREAM_ID}/complete:
    put:
      tags:
      - Live Streams
      summary: Signal a Live Stream Is Finished
      description: '(Optional) End the live stream recording immediately instead of waiting for the reconnect_window. `EXT-X-ENDLIST` tag is added to the HLS manifest which notifies the player that this live stream is over.


        Mux does not close the encoder connection immediately. Encoders are often configured to re-establish connections immediately which would result in a new recorded asset. For this reason, Mux waits for 60s before closing the connection with the encoder. This 60s timeframe is meant to give encoder operators a chance to disconnect from their end.

        '
      operationId: signal-live-stream-complete
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      responses:
        '200':
          description: OK
      security:
      - accessToken: []
      - authorizationToken: []
  /video/v1/live-streams/{LIVE_STREAM_ID}/disable:
    put:
      tags:
      - Live Streams
      summary: Disable a Live Stream
      description: 'Disables a live stream, making it reject incoming RTMP streams until re-enabled. The API also ends the live stream recording immediately when active. Ending the live stream recording adds the `EXT-X-ENDLIST` tag to the HLS manifest which notifies the player that this live stream is over.


        Mux also closes the encoder connection immediately. Any attempt from the encoder to re-establish connection will fail till the live stream is re-enabled.

        '
      operationId: disable-live-stream
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      responses:
        '200':
          description: OK
      security:
      - accessToken: []
      - authorizationToken: []
  /video/v1/live-streams/{LIVE_STREAM_ID}/enable:
    put:
      tags:
      - Live Streams
      summary: Enable a Live Stream
      description: Enables a live stream, allowing it to accept an incoming RTMP stream.
      operationId: enable-live-stream
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      responses:
        '200':
          description: OK
      security:
      - accessToken: []
      - authorizationToken: []
  /video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles:
    put:
      tags:
      - Live Streams
      summary: Update a Live Stream's Embedded Subtitles
      description: 'Configures a live stream to receive embedded closed captions.

        The resulting Asset''s subtitle text track will have `closed_captions: true` set.

        '
      operationId: update-live-stream-embedded-subtitles
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLiveStreamEmbeddedSubtitlesRequest'
            example:
              embedded_subtitles:
              - passthrough: Example
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiveStreamResponse'
              example:
                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
      security:
      - accessToken: []
      - authorizationToken: []
  /video/v1/live-streams/{LIVE_STREAM_ID}/generated-subtitles:
    put:
      tags:
      - Live Streams
      summary: Update a Live Stream's Generated Subtitles
      description: 'Updates a live stream''s automatic-speech-recognition-generated subtitle configuration.

        Automatic speech recognition subtitles can be removed by sending an empty array in the

        request payload.

        '
      operationId: update-live-stream-generated-subtitles
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLiveStreamGeneratedSubtitlesRequest'
            example:
              generated_subtitles:
              - name: English CC (ASR)
                language_code: en
                passthrough: Example
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiveStreamResponse'
              example:
                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'
                  generated_subtitles:
                  - name: English CC (ASR)
                    language_code: en
                    passthrough: Example
                  latency_mode: standard
                  max_continuous_duration: 43200
      security:
      - accessToken: []
      - authorizationToken: []
  /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets:
    post:
      tags:
      - Live Streams
      summary: Create a Live Stream Simulcast Target
      description: Create a simulcast target for the parent live stream. Simulcast target can only be created when the parent live stream is in idle state. Only one simulcast target can be created at a time with this API.
      operationId: create-live-stream-simulcast-target
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSimulcastTargetRequest'
            example:
              url: rtmp://live.example.com/app
              stream_key: abcdefgh
              passthrough: Example
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulcastTargetResponse'
              example:
                data:
                  url: rtmp://live.example.com/app
                  stream_key: abcdefgh
                  status: idle
                  passthrough: Example
                  id: le1axfGDc9ETqh6trHNTxGQ9XEhj02fOnX0200aAh24fwlmwzqKCYNJgw
      security:
      - accessToken: []
      - authorizationToken: []
  /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID}:
    delete:
      tags:
      - Live Streams
      summary: Delete a Live Stream Simulcast Target
      description: Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state.
      operationId: delete-live-stream-simulcast-target
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      - $ref: '#/components/parameters/simulcast_target_id'
      responses:
        '204':
          description: No Content
      security:
      - accessToken: []
      - authorizationToken: []
    get:
      tags:
      - Live Streams
      summary: Retrieve a Live Stream Simulcast Target
      description: Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information.
      operationId: get-live-stream-simulcast-target
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      - $ref: '#/components/parameters/simulcast_target_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulcastTargetResponse'
              example:
                data:
                  url: rtmp://live.example.com/app
                  stream_key: abcdefgh
                  status: idle
                  passthrough: Example
                  id: 02FU00rPq00fC9S6kygrqlxygGMdpW1lk00BkFpCfc2kGregEIr7brt7CQ
      security:
      - accessToken: []
      - authorizationToken: []
  /video/v1/live-streams/{LIVE_STREAM_ID}/new-asset-settings/static-renditions:
    put:
      tags:
      - Live Streams
      summary: Update Live Stream Static Renditions for New Assets
      description: Updates a live stream's static renditions settings for new assets. Further assets made via this live stream will create static renditions per the settings provided. You must provide all static renditions desired.
      operationId: update-live-stream-new-asset-settings-static-renditions
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest'
            example:
              static_renditions:
              - resolution: audio-only
              - resolution: highest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiveStreamResponse'
              example:
                data:
                  stream_key: abcdefgh
                  status: idle
                  reconnect_window: 60
                  playback_ids:
                  - policy: public
                    id: HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018
                  new_asset_settings:
                    playback_policies:
                    - public
                    static_renditions:
                    - resolution: audio-only
                    - resolution: highest
                  id: ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag
                  created_at: '1609937654'
                  latency_mode: standard
                  max_continuous_duration: 43200
      security:
      - accessToken: []
      - authorizationToken: []
    delete:
      tags:
      - Live Streams
      summary: Delete a Live Stream's Static Renditions Setting for New Assets
      description: Deletes a live stream's static renditions settings for new assets. Further assets made via this live stream will not create static renditions unless re-added.
      operationId: delete-live-stream-new-asset-settings-static-renditions
      servers:
      - url: https://api.mux.com
      parameters:
      - $ref: '#/components/parameters/livestream_id'
      responses:
        '204':
          description: No Content
      security:
      - accessToken: []
      - authorizationToken: []
components:
  schemas:
    SimulcastTarget:
      type: object
      required:
      - id
      - url
      - status
      properties:
        id:
          type: string
          description: ID of the Simulcast Target
        passthrough:
          type: string
          description: Arbitrary user-supplied metadata set when creating a simulcast target.
        status:
          type: string
          enum:
          - idle
          - starting
          - broadcasting
          - errored
          description: "The current status of the simulcast target. See Statuses below for detailed description.\n  * `idle`: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state.\n  * `starting`: The simulcast target transitions into this state when the parent live stream transition into connected state.\n  * `broadcasting`: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service.\n  * `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.\n"
        stream_key:
          type: string
          description: 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.
        url:
          type: string
          description: '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.

            '
        error_severity:
          type: string
          enum:
          - normal
          - fatal
          description: "The severity of the error encountered by the simulcast target.\nThis field is only set when the simulcast target is in the `errored` status.\nSee the values of severities below and their descriptions.\n  * `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.\n  * `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.\n"
    ListLiveStreamsResponse:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LiveStream'
    LiveStream:
      type: object
      required:
      - id
      - created_at
      - latency_mode
      - max_continuous_duration
      - status
      - stream_key
      properties:
        id:
          type: string
          description: Unique identifier for the Live Stream. Max 255 characters.
        created_at:
          type: string
          format: int64
          description: Time the Live Stream was created, defined as a Unix timestamp (seconds since epoch).
        stream_key:
          type: string
          description: 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. Max 64 characters.
        active_asset_id:
          type: string
          description: The Asset that is currently being created if there is an active broadcast.
        recent_asset_ids:
          type: array
          description: 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.
          items:
            type: string
        status:
          $ref: '#/components/schemas/LiveStreamStatus'
        playback_ids:
          type: array
          description: An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/play-your-videos) for more details.
          items:
            $ref: '#/components/schemas/PlaybackID'
        new_asset_settings:
          $ref: '#/components/schemas/AssetOptions'
        passthrough:
          type: string
          description: Arbitrary user-supplied metadata set for the asset. Max 255 characters.
        audio_only:
          type: boolean
          description: The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted.
        embedded_subtitles:
          type: array
          items:
            $ref: '#/components/schemas/LiveStreamEmbeddedSubtitleSettings'
          description: Describes the embedded closed caption configuration of the incoming live stream.
        generated_subtitles:
          type: array
          items:
            $ref: '#/components/schemas/LiveStreamGeneratedSubtitleSettings'
          description: 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.
        reconnect_window:
          type: number
          format: float
          default: 60
          minimum: 0
          maximum: 1800
          description: 'When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect

# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mux-com/refs/heads/main/openapi/mux-com-live-streams-api-openapi.yml