Mux Live Streams API

openapi: 3.2.0
info:
  title: Mux Com Live Streams API
  version: v1
  description: 'Operations tagged Live Streams across 2 of this provider''s published API definitions: mux-com-openapi.yml, mux-openapi.yml. Each path carries the servers of the definition it was published in.'
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: Create and manage live streams.
paths:
  /video/v1/live_streams:
    get:
      tags:
      - Live Streams
      summary: List live streams
      operationId: listLiveStreams
      responses:
        '200':
          description: List of live streams.
      security:
      - basicAuth: []
    post:
      tags:
      - Live Streams
      summary: Create a live stream
      operationId: createLiveStream
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Live stream created.
      security:
      - basicAuth: []
    servers:
    - url: https://api.mux.com
      description: Mux production API
  /video/v1/live_streams/{LIVE_STREAM_ID}:
    parameters:
    - in: path
      name: LIVE_STREAM_ID
      required: true
      schema:
        type: string
    get:
      tags:
      - Live Streams
      summary: Retrieve a live stream
      operationId: getLiveStream
      responses:
        '200':
          description: Live stream details.
      security:
      - basicAuth: []
    servers:
    - url: https://api.mux.com
      description: Mux production API
  /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: []
    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
  /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: []
    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
  /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: []
    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
  /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: []
    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
  /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: []
    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
  /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: []
    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
  /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: []
    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
  /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: []
    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
  /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: []
    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
  /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: []
    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
  /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: []
    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
  /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: []
    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
  /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: []
    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
components:
  schemas:
    PlaybackID:
      type: object
      required:
      - id
      - policy
      properties:
        id:
          type: string
          description: Unique identifier for the PlaybackID
        policy:
          $ref: '#/components/schemas/PlaybackPolicy'
        drm_configuration_id:
          type: string
          description: The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.
    LiveStreamEmbeddedSubtitleRequest:
      type: object
      properties:
        name:
          type: string
          description: A name for this live stream closed caption track.
        passthrough:
          type: string
          description: Arbitrary user-supplied metadata set for the live stream closed caption track. Max 255 characters.
        language_code:
          type: string
          description: The language of the closed caption stream. Value must be BCP 47 compliant.
          default: en
        language_channel:
          type: string
          description: CEA-608 caption channel to read data from.
          default: cc1
          enum:
          - cc1
          - cc2
          - cc3
          - cc4
    LiveStreamStatus:
      type: string
      enum:
      - active
      - idle
      - disabled
      description: '`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.'
    UpdateLiveStreamRequest:
      type: object
      properties:
        passthrough:
          type: string
          description: 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:
          type: string
          enum:
          - low
          - reduced
          - standard
          description: 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_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 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_latency:
          type: boolean
          format: boolean
          default: false
          description: 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_url:
          type: string
          description: 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_duration:
          $ref: '#/components/schemas/MaxContinuousDuration'
        new_asset_settings:
          $ref: '#/components/schemas/UpdateLiveStreamNewAssetSettings'
        meta:
          $ref: '#/components/schemas/LiveStreamMetadata

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