// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import crypto from 'crypto';
import { buildHeaders, HeadersLike } from '../../internal/headers';

export class Webhooks extends APIResource {
  unwrap(
    body: string,
    headers: HeadersLike,
    secret: string | undefined | null = this._client.webhookSecret,
  ): UnwrapWebhookEvent {
    this.verifySignature(body, headers, secret);
    return JSON.parse(body) as UnwrapWebhookEvent;
  }

  private getHeader(headers: HeadersLike, name: string): string | null {
    return buildHeaders([headers]).values.get(name) ?? null;
  }

  private parseHeader(header: string, scheme: string) {
    if (typeof header !== 'string') {
      return null;
    }

    return header.split(',').reduce(
      (accum, item) => {
        const kv: string[] = item.split('=');

        if (kv[0] === 't') {
          accum.timestamp = parseInt(kv[1]!, 10);
        }

        if (kv[0] === scheme && typeof kv[1] === 'string') {
          accum.signatures.push(kv[1]);
        }

        return accum;
      },
      {
        timestamp: -1,
        signatures: [] as string[],
      },
    );
  }

  /** Make an assertion, if not `true`, then throw. */
  private assert(expr: unknown, msg = ''): asserts expr {
    if (!expr) {
      throw new Error(msg);
    }
  }

  private computeSignature(payload: string, secret: string | Buffer) {
    return crypto.createHmac('sha256', secret).update(payload, 'utf8').digest('hex');
  }

  /** Compare to array buffers or data views in a way that timing based attacks
   * cannot gain information about the platform. */
  private timingSafeEqual(
    a: ArrayBufferView | ArrayBufferLike | DataView,
    b: ArrayBufferView | ArrayBufferLike | DataView,
  ): boolean {
    if (a.byteLength !== b.byteLength) {
      return false;
    }
    if (!(a instanceof DataView)) {
      a = new DataView(ArrayBuffer.isView(a) ? a.buffer : a);
    }
    if (!(b instanceof DataView)) {
      b = new DataView(ArrayBuffer.isView(b) ? b.buffer : b);
    }
    this.assert(a instanceof DataView);
    this.assert(b instanceof DataView);
    const length = a.byteLength;
    let out = 0;
    let i = -1;
    while (++i < length) {
      out |= a.getUint8(i) ^ b.getUint8(i);
    }
    return out === 0;
  }

  /**
   * Validates whether or not the webhook payload was sent by Mux.
   *
   * If it was not sent by Mux then an error will be raised.
   */
  verifySignature(
    body: string,
    headers: HeadersLike,
    secret: string | undefined | null = this._client.webhookSecret,
  ): void {
    if (!secret) {
      throw new Error(
        "The webhook secret must either be set using the env var, MUX_WEBHOOK_SECRET, on the client class, Mux({ webhookSecret: '123' }), or passed to this function",
      );
    }

    const header = this.getHeader(headers, 'mux-signature');
    if (!header) {
      throw new Error('Could not find a mux-signature header');
    }

    if (typeof body !== 'string') {
      throw new Error(
        'Webhook body must be passed as the raw JSON string sent from the server (do not parse it first).',
      );
    }

    const details = this.parseHeader(header, 'v1');
    if (!details || details.timestamp === -1) {
      throw new Error('Unable to extract timestamp and signatures from header');
    }

    if (!details.signatures.length) {
      throw new Error('No v1 signatures found');
    }

    const expectedSignature = this.computeSignature(`${details.timestamp}.${body}`, secret);

    const encoder = new TextEncoder();
    const signatureFound = !!details.signatures.filter((sig) =>
      this.timingSafeEqual(encoder.encode(sig), encoder.encode(expectedSignature)),
    ).length;

    if (!signatureFound) {
      throw new Error('No signatures found matching the expected signature for payload.');
    }

    const timestampAge = Math.floor(Date.now() / 1000) - details.timestamp;

    const tolerance = 300; // 5 minutes
    if (timestampAge > tolerance) {
      throw new Error('Webhook timestamp is too old');
    }
  }
}

export interface BaseWebhookEvent {
  /**
   * Unique identifier for the event
   */
  id: string;

  /**
   * Attempts for sending out the webhook event
   */
  attempts: Array<BaseWebhookEvent.Attempt>;

  /**
   * Time the event was created
   */
  created_at: string;

  data: unknown;

  environment: BaseWebhookEvent.Environment;

  object: BaseWebhookEvent.Object;

  /**
   * Type for the webhook event
   */
  type: string;

  /**
   * @deprecated
   */
  accessor?: string | null;

  /**
   * @deprecated
   */
  accessor_source?: string | null;

  /**
   * @deprecated
   */
  request_id?: string | null;
}

export namespace BaseWebhookEvent {
  export interface Attempt {
    /**
     * Unique identifier for the webhook attempt
     */
    id?: string;

    /**
     * URL address for the webhook attempt
     */
    address?: string;

    /**
     * Time the webhook request was attempted
     */
    created_at?: string;

    /**
     * Max attempts number for the webhook attempt
     */
    max_attempts?: number;

    /**
     * HTTP response body for the webhook attempt
     */
    response_body?: string | null;

    /**
     * HTTP response headers for the webhook attempt
     */
    response_headers?: unknown;

    /**
     * HTTP response status code for the webhook attempt
     */
    response_status_code?: number;

    /**
     * Unique identifier for the webhook
     */
    webhook_id?: number;
  }

  export interface Environment {
    /**
     * Unique identifier for the environment
     */
    id: string;

    /**
     * Name for the environment
     */
    name: string;
  }

  export interface Object {
    id: string;

    type: string;
  }
}

export interface VideoAssetCreatedWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetCreatedWebhookEvent.Data;

  type: 'video.asset.created';
}

export namespace VideoAssetCreatedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetReadyWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetReadyWebhookEvent.Data;

  type: 'video.asset.ready';
}

export namespace VideoAssetReadyWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetErroredWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetErroredWebhookEvent.Data;

  type: 'video.asset.errored';
}

export namespace VideoAssetErroredWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetUpdatedWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetUpdatedWebhookEvent.Data;

  type: 'video.asset.updated';
}

export namespace VideoAssetUpdatedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetDeletedWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetDeletedWebhookEvent.Data;

  type: 'video.asset.deleted';
}

export namespace VideoAssetDeletedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetLiveStreamCompletedWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetLiveStreamCompletedWebhookEvent.Data;

  type: 'video.asset.live_stream_completed';
}

export namespace VideoAssetLiveStreamCompletedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetStaticRenditionsReadyWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetStaticRenditionsReadyWebhookEvent.Data;

  type: 'video.asset.static_renditions.ready';
}

export namespace VideoAssetStaticRenditionsReadyWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetStaticRenditionsPreparingWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetStaticRenditionsPreparingWebhookEvent.Data;

  type: 'video.asset.static_renditions.preparing';
}

export namespace VideoAssetStaticRenditionsPreparingWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetStaticRenditionsDeletedWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetStaticRenditionsDeletedWebhookEvent.Data;

  type: 'video.asset.static_renditions.deleted';
}

export namespace VideoAssetStaticRenditionsDeletedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetStaticRenditionsErroredWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetStaticRenditionsErroredWebhookEvent.Data;

  type: 'video.asset.static_renditions.errored';
}

export namespace VideoAssetStaticRenditionsErroredWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetMasterReadyWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetMasterReadyWebhookEvent.Data;

  type: 'video.asset.master.ready';
}

export namespace VideoAssetMasterReadyWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetMasterPreparingWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetMasterPreparingWebhookEvent.Data;

  type: 'video.asset.master.preparing';
}

export namespace VideoAssetMasterPreparingWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetMasterDeletedWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetMasterDeletedWebhookEvent.Data;

  type: 'video.asset.master.deleted';
}

export namespace VideoAssetMasterDeletedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetMasterErroredWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetMasterErroredWebhookEvent.Data;

  type: 'video.asset.master.errored';
}

export namespace VideoAssetMasterErroredWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoAssetTrackCreatedWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetTrackCreatedWebhookEvent.Data;

  type: 'video.asset.track.created';
}

export namespace VideoAssetTrackCreatedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Track
     */
    id?: string;

    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    asset_id?: string;

    /**
     * The confidence value (0-1) of the determined language. This value only is
     * available when automatic language detection is utilized in generated subtitles.
     */
    auto_language_confidence?: number;

    /**
     * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
     * This parameter is only set tracks where `type` is `text` and `text_type` is
     * `subtitles`.
     */
    closed_captions?: boolean;

    /**
     * The duration in seconds of the track media. This parameter is not set for `text`
     * type tracks. This field is optional and may not be set. The top level `duration`
     * field of an asset will always be set.
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    error?: Data.Error;

    /**
     * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
     * specification compliant value, or 'auto'. For example, `en` for English or
     * `en-US` for the US version of English. This parameter is only set for `text` and
     * `audio` track types. During automatic language detection for generated
     * subtitles, this value will be set to `auto` until the language is determined.
     */
    language_code?: string;

    /**
     * @deprecated Only set for the `audio` type track.
     */
    max_channel_layout?: string;

    /**
     * The maximum number of audio channels the track supports. Only set for the
     * `audio` type track.
     */
    max_channels?: number;

    /**
     * The maximum frame rate available for the track. Only set for the `video` type
     * track. This field may return `-1` if the frame rate of the input cannot be
     * reliably determined.
     */
    max_frame_rate?: number;

    /**
     * The maximum height in pixels available for the track. Only set for the `video`
     * type track.
     */
    max_height?: number;

    /**
     * The maximum width in pixels available for the track. Only set for the `video`
     * type track.
     */
    max_width?: number;

    /**
     * The name of the track containing a human-readable description. The HLS manifest
     * will associate a subtitle `text` or `audio` track with this value. For example,
     * the value should be "English" for a subtitle text track for the `language_code`
     * value of `en-US`. This parameter is only set for `text` and `audio` track types.
     */
    name?: string;

    /**
     * Arbitrary user-supplied metadata set for the track either when creating the
     * asset or track. This parameter is only set for `text` type tracks. Max 255
     * characters.
     */
    passthrough?: string;

    /**
     * For an audio track, indicates that this is the primary audio track, ingested
     * from the main input for this asset. The primary audio track cannot be deleted.
     */
    primary?: boolean;

    /**
     * The status of the track. This parameter is only set for `text` type tracks.
     */
    status?: 'preparing' | 'ready' | 'errored' | 'deleted';

    /**
     * The source of the text contained in a Track of type `text`. Valid `text_source`
     * values are listed below.
     *
     * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
     *   Create Asset Track API.
     * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
     *   captions.
     * - `generated_vod`: Tracks generated by automatic speech recognition on an
     *   on-demand asset.
     * - `generated_live`: Tracks generated by automatic speech recognition on a live
     *   stream configured with `generated_subtitles`. 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.
     * - `generated_live_final`: Tracks generated by automatic speech recognition on a
     *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
     *   of these subtitles is improved compared to the corresponding `generated_live`
     *   tracks. 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.
     */
    text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

    /**
     * This parameter is only set for `text` type tracks.
     */
    text_type?: 'subtitles';

    /**
     * The type of track
     */
    type?: 'video' | 'audio' | 'text';
  }

  export namespace Data {
    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Error {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }
  }
}

export interface VideoAssetTrackReadyWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetTrackReadyWebhookEvent.Data;

  type: 'video.asset.track.ready';
}

export namespace VideoAssetTrackReadyWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Track
     */
    id?: string;

    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    asset_id?: string;

    /**
     * The confidence value (0-1) of the determined language. This value only is
     * available when automatic language detection is utilized in generated subtitles.
     */
    auto_language_confidence?: number;

    /**
     * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
     * This parameter is only set tracks where `type` is `text` and `text_type` is
     * `subtitles`.
     */
    closed_captions?: boolean;

    /**
     * The duration in seconds of the track media. This parameter is not set for `text`
     * type tracks. This field is optional and may not be set. The top level `duration`
     * field of an asset will always be set.
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    error?: Data.Error;

    /**
     * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
     * specification compliant value, or 'auto'. For example, `en` for English or
     * `en-US` for the US version of English. This parameter is only set for `text` and
     * `audio` track types. During automatic language detection for generated
     * subtitles, this value will be set to `auto` until the language is determined.
     */
    language_code?: string;

    /**
     * @deprecated Only set for the `audio` type track.
     */
    max_channel_layout?: string;

    /**
     * The maximum number of audio channels the track supports. Only set for the
     * `audio` type track.
     */
    max_channels?: number;

    /**
     * The maximum frame rate available for the track. Only set for the `video` type
     * track. This field may return `-1` if the frame rate of the input cannot be
     * reliably determined.
     */
    max_frame_rate?: number;

    /**
     * The maximum height in pixels available for the track. Only set for the `video`
     * type track.
     */
    max_height?: number;

    /**
     * The maximum width in pixels available for the track. Only set for the `video`
     * type track.
     */
    max_width?: number;

    /**
     * The name of the track containing a human-readable description. The HLS manifest
     * will associate a subtitle `text` or `audio` track with this value. For example,
     * the value should be "English" for a subtitle text track for the `language_code`
     * value of `en-US`. This parameter is only set for `text` and `audio` track types.
     */
    name?: string;

    /**
     * Arbitrary user-supplied metadata set for the track either when creating the
     * asset or track. This parameter is only set for `text` type tracks. Max 255
     * characters.
     */
    passthrough?: string;

    /**
     * For an audio track, indicates that this is the primary audio track, ingested
     * from the main input for this asset. The primary audio track cannot be deleted.
     */
    primary?: boolean;

    /**
     * The status of the track. This parameter is only set for `text` type tracks.
     */
    status?: 'preparing' | 'ready' | 'errored' | 'deleted';

    /**
     * The source of the text contained in a Track of type `text`. Valid `text_source`
     * values are listed below.
     *
     * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
     *   Create Asset Track API.
     * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
     *   captions.
     * - `generated_vod`: Tracks generated by automatic speech recognition on an
     *   on-demand asset.
     * - `generated_live`: Tracks generated by automatic speech recognition on a live
     *   stream configured with `generated_subtitles`. 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.
     * - `generated_live_final`: Tracks generated by automatic speech recognition on a
     *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
     *   of these subtitles is improved compared to the corresponding `generated_live`
     *   tracks. 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.
     */
    text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

    /**
     * This parameter is only set for `text` type tracks.
     */
    text_type?: 'subtitles';

    /**
     * The type of track
     */
    type?: 'video' | 'audio' | 'text';
  }

  export namespace Data {
    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Error {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }
  }
}

export interface VideoAssetTrackErroredWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetTrackErroredWebhookEvent.Data;

  type: 'video.asset.track.errored';
}

export namespace VideoAssetTrackErroredWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Track
     */
    id?: string;

    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    asset_id?: string;

    /**
     * The confidence value (0-1) of the determined language. This value only is
     * available when automatic language detection is utilized in generated subtitles.
     */
    auto_language_confidence?: number;

    /**
     * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
     * This parameter is only set tracks where `type` is `text` and `text_type` is
     * `subtitles`.
     */
    closed_captions?: boolean;

    /**
     * The duration in seconds of the track media. This parameter is not set for `text`
     * type tracks. This field is optional and may not be set. The top level `duration`
     * field of an asset will always be set.
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    error?: Data.Error;

    /**
     * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
     * specification compliant value, or 'auto'. For example, `en` for English or
     * `en-US` for the US version of English. This parameter is only set for `text` and
     * `audio` track types. During automatic language detection for generated
     * subtitles, this value will be set to `auto` until the language is determined.
     */
    language_code?: string;

    /**
     * @deprecated Only set for the `audio` type track.
     */
    max_channel_layout?: string;

    /**
     * The maximum number of audio channels the track supports. Only set for the
     * `audio` type track.
     */
    max_channels?: number;

    /**
     * The maximum frame rate available for the track. Only set for the `video` type
     * track. This field may return `-1` if the frame rate of the input cannot be
     * reliably determined.
     */
    max_frame_rate?: number;

    /**
     * The maximum height in pixels available for the track. Only set for the `video`
     * type track.
     */
    max_height?: number;

    /**
     * The maximum width in pixels available for the track. Only set for the `video`
     * type track.
     */
    max_width?: number;

    /**
     * The name of the track containing a human-readable description. The HLS manifest
     * will associate a subtitle `text` or `audio` track with this value. For example,
     * the value should be "English" for a subtitle text track for the `language_code`
     * value of `en-US`. This parameter is only set for `text` and `audio` track types.
     */
    name?: string;

    /**
     * Arbitrary user-supplied metadata set for the track either when creating the
     * asset or track. This parameter is only set for `text` type tracks. Max 255
     * characters.
     */
    passthrough?: string;

    /**
     * For an audio track, indicates that this is the primary audio track, ingested
     * from the main input for this asset. The primary audio track cannot be deleted.
     */
    primary?: boolean;

    /**
     * The status of the track. This parameter is only set for `text` type tracks.
     */
    status?: 'preparing' | 'ready' | 'errored' | 'deleted';

    /**
     * The source of the text contained in a Track of type `text`. Valid `text_source`
     * values are listed below.
     *
     * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
     *   Create Asset Track API.
     * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
     *   captions.
     * - `generated_vod`: Tracks generated by automatic speech recognition on an
     *   on-demand asset.
     * - `generated_live`: Tracks generated by automatic speech recognition on a live
     *   stream configured with `generated_subtitles`. 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.
     * - `generated_live_final`: Tracks generated by automatic speech recognition on a
     *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
     *   of these subtitles is improved compared to the corresponding `generated_live`
     *   tracks. 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.
     */
    text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

    /**
     * This parameter is only set for `text` type tracks.
     */
    text_type?: 'subtitles';

    /**
     * The type of track
     */
    type?: 'video' | 'audio' | 'text';
  }

  export namespace Data {
    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Error {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }
  }
}

export interface VideoAssetTrackDeletedWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetTrackDeletedWebhookEvent.Data;

  type: 'video.asset.track.deleted';
}

export namespace VideoAssetTrackDeletedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Track
     */
    id?: string;

    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    asset_id?: string;

    /**
     * The confidence value (0-1) of the determined language. This value only is
     * available when automatic language detection is utilized in generated subtitles.
     */
    auto_language_confidence?: number;

    /**
     * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
     * This parameter is only set tracks where `type` is `text` and `text_type` is
     * `subtitles`.
     */
    closed_captions?: boolean;

    /**
     * The duration in seconds of the track media. This parameter is not set for `text`
     * type tracks. This field is optional and may not be set. The top level `duration`
     * field of an asset will always be set.
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    error?: Data.Error;

    /**
     * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
     * specification compliant value, or 'auto'. For example, `en` for English or
     * `en-US` for the US version of English. This parameter is only set for `text` and
     * `audio` track types. During automatic language detection for generated
     * subtitles, this value will be set to `auto` until the language is determined.
     */
    language_code?: string;

    /**
     * @deprecated Only set for the `audio` type track.
     */
    max_channel_layout?: string;

    /**
     * The maximum number of audio channels the track supports. Only set for the
     * `audio` type track.
     */
    max_channels?: number;

    /**
     * The maximum frame rate available for the track. Only set for the `video` type
     * track. This field may return `-1` if the frame rate of the input cannot be
     * reliably determined.
     */
    max_frame_rate?: number;

    /**
     * The maximum height in pixels available for the track. Only set for the `video`
     * type track.
     */
    max_height?: number;

    /**
     * The maximum width in pixels available for the track. Only set for the `video`
     * type track.
     */
    max_width?: number;

    /**
     * The name of the track containing a human-readable description. The HLS manifest
     * will associate a subtitle `text` or `audio` track with this value. For example,
     * the value should be "English" for a subtitle text track for the `language_code`
     * value of `en-US`. This parameter is only set for `text` and `audio` track types.
     */
    name?: string;

    /**
     * Arbitrary user-supplied metadata set for the track either when creating the
     * asset or track. This parameter is only set for `text` type tracks. Max 255
     * characters.
     */
    passthrough?: string;

    /**
     * For an audio track, indicates that this is the primary audio track, ingested
     * from the main input for this asset. The primary audio track cannot be deleted.
     */
    primary?: boolean;

    /**
     * The status of the track. This parameter is only set for `text` type tracks.
     */
    status?: 'preparing' | 'ready' | 'errored' | 'deleted';

    /**
     * The source of the text contained in a Track of type `text`. Valid `text_source`
     * values are listed below.
     *
     * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
     *   Create Asset Track API.
     * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
     *   captions.
     * - `generated_vod`: Tracks generated by automatic speech recognition on an
     *   on-demand asset.
     * - `generated_live`: Tracks generated by automatic speech recognition on a live
     *   stream configured with `generated_subtitles`. 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.
     * - `generated_live_final`: Tracks generated by automatic speech recognition on a
     *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
     *   of these subtitles is improved compared to the corresponding `generated_live`
     *   tracks. 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.
     */
    text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

    /**
     * This parameter is only set for `text` type tracks.
     */
    text_type?: 'subtitles';

    /**
     * The type of track
     */
    type?: 'video' | 'audio' | 'text';
  }

  export namespace Data {
    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Error {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }
  }
}

export interface VideoAssetStaticRenditionCreatedWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetStaticRenditionCreatedWebhookEvent.Data;

  type: 'video.asset.static_rendition.created';
}

export namespace VideoAssetStaticRenditionCreatedWebhookEvent {
  export interface Data {
    /**
     * The ID of this static rendition, used in managing this static rendition. This
     * field is only valid for `static_renditions`, not for `mp4_support`.
     */
    id?: string;

    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    asset_id?: string;

    /**
     * The bitrate in bits per second
     */
    bitrate?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    error?: Data.Error;

    /**
     * Extension of the static rendition file
     */
    ext?: 'mp4' | 'm4a';

    /**
     * The file size in bytes
     */
    filesize?: string;

    /**
     * The height of the static rendition's file in pixels
     */
    height?: number;

    /**
     * Name of the static rendition file
     */
    name?:
      | 'low.mp4'
      | 'medium.mp4'
      | 'high.mp4'
      | 'highest.mp4'
      | 'audio.m4a'
      | 'capped-1080p.mp4'
      | '2160p.mp4'
      | '1440p.mp4'
      | '1080p.mp4'
      | '720p.mp4'
      | '540p.mp4'
      | '480p.mp4'
      | '360p.mp4'
      | '270p.mp4';

    /**
     * Arbitrary user-supplied metadata set for the static rendition. Max 255
     * characters.
     */
    passthrough?: string;

    /**
     * Indicates the resolution of this specific MP4 version of this asset. This field
     * is only valid for `static_renditions`, not for `mp4_support`.
     */
    resolution?:
      | 'highest'
      | 'audio-only'
      | '2160p'
      | '1440p'
      | '1080p'
      | '720p'
      | '540p'
      | '480p'
      | '360p'
      | '270p';

    /**
     * Indicates the resolution tier of this specific MP4 version of this asset. This
     * field is only valid for `static_renditions`, not for `mp4_support`.
     */
    resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

    /**
     * Indicates the status of this specific MP4 version of this asset. This field is
     * only valid for `static_renditions`, not for `mp4_support`.
     *
     * - `ready` indicates the MP4 has been generated and is ready for download
     * - `preparing` indicates the asset has not been ingested or the static rendition
     *   is still being generated after an asset is ready
     * - `skipped` indicates the static rendition will not be generated because the
     *   requested resolution conflicts with the asset attributes after the asset has
     *   been ingested
     * - `errored` indicates the static rendition cannot be generated. For example, an
     *   asset could not be ingested
     */
    status?: 'ready' | 'preparing' | 'skipped' | 'errored';

    /**
     * Indicates the static rendition type of this specific MP4 version of this asset.
     * This field is only valid for `static_renditions`, not for `mp4_support`.
     */
    type?: 'standard' | 'advanced';

    /**
     * The width of the static rendition's file in pixels
     */
    width?: number;
  }

  export namespace Data {
    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Error {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }
  }
}

export interface VideoAssetStaticRenditionReadyWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetStaticRenditionReadyWebhookEvent.Data;

  type: 'video.asset.static_rendition.ready';
}

export namespace VideoAssetStaticRenditionReadyWebhookEvent {
  export interface Data {
    /**
     * The ID of this static rendition, used in managing this static rendition. This
     * field is only valid for `static_renditions`, not for `mp4_support`.
     */
    id?: string;

    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    asset_id?: string;

    /**
     * The bitrate in bits per second
     */
    bitrate?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    error?: Data.Error;

    /**
     * Extension of the static rendition file
     */
    ext?: 'mp4' | 'm4a';

    /**
     * The file size in bytes
     */
    filesize?: string;

    /**
     * The height of the static rendition's file in pixels
     */
    height?: number;

    /**
     * Name of the static rendition file
     */
    name?:
      | 'low.mp4'
      | 'medium.mp4'
      | 'high.mp4'
      | 'highest.mp4'
      | 'audio.m4a'
      | 'capped-1080p.mp4'
      | '2160p.mp4'
      | '1440p.mp4'
      | '1080p.mp4'
      | '720p.mp4'
      | '540p.mp4'
      | '480p.mp4'
      | '360p.mp4'
      | '270p.mp4';

    /**
     * Arbitrary user-supplied metadata set for the static rendition. Max 255
     * characters.
     */
    passthrough?: string;

    /**
     * Indicates the resolution of this specific MP4 version of this asset. This field
     * is only valid for `static_renditions`, not for `mp4_support`.
     */
    resolution?:
      | 'highest'
      | 'audio-only'
      | '2160p'
      | '1440p'
      | '1080p'
      | '720p'
      | '540p'
      | '480p'
      | '360p'
      | '270p';

    /**
     * Indicates the resolution tier of this specific MP4 version of this asset. This
     * field is only valid for `static_renditions`, not for `mp4_support`.
     */
    resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

    /**
     * Indicates the status of this specific MP4 version of this asset. This field is
     * only valid for `static_renditions`, not for `mp4_support`.
     *
     * - `ready` indicates the MP4 has been generated and is ready for download
     * - `preparing` indicates the asset has not been ingested or the static rendition
     *   is still being generated after an asset is ready
     * - `skipped` indicates the static rendition will not be generated because the
     *   requested resolution conflicts with the asset attributes after the asset has
     *   been ingested
     * - `errored` indicates the static rendition cannot be generated. For example, an
     *   asset could not be ingested
     */
    status?: 'ready' | 'preparing' | 'skipped' | 'errored';

    /**
     * Indicates the static rendition type of this specific MP4 version of this asset.
     * This field is only valid for `static_renditions`, not for `mp4_support`.
     */
    type?: 'standard' | 'advanced';

    /**
     * The width of the static rendition's file in pixels
     */
    width?: number;
  }

  export namespace Data {
    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Error {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }
  }
}

export interface VideoAssetStaticRenditionErroredWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetStaticRenditionErroredWebhookEvent.Data;

  type: 'video.asset.static_rendition.errored';
}

export namespace VideoAssetStaticRenditionErroredWebhookEvent {
  export interface Data {
    /**
     * The ID of this static rendition, used in managing this static rendition. This
     * field is only valid for `static_renditions`, not for `mp4_support`.
     */
    id?: string;

    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    asset_id?: string;

    /**
     * The bitrate in bits per second
     */
    bitrate?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    error?: Data.Error;

    /**
     * Extension of the static rendition file
     */
    ext?: 'mp4' | 'm4a';

    /**
     * The file size in bytes
     */
    filesize?: string;

    /**
     * The height of the static rendition's file in pixels
     */
    height?: number;

    /**
     * Name of the static rendition file
     */
    name?:
      | 'low.mp4'
      | 'medium.mp4'
      | 'high.mp4'
      | 'highest.mp4'
      | 'audio.m4a'
      | 'capped-1080p.mp4'
      | '2160p.mp4'
      | '1440p.mp4'
      | '1080p.mp4'
      | '720p.mp4'
      | '540p.mp4'
      | '480p.mp4'
      | '360p.mp4'
      | '270p.mp4';

    /**
     * Arbitrary user-supplied metadata set for the static rendition. Max 255
     * characters.
     */
    passthrough?: string;

    /**
     * Indicates the resolution of this specific MP4 version of this asset. This field
     * is only valid for `static_renditions`, not for `mp4_support`.
     */
    resolution?:
      | 'highest'
      | 'audio-only'
      | '2160p'
      | '1440p'
      | '1080p'
      | '720p'
      | '540p'
      | '480p'
      | '360p'
      | '270p';

    /**
     * Indicates the resolution tier of this specific MP4 version of this asset. This
     * field is only valid for `static_renditions`, not for `mp4_support`.
     */
    resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

    /**
     * Indicates the status of this specific MP4 version of this asset. This field is
     * only valid for `static_renditions`, not for `mp4_support`.
     *
     * - `ready` indicates the MP4 has been generated and is ready for download
     * - `preparing` indicates the asset has not been ingested or the static rendition
     *   is still being generated after an asset is ready
     * - `skipped` indicates the static rendition will not be generated because the
     *   requested resolution conflicts with the asset attributes after the asset has
     *   been ingested
     * - `errored` indicates the static rendition cannot be generated. For example, an
     *   asset could not be ingested
     */
    status?: 'ready' | 'preparing' | 'skipped' | 'errored';

    /**
     * Indicates the static rendition type of this specific MP4 version of this asset.
     * This field is only valid for `static_renditions`, not for `mp4_support`.
     */
    type?: 'standard' | 'advanced';

    /**
     * The width of the static rendition's file in pixels
     */
    width?: number;
  }

  export namespace Data {
    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Error {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }
  }
}

export interface VideoAssetStaticRenditionDeletedWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetStaticRenditionDeletedWebhookEvent.Data;

  type: 'video.asset.static_rendition.deleted';
}

export namespace VideoAssetStaticRenditionDeletedWebhookEvent {
  export interface Data {
    /**
     * The ID of this static rendition, used in managing this static rendition. This
     * field is only valid for `static_renditions`, not for `mp4_support`.
     */
    id?: string;

    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    asset_id?: string;

    /**
     * The bitrate in bits per second
     */
    bitrate?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    error?: Data.Error;

    /**
     * Extension of the static rendition file
     */
    ext?: 'mp4' | 'm4a';

    /**
     * The file size in bytes
     */
    filesize?: string;

    /**
     * The height of the static rendition's file in pixels
     */
    height?: number;

    /**
     * Name of the static rendition file
     */
    name?:
      | 'low.mp4'
      | 'medium.mp4'
      | 'high.mp4'
      | 'highest.mp4'
      | 'audio.m4a'
      | 'capped-1080p.mp4'
      | '2160p.mp4'
      | '1440p.mp4'
      | '1080p.mp4'
      | '720p.mp4'
      | '540p.mp4'
      | '480p.mp4'
      | '360p.mp4'
      | '270p.mp4';

    /**
     * Arbitrary user-supplied metadata set for the static rendition. Max 255
     * characters.
     */
    passthrough?: string;

    /**
     * Indicates the resolution of this specific MP4 version of this asset. This field
     * is only valid for `static_renditions`, not for `mp4_support`.
     */
    resolution?:
      | 'highest'
      | 'audio-only'
      | '2160p'
      | '1440p'
      | '1080p'
      | '720p'
      | '540p'
      | '480p'
      | '360p'
      | '270p';

    /**
     * Indicates the resolution tier of this specific MP4 version of this asset. This
     * field is only valid for `static_renditions`, not for `mp4_support`.
     */
    resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

    /**
     * Indicates the status of this specific MP4 version of this asset. This field is
     * only valid for `static_renditions`, not for `mp4_support`.
     *
     * - `ready` indicates the MP4 has been generated and is ready for download
     * - `preparing` indicates the asset has not been ingested or the static rendition
     *   is still being generated after an asset is ready
     * - `skipped` indicates the static rendition will not be generated because the
     *   requested resolution conflicts with the asset attributes after the asset has
     *   been ingested
     * - `errored` indicates the static rendition cannot be generated. For example, an
     *   asset could not be ingested
     */
    status?: 'ready' | 'preparing' | 'skipped' | 'errored';

    /**
     * Indicates the static rendition type of this specific MP4 version of this asset.
     * This field is only valid for `static_renditions`, not for `mp4_support`.
     */
    type?: 'standard' | 'advanced';

    /**
     * The width of the static rendition's file in pixels
     */
    width?: number;
  }

  export namespace Data {
    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Error {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }
  }
}

export interface VideoAssetStaticRenditionSkippedWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetStaticRenditionSkippedWebhookEvent.Data;

  type: 'video.asset.static_rendition.skipped';
}

export namespace VideoAssetStaticRenditionSkippedWebhookEvent {
  export interface Data {
    /**
     * The ID of this static rendition, used in managing this static rendition. This
     * field is only valid for `static_renditions`, not for `mp4_support`.
     */
    id?: string;

    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    asset_id?: string;

    /**
     * The bitrate in bits per second
     */
    bitrate?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    error?: Data.Error;

    /**
     * Extension of the static rendition file
     */
    ext?: 'mp4' | 'm4a';

    /**
     * The file size in bytes
     */
    filesize?: string;

    /**
     * The height of the static rendition's file in pixels
     */
    height?: number;

    /**
     * Name of the static rendition file
     */
    name?:
      | 'low.mp4'
      | 'medium.mp4'
      | 'high.mp4'
      | 'highest.mp4'
      | 'audio.m4a'
      | 'capped-1080p.mp4'
      | '2160p.mp4'
      | '1440p.mp4'
      | '1080p.mp4'
      | '720p.mp4'
      | '540p.mp4'
      | '480p.mp4'
      | '360p.mp4'
      | '270p.mp4';

    /**
     * Arbitrary user-supplied metadata set for the static rendition. Max 255
     * characters.
     */
    passthrough?: string;

    /**
     * Indicates the resolution of this specific MP4 version of this asset. This field
     * is only valid for `static_renditions`, not for `mp4_support`.
     */
    resolution?:
      | 'highest'
      | 'audio-only'
      | '2160p'
      | '1440p'
      | '1080p'
      | '720p'
      | '540p'
      | '480p'
      | '360p'
      | '270p';

    /**
     * Indicates the resolution tier of this specific MP4 version of this asset. This
     * field is only valid for `static_renditions`, not for `mp4_support`.
     */
    resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

    /**
     * Indicates the status of this specific MP4 version of this asset. This field is
     * only valid for `static_renditions`, not for `mp4_support`.
     *
     * - `ready` indicates the MP4 has been generated and is ready for download
     * - `preparing` indicates the asset has not been ingested or the static rendition
     *   is still being generated after an asset is ready
     * - `skipped` indicates the static rendition will not be generated because the
     *   requested resolution conflicts with the asset attributes after the asset has
     *   been ingested
     * - `errored` indicates the static rendition cannot be generated. For example, an
     *   asset could not be ingested
     */
    status?: 'ready' | 'preparing' | 'skipped' | 'errored';

    /**
     * Indicates the static rendition type of this specific MP4 version of this asset.
     * This field is only valid for `static_renditions`, not for `mp4_support`.
     */
    type?: 'standard' | 'advanced';

    /**
     * The width of the static rendition's file in pixels
     */
    width?: number;
  }

  export namespace Data {
    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Error {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }
  }
}

export interface VideoAssetWarningWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetWarningWebhookEvent.Data;

  type: 'video.asset.warning';
}

export namespace VideoAssetWarningWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id?: string;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * The status of the asset.
     */
    status?: 'preparing' | 'ready' | 'errored';

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    warning?: Data.Warning;
  }

  export namespace Data {
    export interface Warning {
      message?: string;

      type?: string;
    }
  }
}

export interface VideoAssetNonStandardInputDetectedWebhookEvent extends BaseWebhookEvent {
  data: VideoAssetNonStandardInputDetectedWebhookEvent.Data;

  type: 'video.asset.non_standard_input_detected';
}

export namespace VideoAssetNonStandardInputDetectedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Asset. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * @deprecated This field is deprecated. Please use `video_quality` instead. The
     * encoding tier informs the cost, quality, and available platform features for the
     * asset. The default encoding tier for an account can be set in the Mux Dashboard.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    encoding_tier: 'smart' | 'baseline' | 'premium';

    master_access: 'temporary' | 'none';

    /**
     * Max resolution tier can be used to control the maximum `resolution_tier` your
     * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
     */
    max_resolution_tier: '1080p' | '1440p' | '2160p';

    /**
     * Detailed state information about the asset ingest process.
     */
    progress: Data.Progress;

    /**
     * The status of the asset.
     */
    status: 'preparing' | 'ready' | 'errored';

    /**
     * The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     */
    aspect_ratio?: string;

    /**
     * The duration of the asset in seconds (max duration for a single asset is 12
     * hours).
     */
    duration?: number;

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    errors?: Data.Errors;

    /**
     * The type of ingest used to create the asset.
     */
    ingest_type?: 'on_demand_url' | 'on_demand_direct_upload' | 'on_demand_clip' | 'live_rtmp' | 'live_srt';

    /**
     * Indicates whether the live stream that created this asset is currently `active`
     * and not in `idle` state. This is an optional parameter added when the asset is
     * created from a live stream.
     */
    is_live?: boolean;

    /**
     * Unique identifier for the live stream. This is an optional parameter added when
     * the asset is created from a live stream.
     */
    live_stream_id?: string;

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    master?: Data.Master;

    /**
     * The maximum frame rate that has been stored for the asset. The asset may be
     * delivered at lower frame rates depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored. This field may return -1
     * if the frame rate of the input cannot be reliably determined.
     */
    max_stored_frame_rate?: number;

    /**
     * @deprecated This field is deprecated. Please use `resolution_tier` instead. The
     * maximum resolution that has been stored for the asset. The asset may be
     * delivered at lower resolutions depending on the device and bandwidth, however it
     * cannot be delivered at a higher value than is stored.
     */
    max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    /**
     * @deprecated
     */
    mp4_support?: 'standard' | 'none' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    non_standard_input_reasons?: Data.NonStandardInputReasons;

    /**
     * Normalize the audio track loudness level. This parameter is only applicable to
     * on-demand (not live) assets.
     */
    normalize_audio?: boolean;

    /**
     * You can set this field to anything you want. It will be included in the asset
     * details and related webhooks. If you're looking for more structured metadata,
     * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
     * 255 characters**.
     */
    passthrough?: string;

    /**
     * @deprecated
     */
    per_title_encode?: boolean;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * An array of individual live stream recording sessions. A recording session is
     * created on each encoder connection during the live stream. Additionally any time
     * slate media is inserted during brief interruptions in the live stream media or
     * times when the live streaming software disconnects, a recording session
     * representing the slate media will be added with a "slate" type.
     */
    recording_times?: Array<Data.RecordingTime>;

    /**
     * The resolution tier that the asset was ingested at, affecting billing for ingest
     * & storage. This field also represents the highest resolution tier that the
     * content can be delivered at, however the actual resolution may be lower
     * depending on the device, bandwidth, and exact resolution of the uploaded asset.
     */
    resolution_tier?: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

    /**
     * Asset Identifier of the video used as the source for creating the clip.
     */
    source_asset_id?: string;

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    static_renditions?: Data.StaticRenditions;

    /**
     * True means this live stream is a test asset. A test asset can help evaluate the
     * Mux Video APIs without incurring any cost. There is no limit on number of test
     * assets created. Test assets are watermarked with the Mux logo, limited to 10
     * seconds, and deleted after 24 hrs.
     */
    test?: boolean;

    /**
     * The individual media tracks that make up an asset.
     */
    tracks?: Array<Data.Track>;

    /**
     * Unique identifier for the Direct Upload. This is an optional parameter added
     * when the asset is created from a direct upload.
     */
    upload_id?: string;

    /**
     * The video quality controls the cost, quality, and available platform features
     * for the asset. The default video quality for an account can be set in the Mux
     * Dashboard. This field replaces the deprecated `encoding_tier` value.
     * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     */
    video_quality?: 'basic' | 'plus' | 'premium';
  }

  export namespace Data {
    /**
     * Detailed state information about the asset ingest process.
     */
    export interface Progress {
      /**
       * Represents the estimated completion percentage. Returns `0 - 100` when in
       * `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or
       * `errored` state.
       */
      progress: number;

      /**
       * The detailed state of the asset ingest process. This field is useful for
       * relaying more granular processing information to end users when a
       * [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).
       *
       * - `ingesting`: Asset is being ingested (initial processing before or after
       *   transcoding). While in this state, the `progress` percentage will be 0.
       * - `transcoding`: Asset is undergoing non-standard transcoding.
       * - `completed`: Asset processing is complete (`status` is `ready`). While in this
       *   state, the `progress` percentage will be 100.
       * - `live`: Asset is a live stream currently in progress. While in this state, the
       *   `progress` percentage will be -1.
       * - `errored`: Asset has encountered an error (`status` is `errored`). While in
       *   this state, the `progress` percentage will be -1.
       */
      state: 'ingesting' | 'transcoding' | 'completed' | 'live' | 'errored';
    }

    /**
     * Object that describes any errors that happened when processing this asset.
     */
    export interface Errors {
      /**
       * Error messages with more details.
       */
      messages?: Array<string>;

      /**
       * The type of error that occurred for this asset.
       */
      type?: string;
    }

    /**
     * An object containing the current status of Master Access and the link to the
     * Master MP4 file when ready. This object does not exist if `master_access` is set
     * to `none` and when the temporary URL expires.
     */
    export interface Master {
      status?: 'ready' | 'preparing' | 'errored';

      /**
       * The temporary URL to the master version of the video, as an MP4 file. This URL
       * will expire after 24 hours.
       */
      url?: string;
    }

    /**
     * Customer provided metadata about this asset.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * This is an identifier you provide to keep track of the creator of the asset. Max
       * 128 code points.
       */
      creator_id?: string;

      /**
       * This is an identifier you provide to link the asset to your own data. Max 128
       * code points.
       */
      external_id?: string;

      /**
       * The asset title. Max 512 code points.
       */
      title?: string;
    }

    /**
     * An object containing one or more reasons the input file is non-standard. See
     * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
     * for more information on what a standard input is defined as. This object only
     * exists on on-demand assets that have non-standard inputs, so if missing you can
     * assume the input qualifies as standard.
     */
    export interface NonStandardInputReasons {
      /**
       * The audio codec used on the input file. Non-AAC audio codecs are non-standard.
       */
      audio_codec?: string;

      /**
       * Audio Edit List reason indicates that the input file's audio track contains a
       * complex Edit Decision List.
       */
      audio_edit_list?: 'non-standard';

      /**
       * The video pixel aspect ratio of the input file.
       */
      pixel_aspect_ratio?: string;

      /**
       * A catch-all reason when the input file in created with non-standard encoding
       * parameters.
       */
      unexpected_media_file_parameters?: 'non-standard';

      unexpected_video_parameters?: string;

      /**
       * The video pixel format, as a string, returned by libav. Considered non-standard
       * if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
       */
      unsupported_pixel_format?: string;

      /**
       * The video bitrate of the input file is `high`. This parameter is present when
       * the average bitrate of any key frame interval (also known as Group of Pictures
       * or GOP) is higher than what's considered standard which typically is 16 Mbps.
       */
      video_bitrate?: 'high';

      /**
       * The video codec used on the input file. For example, the input file encoded with
       * `av1` video codec is non-standard and the value of this parameter is `av1`.
       */
      video_codec?: string;

      /**
       * Video Edit List reason indicates that the input file's video track contains a
       * complex Edit Decision List.
       */
      video_edit_list?: 'non-standard';

      /**
       * The video frame rate of the input file. Video with average frames per second
       * (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value
       * indicates Mux could not determine the frame rate of the video track.
       */
      video_frame_rate?: string;

      /**
       * The video key frame Interval (also called as Group of Picture or GOP) of the
       * input file is `high`. This parameter is present when the gop is greater than 20
       * seconds.
       */
      video_gop_size?: 'high';

      /**
       * The video resolution of the input file. Video resolution higher than 2048 pixels
       * on any one dimension (height or width) is considered non-standard, The
       * resolution value is presented as `width` x `height` in pixels.
       */
      video_resolution?: string;
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface RecordingTime {
      /**
       * The duration of the live stream recorded. The time value is in seconds.
       */
      duration?: number;

      started_at?: RecordingTime.StartedAt;

      /**
       * The type of media represented by the recording session, either `content` for
       * normal stream content or `slate` for slate media inserted during stream
       * interruptions.
       */
      type?: 'content' | 'slate';
    }

    export namespace RecordingTime {
      export interface StartedAt {
        seconds: number;

        nanos?: number;
      }
    }

    /**
     * An object containing the current status of any static renditions (mp4s). The
     * object does not exist if no static renditions have been requested. See
     * [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions)
     * for more information.
     */
    export interface StaticRenditions {
      /**
       * Array of file objects.
       */
      files?: Array<StaticRenditions.File>;

      /**
       * Indicates the status of downloadable MP4 versions of this asset. This field is
       * only valid when `mp4_support` is enabled
       */
      status?: 'ready' | 'preparing' | 'disabled' | 'errored';
    }

    export namespace StaticRenditions {
      export interface File {
        /**
         * The ID of this static rendition, used in managing this static rendition. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        id?: string;

        /**
         * The bitrate in bits per second
         */
        bitrate?: number;

        /**
         * Extension of the static rendition file
         */
        ext?: 'mp4' | 'm4a';

        /**
         * The file size in bytes
         */
        filesize?: number;

        /**
         * The height of the static rendition's file in pixels
         */
        height?: number;

        /**
         * Name of the static rendition file
         */
        name?:
          | 'low.mp4'
          | 'medium.mp4'
          | 'high.mp4'
          | 'highest.mp4'
          | 'audio.m4a'
          | 'capped-1080p.mp4'
          | '2160p.mp4'
          | '1440p.mp4'
          | '1080p.mp4'
          | '720p.mp4'
          | '540p.mp4'
          | '480p.mp4'
          | '360p.mp4'
          | '270p.mp4';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;

        /**
         * Indicates the resolution of this specific MP4 version of this asset. This field
         * is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution?:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Indicates the resolution tier of this specific MP4 version of this asset. This
         * field is only valid for `static_renditions`, not for `mp4_support`.
         */
        resolution_tier?: '2160p' | '1440p' | '1080p' | '720p' | 'audio-only';

        /**
         * Indicates the status of this specific MP4 version of this asset. This field is
         * only valid for `static_renditions`, not for `mp4_support`.
         *
         * - `ready` indicates the MP4 has been generated and is ready for download
         * - `preparing` indicates the asset has not been ingested or the static rendition
         *   is still being generated after an asset is ready
         * - `skipped` indicates the static rendition will not be generated because the
         *   requested resolution conflicts with the asset attributes after the asset has
         *   been ingested
         * - `errored` indicates the static rendition cannot be generated. For example, an
         *   asset could not be ingested
         */
        status?: 'ready' | 'preparing' | 'skipped' | 'errored';

        /**
         * Indicates the static rendition type of this specific MP4 version of this asset.
         * This field is only valid for `static_renditions`, not for `mp4_support`.
         */
        type?: 'standard' | 'advanced';

        /**
         * The width of the static rendition's file in pixels
         */
        width?: number;
      }
    }

    export interface Track {
      /**
       * Unique identifier for the Track
       */
      id?: string;

      /**
       * The confidence value (0-1) of the determined language. This value only is
       * available when automatic language detection is utilized in generated subtitles.
       */
      auto_language_confidence?: number;

      /**
       * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
       * This parameter is only set tracks where `type` is `text` and `text_type` is
       * `subtitles`.
       */
      closed_captions?: boolean;

      /**
       * The duration in seconds of the track media. This parameter is not set for `text`
       * type tracks. This field is optional and may not be set. The top level `duration`
       * field of an asset will always be set.
       */
      duration?: number;

      /**
       * Object that describes any errors that happened when processing this asset.
       */
      error?: Track.Error;

      /**
       * The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47)
       * specification compliant value, or 'auto'. For example, `en` for English or
       * `en-US` for the US version of English. This parameter is only set for `text` and
       * `audio` track types. During automatic language detection for generated
       * subtitles, this value will be set to `auto` until the language is determined.
       */
      language_code?: string;

      /**
       * @deprecated Only set for the `audio` type track.
       */
      max_channel_layout?: string;

      /**
       * The maximum number of audio channels the track supports. Only set for the
       * `audio` type track.
       */
      max_channels?: number;

      /**
       * The maximum frame rate available for the track. Only set for the `video` type
       * track. This field may return `-1` if the frame rate of the input cannot be
       * reliably determined.
       */
      max_frame_rate?: number;

      /**
       * The maximum height in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_height?: number;

      /**
       * The maximum width in pixels available for the track. Only set for the `video`
       * type track.
       */
      max_width?: number;

      /**
       * The name of the track containing a human-readable description. The HLS manifest
       * will associate a subtitle `text` or `audio` track with this value. For example,
       * the value should be "English" for a subtitle text track for the `language_code`
       * value of `en-US`. This parameter is only set for `text` and `audio` track types.
       */
      name?: string;

      /**
       * Arbitrary user-supplied metadata set for the track either when creating the
       * asset or track. This parameter is only set for `text` type tracks. Max 255
       * characters.
       */
      passthrough?: string;

      /**
       * For an audio track, indicates that this is the primary audio track, ingested
       * from the main input for this asset. The primary audio track cannot be deleted.
       */
      primary?: boolean;

      /**
       * The status of the track. This parameter is only set for `text` type tracks.
       */
      status?: 'preparing' | 'ready' | 'errored' | 'deleted';

      /**
       * The source of the text contained in a Track of type `text`. Valid `text_source`
       * values are listed below.
       *
       * - `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the
       *   Create Asset Track API.
       * - `embedded`: Tracks extracted from an embedded stream of CEA-608 closed
       *   captions.
       * - `generated_vod`: Tracks generated by automatic speech recognition on an
       *   on-demand asset.
       * - `generated_live`: Tracks generated by automatic speech recognition on a live
       *   stream configured with `generated_subtitles`. 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.
       * - `generated_live_final`: Tracks generated by automatic speech recognition on a
       *   live stream using `generated_subtitles`. The accuracy, timing, and formatting
       *   of these subtitles is improved compared to the corresponding `generated_live`
       *   tracks. 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.
       */
      text_source?: 'uploaded' | 'embedded' | 'generated_live' | 'generated_live_final' | 'generated_vod';

      /**
       * This parameter is only set for `text` type tracks.
       */
      text_type?: 'subtitles';

      /**
       * The type of track
       */
      type?: 'video' | 'audio' | 'text';
    }

    export namespace Track {
      /**
       * Object that describes any errors that happened when processing this asset.
       */
      export interface Error {
        /**
         * Error messages with more details.
         */
        messages?: Array<string>;

        /**
         * The type of error that occurred for this asset.
         */
        type?: string;
      }
    }
  }
}

export interface VideoUploadAssetCreatedWebhookEvent extends BaseWebhookEvent {
  data: VideoUploadAssetCreatedWebhookEvent.Data;

  type: 'video.upload.asset_created';
}

export namespace VideoUploadAssetCreatedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Direct Upload.
     */
    id: string;

    /**
     * If the upload URL will be used in a browser, you must specify the origin in
     * order for the signed URL to have the correct CORS headers.
     */
    cors_origin: string;

    status: 'waiting' | 'asset_created' | 'errored' | 'cancelled' | 'timed_out';

    /**
     * Max time in seconds for the signed upload URL to be valid. If a successful
     * upload has not occurred before the timeout limit, the direct upload is marked
     * `timed_out`
     */
    timeout: number;

    /**
     * Only set once the upload is in the `asset_created` state.
     */
    asset_id?: string;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Indicates if this is a test Direct Upload, in which case the Asset that gets
     * created will be a `test` Asset.
     */
    test?: boolean;

    /**
     * The URL to upload the associated source media to.
     */
    url?: string;
  }

  export namespace Data {
    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }
  }
}

export interface VideoUploadCancelledWebhookEvent extends BaseWebhookEvent {
  data: VideoUploadCancelledWebhookEvent.Data;

  type: 'video.upload.cancelled';
}

export namespace VideoUploadCancelledWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Direct Upload.
     */
    id: string;

    /**
     * If the upload URL will be used in a browser, you must specify the origin in
     * order for the signed URL to have the correct CORS headers.
     */
    cors_origin: string;

    status: 'waiting' | 'asset_created' | 'errored' | 'cancelled' | 'timed_out';

    /**
     * Max time in seconds for the signed upload URL to be valid. If a successful
     * upload has not occurred before the timeout limit, the direct upload is marked
     * `timed_out`
     */
    timeout: number;

    /**
     * Only set once the upload is in the `asset_created` state.
     */
    asset_id?: string;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Indicates if this is a test Direct Upload, in which case the Asset that gets
     * created will be a `test` Asset.
     */
    test?: boolean;

    /**
     * The URL to upload the associated source media to.
     */
    url?: string;
  }

  export namespace Data {
    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }
  }
}

export interface VideoUploadCreatedWebhookEvent extends BaseWebhookEvent {
  data: VideoUploadCreatedWebhookEvent.Data;

  type: 'video.upload.created';
}

export namespace VideoUploadCreatedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Direct Upload.
     */
    id: string;

    /**
     * If the upload URL will be used in a browser, you must specify the origin in
     * order for the signed URL to have the correct CORS headers.
     */
    cors_origin: string;

    status: 'waiting' | 'asset_created' | 'errored' | 'cancelled' | 'timed_out';

    /**
     * Max time in seconds for the signed upload URL to be valid. If a successful
     * upload has not occurred before the timeout limit, the direct upload is marked
     * `timed_out`
     */
    timeout: number;

    /**
     * Only set once the upload is in the `asset_created` state.
     */
    asset_id?: string;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Indicates if this is a test Direct Upload, in which case the Asset that gets
     * created will be a `test` Asset.
     */
    test?: boolean;

    /**
     * The URL to upload the associated source media to.
     */
    url?: string;
  }

  export namespace Data {
    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }
  }
}

export interface VideoUploadErroredWebhookEvent extends BaseWebhookEvent {
  data: VideoUploadErroredWebhookEvent.Data;

  type: 'video.upload.errored';
}

export namespace VideoUploadErroredWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Direct Upload.
     */
    id: string;

    /**
     * If the upload URL will be used in a browser, you must specify the origin in
     * order for the signed URL to have the correct CORS headers.
     */
    cors_origin: string;

    status: 'waiting' | 'asset_created' | 'errored' | 'cancelled' | 'timed_out';

    /**
     * Max time in seconds for the signed upload URL to be valid. If a successful
     * upload has not occurred before the timeout limit, the direct upload is marked
     * `timed_out`
     */
    timeout: number;

    /**
     * Only set once the upload is in the `asset_created` state.
     */
    asset_id?: string;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Indicates if this is a test Direct Upload, in which case the Asset that gets
     * created will be a `test` Asset.
     */
    test?: boolean;

    /**
     * The URL to upload the associated source media to.
     */
    url?: string;
  }

  export namespace Data {
    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }
  }
}

export interface VideoLiveStreamCreatedWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamCreatedWebhookEvent.Data;

  type: 'video.live_stream.created';
}

export namespace VideoLiveStreamCreatedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * 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.
     */
    latency_mode: 'low' | 'reduced' | 'standard';

    /**
     * The time in seconds a live stream may be continuously active before being
     * disconnected. Defaults to 12 hours.
     */
    max_continuous_duration: number;

    /**
     * `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.
     */
    status: 'active' | 'idle' | 'disabled';

    /**
     * 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.
     */
    stream_key: string;

    /**
     * The Asset that is currently being created if there is an active broadcast.
     */
    active_asset_id?: string;

    /**
     * The protocol used for the active ingest stream. This is only set when the live
     * stream is active.
     */
    active_ingest_protocol?: 'rtmp' | 'srt';

    /**
     * The live stream only processes the audio track if the value is set to true. Mux
     * drops the video track if broadcasted.
     */
    audio_only?: boolean;

    connected?: boolean;

    /**
     * Describes the embedded closed caption configuration of the incoming live stream.
     */
    embedded_subtitles?: Array<Data.EmbeddedSubtitle>;

    /**
     * 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.
     */
    generated_subtitles?: Array<Data.GeneratedSubtitle>;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Setting this option will enable compatibility with the LL-HLS
     * specification for low-latency streaming. This typically has lower latency than
     * Reduced Latency streams, and cannot be combined with Reduced Latency.
     */
    low_latency?: boolean;

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Arbitrary user-supplied metadata set for the asset. Max 255 characters.
     */
    passthrough?: string;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * 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.
     */
    recent_asset_ids?: Array<string>;

    /**
     * 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.
     */
    reconnect_slate_url?: string;

    /**
     * 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.
     */
    reconnect_window?: number;

    recording?: boolean;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Set this if you want lower latency for your live stream. See the
     * [Reduce live stream latency guide](https://docs.mux.com/guides/reduce-live-stream-latency)
     * to understand the tradeoffs.
     */
    reduced_latency?: boolean;

    /**
     * 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](https://docs.mux.com/guides/stream-live-to-3rd-party-platforms).
     */
    simulcast_targets?: Array<Data.SimulcastTarget>;

    /**
     * Unique key used for encrypting a stream to a Mux SRT endpoint. Max 64
     * characters.
     */
    srt_passphrase?: string;

    /**
     * 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.
     */
    test?: boolean;

    /**
     * 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.
     */
    use_slate_for_standard_latency?: boolean;
  }

  export namespace Data {
    export interface EmbeddedSubtitle {
      /**
       * CEA-608 caption channel to read data from.
       */
      language_channel: 'cc1' | 'cc2' | 'cc3' | 'cc4';

      /**
       * The language of the closed caption stream. Value must be BCP 47 compliant.
       */
      language_code: string;

      /**
       * A name for this live stream closed caption track.
       */
      name: string;

      /**
       * Arbitrary user-supplied metadata set for the live stream closed caption track.
       * Max 255 characters.
       */
      passthrough?: string;
    }

    export interface GeneratedSubtitle {
      /**
       * The language of the audio from which subtitles are generated.
       */
      language_code: 'en' | 'en-US' | 'es' | 'fr' | 'de' | 'pt' | 'it';

      /**
       * A name for this live stream subtitle track.
       */
      name: string;

      /**
       * Arbitrary metadata set for the live stream subtitle track. Max 255 characters.
       */
      passthrough?: string;

      /**
       * 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.
       */
      transcription_vocabulary_ids?: Array<string>;
    }

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * The live stream title. Max 512 code points.
       */
      title?: string;
    }

    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface SimulcastTarget {
      /**
       * ID of the Simulcast Target
       */
      id: string;

      /**
       * 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.
       */
      status: 'idle' | 'starting' | 'broadcasting' | 'errored';

      /**
       * 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.
       */
      url: string;

      /**
       * 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.
       */
      error_severity?: 'normal' | 'fatal';

      /**
       * Arbitrary user-supplied metadata set when creating a simulcast target.
       */
      passthrough?: string;

      /**
       * 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.
       */
      stream_key?: string;
    }
  }
}

export interface VideoLiveStreamConnectedWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamConnectedWebhookEvent.Data;

  type: 'video.live_stream.connected';
}

export namespace VideoLiveStreamConnectedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * 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.
     */
    latency_mode: 'low' | 'reduced' | 'standard';

    /**
     * The time in seconds a live stream may be continuously active before being
     * disconnected. Defaults to 12 hours.
     */
    max_continuous_duration: number;

    /**
     * `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.
     */
    status: 'active' | 'idle' | 'disabled';

    /**
     * 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.
     */
    stream_key: string;

    /**
     * The Asset that is currently being created if there is an active broadcast.
     */
    active_asset_id?: string;

    /**
     * The protocol used for the active ingest stream. This is only set when the live
     * stream is active.
     */
    active_ingest_protocol?: 'rtmp' | 'srt';

    /**
     * The live stream only processes the audio track if the value is set to true. Mux
     * drops the video track if broadcasted.
     */
    audio_only?: boolean;

    connected?: boolean;

    /**
     * Describes the embedded closed caption configuration of the incoming live stream.
     */
    embedded_subtitles?: Array<Data.EmbeddedSubtitle>;

    /**
     * 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.
     */
    generated_subtitles?: Array<Data.GeneratedSubtitle>;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Setting this option will enable compatibility with the LL-HLS
     * specification for low-latency streaming. This typically has lower latency than
     * Reduced Latency streams, and cannot be combined with Reduced Latency.
     */
    low_latency?: boolean;

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Arbitrary user-supplied metadata set for the asset. Max 255 characters.
     */
    passthrough?: string;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * 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.
     */
    recent_asset_ids?: Array<string>;

    /**
     * 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.
     */
    reconnect_slate_url?: string;

    /**
     * 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.
     */
    reconnect_window?: number;

    recording?: boolean;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Set this if you want lower latency for your live stream. See the
     * [Reduce live stream latency guide](https://docs.mux.com/guides/reduce-live-stream-latency)
     * to understand the tradeoffs.
     */
    reduced_latency?: boolean;

    /**
     * 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](https://docs.mux.com/guides/stream-live-to-3rd-party-platforms).
     */
    simulcast_targets?: Array<Data.SimulcastTarget>;

    /**
     * Unique key used for encrypting a stream to a Mux SRT endpoint. Max 64
     * characters.
     */
    srt_passphrase?: string;

    /**
     * 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.
     */
    test?: boolean;

    /**
     * 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.
     */
    use_slate_for_standard_latency?: boolean;
  }

  export namespace Data {
    export interface EmbeddedSubtitle {
      /**
       * CEA-608 caption channel to read data from.
       */
      language_channel: 'cc1' | 'cc2' | 'cc3' | 'cc4';

      /**
       * The language of the closed caption stream. Value must be BCP 47 compliant.
       */
      language_code: string;

      /**
       * A name for this live stream closed caption track.
       */
      name: string;

      /**
       * Arbitrary user-supplied metadata set for the live stream closed caption track.
       * Max 255 characters.
       */
      passthrough?: string;
    }

    export interface GeneratedSubtitle {
      /**
       * The language of the audio from which subtitles are generated.
       */
      language_code: 'en' | 'en-US' | 'es' | 'fr' | 'de' | 'pt' | 'it';

      /**
       * A name for this live stream subtitle track.
       */
      name: string;

      /**
       * Arbitrary metadata set for the live stream subtitle track. Max 255 characters.
       */
      passthrough?: string;

      /**
       * 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.
       */
      transcription_vocabulary_ids?: Array<string>;
    }

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * The live stream title. Max 512 code points.
       */
      title?: string;
    }

    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface SimulcastTarget {
      /**
       * ID of the Simulcast Target
       */
      id: string;

      /**
       * 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.
       */
      status: 'idle' | 'starting' | 'broadcasting' | 'errored';

      /**
       * 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.
       */
      url: string;

      /**
       * 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.
       */
      error_severity?: 'normal' | 'fatal';

      /**
       * Arbitrary user-supplied metadata set when creating a simulcast target.
       */
      passthrough?: string;

      /**
       * 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.
       */
      stream_key?: string;
    }
  }
}

export interface VideoLiveStreamRecordingWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamRecordingWebhookEvent.Data;

  type: 'video.live_stream.recording';
}

export namespace VideoLiveStreamRecordingWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * 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.
     */
    latency_mode: 'low' | 'reduced' | 'standard';

    /**
     * The time in seconds a live stream may be continuously active before being
     * disconnected. Defaults to 12 hours.
     */
    max_continuous_duration: number;

    /**
     * `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.
     */
    status: 'active' | 'idle' | 'disabled';

    /**
     * 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.
     */
    stream_key: string;

    /**
     * The Asset that is currently being created if there is an active broadcast.
     */
    active_asset_id?: string;

    /**
     * The protocol used for the active ingest stream. This is only set when the live
     * stream is active.
     */
    active_ingest_protocol?: 'rtmp' | 'srt';

    /**
     * The live stream only processes the audio track if the value is set to true. Mux
     * drops the video track if broadcasted.
     */
    audio_only?: boolean;

    connected?: boolean;

    /**
     * Describes the embedded closed caption configuration of the incoming live stream.
     */
    embedded_subtitles?: Array<Data.EmbeddedSubtitle>;

    /**
     * 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.
     */
    generated_subtitles?: Array<Data.GeneratedSubtitle>;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Setting this option will enable compatibility with the LL-HLS
     * specification for low-latency streaming. This typically has lower latency than
     * Reduced Latency streams, and cannot be combined with Reduced Latency.
     */
    low_latency?: boolean;

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Arbitrary user-supplied metadata set for the asset. Max 255 characters.
     */
    passthrough?: string;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * 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.
     */
    recent_asset_ids?: Array<string>;

    /**
     * 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.
     */
    reconnect_slate_url?: string;

    /**
     * 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.
     */
    reconnect_window?: number;

    recording?: boolean;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Set this if you want lower latency for your live stream. See the
     * [Reduce live stream latency guide](https://docs.mux.com/guides/reduce-live-stream-latency)
     * to understand the tradeoffs.
     */
    reduced_latency?: boolean;

    /**
     * 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](https://docs.mux.com/guides/stream-live-to-3rd-party-platforms).
     */
    simulcast_targets?: Array<Data.SimulcastTarget>;

    /**
     * Unique key used for encrypting a stream to a Mux SRT endpoint. Max 64
     * characters.
     */
    srt_passphrase?: string;

    /**
     * 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.
     */
    test?: boolean;

    /**
     * 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.
     */
    use_slate_for_standard_latency?: boolean;
  }

  export namespace Data {
    export interface EmbeddedSubtitle {
      /**
       * CEA-608 caption channel to read data from.
       */
      language_channel: 'cc1' | 'cc2' | 'cc3' | 'cc4';

      /**
       * The language of the closed caption stream. Value must be BCP 47 compliant.
       */
      language_code: string;

      /**
       * A name for this live stream closed caption track.
       */
      name: string;

      /**
       * Arbitrary user-supplied metadata set for the live stream closed caption track.
       * Max 255 characters.
       */
      passthrough?: string;
    }

    export interface GeneratedSubtitle {
      /**
       * The language of the audio from which subtitles are generated.
       */
      language_code: 'en' | 'en-US' | 'es' | 'fr' | 'de' | 'pt' | 'it';

      /**
       * A name for this live stream subtitle track.
       */
      name: string;

      /**
       * Arbitrary metadata set for the live stream subtitle track. Max 255 characters.
       */
      passthrough?: string;

      /**
       * 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.
       */
      transcription_vocabulary_ids?: Array<string>;
    }

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * The live stream title. Max 512 code points.
       */
      title?: string;
    }

    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface SimulcastTarget {
      /**
       * ID of the Simulcast Target
       */
      id: string;

      /**
       * 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.
       */
      status: 'idle' | 'starting' | 'broadcasting' | 'errored';

      /**
       * 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.
       */
      url: string;

      /**
       * 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.
       */
      error_severity?: 'normal' | 'fatal';

      /**
       * Arbitrary user-supplied metadata set when creating a simulcast target.
       */
      passthrough?: string;

      /**
       * 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.
       */
      stream_key?: string;
    }
  }
}

export interface VideoLiveStreamActiveWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamActiveWebhookEvent.Data;

  type: 'video.live_stream.active';
}

export namespace VideoLiveStreamActiveWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * 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.
     */
    latency_mode: 'low' | 'reduced' | 'standard';

    /**
     * The time in seconds a live stream may be continuously active before being
     * disconnected. Defaults to 12 hours.
     */
    max_continuous_duration: number;

    /**
     * `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.
     */
    status: 'active' | 'idle' | 'disabled';

    /**
     * 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.
     */
    stream_key: string;

    /**
     * The Asset that is currently being created if there is an active broadcast.
     */
    active_asset_id?: string;

    /**
     * The protocol used for the active ingest stream. This is only set when the live
     * stream is active.
     */
    active_ingest_protocol?: 'rtmp' | 'srt';

    /**
     * The live stream only processes the audio track if the value is set to true. Mux
     * drops the video track if broadcasted.
     */
    audio_only?: boolean;

    connected?: boolean;

    /**
     * Describes the embedded closed caption configuration of the incoming live stream.
     */
    embedded_subtitles?: Array<Data.EmbeddedSubtitle>;

    /**
     * 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.
     */
    generated_subtitles?: Array<Data.GeneratedSubtitle>;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Setting this option will enable compatibility with the LL-HLS
     * specification for low-latency streaming. This typically has lower latency than
     * Reduced Latency streams, and cannot be combined with Reduced Latency.
     */
    low_latency?: boolean;

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Arbitrary user-supplied metadata set for the asset. Max 255 characters.
     */
    passthrough?: string;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * 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.
     */
    recent_asset_ids?: Array<string>;

    /**
     * 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.
     */
    reconnect_slate_url?: string;

    /**
     * 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.
     */
    reconnect_window?: number;

    recording?: boolean;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Set this if you want lower latency for your live stream. See the
     * [Reduce live stream latency guide](https://docs.mux.com/guides/reduce-live-stream-latency)
     * to understand the tradeoffs.
     */
    reduced_latency?: boolean;

    /**
     * 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](https://docs.mux.com/guides/stream-live-to-3rd-party-platforms).
     */
    simulcast_targets?: Array<Data.SimulcastTarget>;

    /**
     * Unique key used for encrypting a stream to a Mux SRT endpoint. Max 64
     * characters.
     */
    srt_passphrase?: string;

    /**
     * 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.
     */
    test?: boolean;

    /**
     * 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.
     */
    use_slate_for_standard_latency?: boolean;
  }

  export namespace Data {
    export interface EmbeddedSubtitle {
      /**
       * CEA-608 caption channel to read data from.
       */
      language_channel: 'cc1' | 'cc2' | 'cc3' | 'cc4';

      /**
       * The language of the closed caption stream. Value must be BCP 47 compliant.
       */
      language_code: string;

      /**
       * A name for this live stream closed caption track.
       */
      name: string;

      /**
       * Arbitrary user-supplied metadata set for the live stream closed caption track.
       * Max 255 characters.
       */
      passthrough?: string;
    }

    export interface GeneratedSubtitle {
      /**
       * The language of the audio from which subtitles are generated.
       */
      language_code: 'en' | 'en-US' | 'es' | 'fr' | 'de' | 'pt' | 'it';

      /**
       * A name for this live stream subtitle track.
       */
      name: string;

      /**
       * Arbitrary metadata set for the live stream subtitle track. Max 255 characters.
       */
      passthrough?: string;

      /**
       * 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.
       */
      transcription_vocabulary_ids?: Array<string>;
    }

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * The live stream title. Max 512 code points.
       */
      title?: string;
    }

    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface SimulcastTarget {
      /**
       * ID of the Simulcast Target
       */
      id: string;

      /**
       * 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.
       */
      status: 'idle' | 'starting' | 'broadcasting' | 'errored';

      /**
       * 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.
       */
      url: string;

      /**
       * 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.
       */
      error_severity?: 'normal' | 'fatal';

      /**
       * Arbitrary user-supplied metadata set when creating a simulcast target.
       */
      passthrough?: string;

      /**
       * 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.
       */
      stream_key?: string;
    }
  }
}

export interface VideoLiveStreamDisconnectedWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamDisconnectedWebhookEvent.Data;

  type: 'video.live_stream.disconnected';
}

export namespace VideoLiveStreamDisconnectedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * 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.
     */
    latency_mode: 'low' | 'reduced' | 'standard';

    /**
     * The time in seconds a live stream may be continuously active before being
     * disconnected. Defaults to 12 hours.
     */
    max_continuous_duration: number;

    /**
     * `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.
     */
    status: 'active' | 'idle' | 'disabled';

    /**
     * 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.
     */
    stream_key: string;

    /**
     * The Asset that is currently being created if there is an active broadcast.
     */
    active_asset_id?: string;

    /**
     * The protocol used for the active ingest stream. This is only set when the live
     * stream is active.
     */
    active_ingest_protocol?: 'rtmp' | 'srt';

    /**
     * The live stream only processes the audio track if the value is set to true. Mux
     * drops the video track if broadcasted.
     */
    audio_only?: boolean;

    connected?: boolean;

    /**
     * Describes the embedded closed caption configuration of the incoming live stream.
     */
    embedded_subtitles?: Array<Data.EmbeddedSubtitle>;

    /**
     * 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.
     */
    generated_subtitles?: Array<Data.GeneratedSubtitle>;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Setting this option will enable compatibility with the LL-HLS
     * specification for low-latency streaming. This typically has lower latency than
     * Reduced Latency streams, and cannot be combined with Reduced Latency.
     */
    low_latency?: boolean;

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Arbitrary user-supplied metadata set for the asset. Max 255 characters.
     */
    passthrough?: string;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * 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.
     */
    recent_asset_ids?: Array<string>;

    /**
     * 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.
     */
    reconnect_slate_url?: string;

    /**
     * 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.
     */
    reconnect_window?: number;

    recording?: boolean;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Set this if you want lower latency for your live stream. See the
     * [Reduce live stream latency guide](https://docs.mux.com/guides/reduce-live-stream-latency)
     * to understand the tradeoffs.
     */
    reduced_latency?: boolean;

    /**
     * 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](https://docs.mux.com/guides/stream-live-to-3rd-party-platforms).
     */
    simulcast_targets?: Array<Data.SimulcastTarget>;

    /**
     * Unique key used for encrypting a stream to a Mux SRT endpoint. Max 64
     * characters.
     */
    srt_passphrase?: string;

    /**
     * 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.
     */
    test?: boolean;

    /**
     * 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.
     */
    use_slate_for_standard_latency?: boolean;
  }

  export namespace Data {
    export interface EmbeddedSubtitle {
      /**
       * CEA-608 caption channel to read data from.
       */
      language_channel: 'cc1' | 'cc2' | 'cc3' | 'cc4';

      /**
       * The language of the closed caption stream. Value must be BCP 47 compliant.
       */
      language_code: string;

      /**
       * A name for this live stream closed caption track.
       */
      name: string;

      /**
       * Arbitrary user-supplied metadata set for the live stream closed caption track.
       * Max 255 characters.
       */
      passthrough?: string;
    }

    export interface GeneratedSubtitle {
      /**
       * The language of the audio from which subtitles are generated.
       */
      language_code: 'en' | 'en-US' | 'es' | 'fr' | 'de' | 'pt' | 'it';

      /**
       * A name for this live stream subtitle track.
       */
      name: string;

      /**
       * Arbitrary metadata set for the live stream subtitle track. Max 255 characters.
       */
      passthrough?: string;

      /**
       * 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.
       */
      transcription_vocabulary_ids?: Array<string>;
    }

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * The live stream title. Max 512 code points.
       */
      title?: string;
    }

    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface SimulcastTarget {
      /**
       * ID of the Simulcast Target
       */
      id: string;

      /**
       * 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.
       */
      status: 'idle' | 'starting' | 'broadcasting' | 'errored';

      /**
       * 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.
       */
      url: string;

      /**
       * 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.
       */
      error_severity?: 'normal' | 'fatal';

      /**
       * Arbitrary user-supplied metadata set when creating a simulcast target.
       */
      passthrough?: string;

      /**
       * 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.
       */
      stream_key?: string;
    }
  }
}

export interface VideoLiveStreamIdleWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamIdleWebhookEvent.Data;

  type: 'video.live_stream.idle';
}

export namespace VideoLiveStreamIdleWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * 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.
     */
    latency_mode: 'low' | 'reduced' | 'standard';

    /**
     * The time in seconds a live stream may be continuously active before being
     * disconnected. Defaults to 12 hours.
     */
    max_continuous_duration: number;

    /**
     * `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.
     */
    status: 'active' | 'idle' | 'disabled';

    /**
     * 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.
     */
    stream_key: string;

    /**
     * The Asset that is currently being created if there is an active broadcast.
     */
    active_asset_id?: string;

    /**
     * The protocol used for the active ingest stream. This is only set when the live
     * stream is active.
     */
    active_ingest_protocol?: 'rtmp' | 'srt';

    /**
     * The live stream only processes the audio track if the value is set to true. Mux
     * drops the video track if broadcasted.
     */
    audio_only?: boolean;

    connected?: boolean;

    /**
     * Describes the embedded closed caption configuration of the incoming live stream.
     */
    embedded_subtitles?: Array<Data.EmbeddedSubtitle>;

    /**
     * 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.
     */
    generated_subtitles?: Array<Data.GeneratedSubtitle>;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Setting this option will enable compatibility with the LL-HLS
     * specification for low-latency streaming. This typically has lower latency than
     * Reduced Latency streams, and cannot be combined with Reduced Latency.
     */
    low_latency?: boolean;

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Arbitrary user-supplied metadata set for the asset. Max 255 characters.
     */
    passthrough?: string;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * 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.
     */
    recent_asset_ids?: Array<string>;

    /**
     * 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.
     */
    reconnect_slate_url?: string;

    /**
     * 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.
     */
    reconnect_window?: number;

    recording?: boolean;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Set this if you want lower latency for your live stream. See the
     * [Reduce live stream latency guide](https://docs.mux.com/guides/reduce-live-stream-latency)
     * to understand the tradeoffs.
     */
    reduced_latency?: boolean;

    /**
     * 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](https://docs.mux.com/guides/stream-live-to-3rd-party-platforms).
     */
    simulcast_targets?: Array<Data.SimulcastTarget>;

    /**
     * Unique key used for encrypting a stream to a Mux SRT endpoint. Max 64
     * characters.
     */
    srt_passphrase?: string;

    /**
     * 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.
     */
    test?: boolean;

    /**
     * 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.
     */
    use_slate_for_standard_latency?: boolean;
  }

  export namespace Data {
    export interface EmbeddedSubtitle {
      /**
       * CEA-608 caption channel to read data from.
       */
      language_channel: 'cc1' | 'cc2' | 'cc3' | 'cc4';

      /**
       * The language of the closed caption stream. Value must be BCP 47 compliant.
       */
      language_code: string;

      /**
       * A name for this live stream closed caption track.
       */
      name: string;

      /**
       * Arbitrary user-supplied metadata set for the live stream closed caption track.
       * Max 255 characters.
       */
      passthrough?: string;
    }

    export interface GeneratedSubtitle {
      /**
       * The language of the audio from which subtitles are generated.
       */
      language_code: 'en' | 'en-US' | 'es' | 'fr' | 'de' | 'pt' | 'it';

      /**
       * A name for this live stream subtitle track.
       */
      name: string;

      /**
       * Arbitrary metadata set for the live stream subtitle track. Max 255 characters.
       */
      passthrough?: string;

      /**
       * 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.
       */
      transcription_vocabulary_ids?: Array<string>;
    }

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * The live stream title. Max 512 code points.
       */
      title?: string;
    }

    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface SimulcastTarget {
      /**
       * ID of the Simulcast Target
       */
      id: string;

      /**
       * 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.
       */
      status: 'idle' | 'starting' | 'broadcasting' | 'errored';

      /**
       * 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.
       */
      url: string;

      /**
       * 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.
       */
      error_severity?: 'normal' | 'fatal';

      /**
       * Arbitrary user-supplied metadata set when creating a simulcast target.
       */
      passthrough?: string;

      /**
       * 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.
       */
      stream_key?: string;
    }
  }
}

export interface VideoLiveStreamUpdatedWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamUpdatedWebhookEvent.Data;

  type: 'video.live_stream.updated';
}

export namespace VideoLiveStreamUpdatedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * 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.
     */
    latency_mode: 'low' | 'reduced' | 'standard';

    /**
     * The time in seconds a live stream may be continuously active before being
     * disconnected. Defaults to 12 hours.
     */
    max_continuous_duration: number;

    /**
     * `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.
     */
    status: 'active' | 'idle' | 'disabled';

    /**
     * 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.
     */
    stream_key: string;

    /**
     * The Asset that is currently being created if there is an active broadcast.
     */
    active_asset_id?: string;

    /**
     * The protocol used for the active ingest stream. This is only set when the live
     * stream is active.
     */
    active_ingest_protocol?: 'rtmp' | 'srt';

    /**
     * The live stream only processes the audio track if the value is set to true. Mux
     * drops the video track if broadcasted.
     */
    audio_only?: boolean;

    connected?: boolean;

    /**
     * Describes the embedded closed caption configuration of the incoming live stream.
     */
    embedded_subtitles?: Array<Data.EmbeddedSubtitle>;

    /**
     * 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.
     */
    generated_subtitles?: Array<Data.GeneratedSubtitle>;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Setting this option will enable compatibility with the LL-HLS
     * specification for low-latency streaming. This typically has lower latency than
     * Reduced Latency streams, and cannot be combined with Reduced Latency.
     */
    low_latency?: boolean;

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Arbitrary user-supplied metadata set for the asset. Max 255 characters.
     */
    passthrough?: string;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * 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.
     */
    recent_asset_ids?: Array<string>;

    /**
     * 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.
     */
    reconnect_slate_url?: string;

    /**
     * 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.
     */
    reconnect_window?: number;

    recording?: boolean;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Set this if you want lower latency for your live stream. See the
     * [Reduce live stream latency guide](https://docs.mux.com/guides/reduce-live-stream-latency)
     * to understand the tradeoffs.
     */
    reduced_latency?: boolean;

    /**
     * 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](https://docs.mux.com/guides/stream-live-to-3rd-party-platforms).
     */
    simulcast_targets?: Array<Data.SimulcastTarget>;

    /**
     * Unique key used for encrypting a stream to a Mux SRT endpoint. Max 64
     * characters.
     */
    srt_passphrase?: string;

    /**
     * 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.
     */
    test?: boolean;

    /**
     * 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.
     */
    use_slate_for_standard_latency?: boolean;
  }

  export namespace Data {
    export interface EmbeddedSubtitle {
      /**
       * CEA-608 caption channel to read data from.
       */
      language_channel: 'cc1' | 'cc2' | 'cc3' | 'cc4';

      /**
       * The language of the closed caption stream. Value must be BCP 47 compliant.
       */
      language_code: string;

      /**
       * A name for this live stream closed caption track.
       */
      name: string;

      /**
       * Arbitrary user-supplied metadata set for the live stream closed caption track.
       * Max 255 characters.
       */
      passthrough?: string;
    }

    export interface GeneratedSubtitle {
      /**
       * The language of the audio from which subtitles are generated.
       */
      language_code: 'en' | 'en-US' | 'es' | 'fr' | 'de' | 'pt' | 'it';

      /**
       * A name for this live stream subtitle track.
       */
      name: string;

      /**
       * Arbitrary metadata set for the live stream subtitle track. Max 255 characters.
       */
      passthrough?: string;

      /**
       * 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.
       */
      transcription_vocabulary_ids?: Array<string>;
    }

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * The live stream title. Max 512 code points.
       */
      title?: string;
    }

    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface SimulcastTarget {
      /**
       * ID of the Simulcast Target
       */
      id: string;

      /**
       * 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.
       */
      status: 'idle' | 'starting' | 'broadcasting' | 'errored';

      /**
       * 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.
       */
      url: string;

      /**
       * 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.
       */
      error_severity?: 'normal' | 'fatal';

      /**
       * Arbitrary user-supplied metadata set when creating a simulcast target.
       */
      passthrough?: string;

      /**
       * 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.
       */
      stream_key?: string;
    }
  }
}

export interface VideoLiveStreamEnabledWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamEnabledWebhookEvent.Data;

  type: 'video.live_stream.enabled';
}

export namespace VideoLiveStreamEnabledWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * 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.
     */
    latency_mode: 'low' | 'reduced' | 'standard';

    /**
     * The time in seconds a live stream may be continuously active before being
     * disconnected. Defaults to 12 hours.
     */
    max_continuous_duration: number;

    /**
     * `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.
     */
    status: 'active' | 'idle' | 'disabled';

    /**
     * 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.
     */
    stream_key: string;

    /**
     * The Asset that is currently being created if there is an active broadcast.
     */
    active_asset_id?: string;

    /**
     * The protocol used for the active ingest stream. This is only set when the live
     * stream is active.
     */
    active_ingest_protocol?: 'rtmp' | 'srt';

    /**
     * The live stream only processes the audio track if the value is set to true. Mux
     * drops the video track if broadcasted.
     */
    audio_only?: boolean;

    connected?: boolean;

    /**
     * Describes the embedded closed caption configuration of the incoming live stream.
     */
    embedded_subtitles?: Array<Data.EmbeddedSubtitle>;

    /**
     * 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.
     */
    generated_subtitles?: Array<Data.GeneratedSubtitle>;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Setting this option will enable compatibility with the LL-HLS
     * specification for low-latency streaming. This typically has lower latency than
     * Reduced Latency streams, and cannot be combined with Reduced Latency.
     */
    low_latency?: boolean;

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Arbitrary user-supplied metadata set for the asset. Max 255 characters.
     */
    passthrough?: string;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * 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.
     */
    recent_asset_ids?: Array<string>;

    /**
     * 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.
     */
    reconnect_slate_url?: string;

    /**
     * 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.
     */
    reconnect_window?: number;

    recording?: boolean;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Set this if you want lower latency for your live stream. See the
     * [Reduce live stream latency guide](https://docs.mux.com/guides/reduce-live-stream-latency)
     * to understand the tradeoffs.
     */
    reduced_latency?: boolean;

    /**
     * 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](https://docs.mux.com/guides/stream-live-to-3rd-party-platforms).
     */
    simulcast_targets?: Array<Data.SimulcastTarget>;

    /**
     * Unique key used for encrypting a stream to a Mux SRT endpoint. Max 64
     * characters.
     */
    srt_passphrase?: string;

    /**
     * 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.
     */
    test?: boolean;

    /**
     * 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.
     */
    use_slate_for_standard_latency?: boolean;
  }

  export namespace Data {
    export interface EmbeddedSubtitle {
      /**
       * CEA-608 caption channel to read data from.
       */
      language_channel: 'cc1' | 'cc2' | 'cc3' | 'cc4';

      /**
       * The language of the closed caption stream. Value must be BCP 47 compliant.
       */
      language_code: string;

      /**
       * A name for this live stream closed caption track.
       */
      name: string;

      /**
       * Arbitrary user-supplied metadata set for the live stream closed caption track.
       * Max 255 characters.
       */
      passthrough?: string;
    }

    export interface GeneratedSubtitle {
      /**
       * The language of the audio from which subtitles are generated.
       */
      language_code: 'en' | 'en-US' | 'es' | 'fr' | 'de' | 'pt' | 'it';

      /**
       * A name for this live stream subtitle track.
       */
      name: string;

      /**
       * Arbitrary metadata set for the live stream subtitle track. Max 255 characters.
       */
      passthrough?: string;

      /**
       * 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.
       */
      transcription_vocabulary_ids?: Array<string>;
    }

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * The live stream title. Max 512 code points.
       */
      title?: string;
    }

    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface SimulcastTarget {
      /**
       * ID of the Simulcast Target
       */
      id: string;

      /**
       * 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.
       */
      status: 'idle' | 'starting' | 'broadcasting' | 'errored';

      /**
       * 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.
       */
      url: string;

      /**
       * 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.
       */
      error_severity?: 'normal' | 'fatal';

      /**
       * Arbitrary user-supplied metadata set when creating a simulcast target.
       */
      passthrough?: string;

      /**
       * 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.
       */
      stream_key?: string;
    }
  }
}

export interface VideoLiveStreamDisabledWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamDisabledWebhookEvent.Data;

  type: 'video.live_stream.disabled';
}

export namespace VideoLiveStreamDisabledWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * 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.
     */
    latency_mode: 'low' | 'reduced' | 'standard';

    /**
     * The time in seconds a live stream may be continuously active before being
     * disconnected. Defaults to 12 hours.
     */
    max_continuous_duration: number;

    /**
     * `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.
     */
    status: 'active' | 'idle' | 'disabled';

    /**
     * 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.
     */
    stream_key: string;

    /**
     * The Asset that is currently being created if there is an active broadcast.
     */
    active_asset_id?: string;

    /**
     * The protocol used for the active ingest stream. This is only set when the live
     * stream is active.
     */
    active_ingest_protocol?: 'rtmp' | 'srt';

    /**
     * The live stream only processes the audio track if the value is set to true. Mux
     * drops the video track if broadcasted.
     */
    audio_only?: boolean;

    connected?: boolean;

    /**
     * Describes the embedded closed caption configuration of the incoming live stream.
     */
    embedded_subtitles?: Array<Data.EmbeddedSubtitle>;

    /**
     * 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.
     */
    generated_subtitles?: Array<Data.GeneratedSubtitle>;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Setting this option will enable compatibility with the LL-HLS
     * specification for low-latency streaming. This typically has lower latency than
     * Reduced Latency streams, and cannot be combined with Reduced Latency.
     */
    low_latency?: boolean;

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Arbitrary user-supplied metadata set for the asset. Max 255 characters.
     */
    passthrough?: string;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * 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.
     */
    recent_asset_ids?: Array<string>;

    /**
     * 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.
     */
    reconnect_slate_url?: string;

    /**
     * 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.
     */
    reconnect_window?: number;

    recording?: boolean;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Set this if you want lower latency for your live stream. See the
     * [Reduce live stream latency guide](https://docs.mux.com/guides/reduce-live-stream-latency)
     * to understand the tradeoffs.
     */
    reduced_latency?: boolean;

    /**
     * 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](https://docs.mux.com/guides/stream-live-to-3rd-party-platforms).
     */
    simulcast_targets?: Array<Data.SimulcastTarget>;

    /**
     * Unique key used for encrypting a stream to a Mux SRT endpoint. Max 64
     * characters.
     */
    srt_passphrase?: string;

    /**
     * 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.
     */
    test?: boolean;

    /**
     * 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.
     */
    use_slate_for_standard_latency?: boolean;
  }

  export namespace Data {
    export interface EmbeddedSubtitle {
      /**
       * CEA-608 caption channel to read data from.
       */
      language_channel: 'cc1' | 'cc2' | 'cc3' | 'cc4';

      /**
       * The language of the closed caption stream. Value must be BCP 47 compliant.
       */
      language_code: string;

      /**
       * A name for this live stream closed caption track.
       */
      name: string;

      /**
       * Arbitrary user-supplied metadata set for the live stream closed caption track.
       * Max 255 characters.
       */
      passthrough?: string;
    }

    export interface GeneratedSubtitle {
      /**
       * The language of the audio from which subtitles are generated.
       */
      language_code: 'en' | 'en-US' | 'es' | 'fr' | 'de' | 'pt' | 'it';

      /**
       * A name for this live stream subtitle track.
       */
      name: string;

      /**
       * Arbitrary metadata set for the live stream subtitle track. Max 255 characters.
       */
      passthrough?: string;

      /**
       * 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.
       */
      transcription_vocabulary_ids?: Array<string>;
    }

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * The live stream title. Max 512 code points.
       */
      title?: string;
    }

    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface SimulcastTarget {
      /**
       * ID of the Simulcast Target
       */
      id: string;

      /**
       * 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.
       */
      status: 'idle' | 'starting' | 'broadcasting' | 'errored';

      /**
       * 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.
       */
      url: string;

      /**
       * 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.
       */
      error_severity?: 'normal' | 'fatal';

      /**
       * Arbitrary user-supplied metadata set when creating a simulcast target.
       */
      passthrough?: string;

      /**
       * 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.
       */
      stream_key?: string;
    }
  }
}

export interface VideoLiveStreamDeletedWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamDeletedWebhookEvent.Data;

  type: 'video.live_stream.deleted';
}

export namespace VideoLiveStreamDeletedWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    id: string;

    created_at: number;

    /**
     * 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.
     */
    latency_mode: 'low' | 'reduced' | 'standard';

    /**
     * The time in seconds a live stream may be continuously active before being
     * disconnected. Defaults to 12 hours.
     */
    max_continuous_duration: number;

    /**
     * `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.
     */
    status: 'active' | 'idle' | 'disabled';

    /**
     * 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.
     */
    stream_key: string;

    /**
     * The Asset that is currently being created if there is an active broadcast.
     */
    active_asset_id?: string;

    /**
     * The protocol used for the active ingest stream. This is only set when the live
     * stream is active.
     */
    active_ingest_protocol?: 'rtmp' | 'srt';

    /**
     * The live stream only processes the audio track if the value is set to true. Mux
     * drops the video track if broadcasted.
     */
    audio_only?: boolean;

    connected?: boolean;

    /**
     * Describes the embedded closed caption configuration of the incoming live stream.
     */
    embedded_subtitles?: Array<Data.EmbeddedSubtitle>;

    /**
     * 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.
     */
    generated_subtitles?: Array<Data.GeneratedSubtitle>;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Setting this option will enable compatibility with the LL-HLS
     * specification for low-latency streaming. This typically has lower latency than
     * Reduced Latency streams, and cannot be combined with Reduced Latency.
     */
    low_latency?: boolean;

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    meta?: Data.Meta;

    new_asset_settings?: Data.NewAssetSettings;

    /**
     * Arbitrary user-supplied metadata set for the asset. Max 255 characters.
     */
    passthrough?: string;

    /**
     * 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.
     */
    playback_ids?: Array<Data.PlaybackIds>;

    /**
     * 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.
     */
    recent_asset_ids?: Array<string>;

    /**
     * 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.
     */
    reconnect_slate_url?: string;

    /**
     * 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.
     */
    reconnect_window?: number;

    recording?: boolean;

    /**
     * @deprecated This field is deprecated. Please use `latency_mode` instead. Latency
     * is the time from when the streamer transmits a frame of video to when you see it
     * in the player. Set this if you want lower latency for your live stream. See the
     * [Reduce live stream latency guide](https://docs.mux.com/guides/reduce-live-stream-latency)
     * to understand the tradeoffs.
     */
    reduced_latency?: boolean;

    /**
     * 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](https://docs.mux.com/guides/stream-live-to-3rd-party-platforms).
     */
    simulcast_targets?: Array<Data.SimulcastTarget>;

    /**
     * Unique key used for encrypting a stream to a Mux SRT endpoint. Max 64
     * characters.
     */
    srt_passphrase?: string;

    /**
     * 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.
     */
    test?: boolean;

    /**
     * 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.
     */
    use_slate_for_standard_latency?: boolean;
  }

  export namespace Data {
    export interface EmbeddedSubtitle {
      /**
       * CEA-608 caption channel to read data from.
       */
      language_channel: 'cc1' | 'cc2' | 'cc3' | 'cc4';

      /**
       * The language of the closed caption stream. Value must be BCP 47 compliant.
       */
      language_code: string;

      /**
       * A name for this live stream closed caption track.
       */
      name: string;

      /**
       * Arbitrary user-supplied metadata set for the live stream closed caption track.
       * Max 255 characters.
       */
      passthrough?: string;
    }

    export interface GeneratedSubtitle {
      /**
       * The language of the audio from which subtitles are generated.
       */
      language_code: 'en' | 'en-US' | 'es' | 'fr' | 'de' | 'pt' | 'it';

      /**
       * A name for this live stream subtitle track.
       */
      name: string;

      /**
       * Arbitrary metadata set for the live stream subtitle track. Max 255 characters.
       */
      passthrough?: string;

      /**
       * 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.
       */
      transcription_vocabulary_ids?: Array<string>;
    }

    /**
     * Customer provided metadata about this live stream.
     *
     * Note: This metadata may be publicly available via the video player. Do not
     * include PII or sensitive information.
     */
    export interface Meta {
      /**
       * The live stream title. Max 512 code points.
       */
      title?: string;
    }

    export interface NewAssetSettings {
      /**
       * An array of playback policy objects that you want applied to this asset and
       * available through `playback_ids`. `advanced_playback_policies` must be used
       * instead of `playback_policies` when creating a DRM playback ID.
       */
      advanced_playback_policies?: Array<NewAssetSettings.AdvancedPlaybackPolicy>;

      /**
       * If the created asset is a clip, this controls whether overlays are copied from
       * the source asset.
       */
      copy_overlays?: boolean;

      /**
       * @deprecated This field is deprecated. Please use `video_quality` instead. The
       * encoding tier informs the cost, quality, and available platform features for the
       * asset. The default encoding tier for an account can be set in the Mux Dashboard.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      encoding_tier?: 'smart' | 'baseline' | 'premium';

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, input can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      inputs?: Array<NewAssetSettings.Input>;

      /**
       * Specify what level (if any) of support for master access. Master access can be
       * enabled temporarily for your asset to be downloaded. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      master_access?: 'none' | 'temporary';

      /**
       * Max resolution tier can be used to control the maximum `resolution_tier` your
       * asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
       */
      max_resolution_tier?: '1080p' | '1440p' | '2160p';

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      meta?: NewAssetSettings.Meta;

      /**
       * @deprecated Deprecated. See the
       * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
       * for the updated API.
       *
       * Specify what level of support for mp4 playback. You may not enable both
       * `mp4_support` and `static_renditions`.
       *
       * - The `capped-1080p` option produces a single MP4 file, called
       *   `capped-1080p.mp4`, with the video resolution capped at 1080p. This option
       *   produces an `audio.m4a` file for an audio-only asset.
       * - The `audio-only` option produces a single M4A file, called `audio.m4a` for a
       *   video or an audio-only asset. MP4 generation will error when this option is
       *   specified for a video-only asset.
       * - The `audio-only,capped-1080p` option produces both the `audio.m4a` and
       *   `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a
       *   video-only asset, while only the `audio.m4a` file is produced for an
       *   audio-only asset.
       *
       * The `standard`(deprecated) option produces up to three MP4 files with different
       * levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an
       * audio-only asset).
       *
       * MP4 files are not produced for `none` (default).
       *
       * In most cases you should use our default HLS-based streaming playback
       * (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection
       * speeds, but an mp4 can be useful for some legacy devices or downloading for
       * offline playback. See the
       * [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions)
       * for more information.
       */
      mp4_support?: 'none' | 'standard' | 'capped-1080p' | 'audio-only' | 'audio-only,capped-1080p';

      /**
       * Normalize the audio track loudness level. This parameter is only applicable to
       * on-demand (not live) assets.
       */
      normalize_audio?: boolean;

      /**
       * You can set this field to anything you want. It will be included in the asset
       * details and related webhooks. If you're looking for more structured metadata,
       * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
       * 255 characters**.
       */
      passthrough?: string;

      /**
       * @deprecated
       */
      per_title_encode?: boolean;

      /**
       * An array of playback policy names that you want applied to this asset and
       * available through `playback_ids`. Options include:
       *
       * - `"public"` (anyone with the playback URL can stream the asset).
       * - `"signed"` (an additional access token is required to play the asset).
       *
       * If no `playback_policies` are set, the asset will have no playback IDs and will
       * therefore not be playable. For simplicity, a single string name can be used in
       * place of the array in the case of only one playback policy.
       */
      playback_policies?: Array<'public' | 'signed' | 'drm'>;

      /**
       * An array of static renditions to create for this asset. You may not enable both
       * `static_renditions` and `mp4_support (the latter being deprecated)`
       */
      static_renditions?: Array<NewAssetSettings.StaticRendition>;

      /**
       * Marks the asset as a test asset when the value is set to true. A Test asset can
       * help evaluate the Mux Video APIs without incurring any cost. There is no limit
       * on number of test assets created. Test asset are watermarked with the Mux logo,
       * limited to 10 seconds, deleted after 24 hrs.
       */
      test?: boolean;

      /**
       * The video quality controls the cost, quality, and available platform features
       * for the asset. The default video quality for an account can be set in the Mux
       * Dashboard. This field replaces the deprecated `encoding_tier` value.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      video_quality?: 'basic' | 'plus' | 'premium';
    }

    export namespace NewAssetSettings {
      export interface AdvancedPlaybackPolicy {
        /**
         * The DRM configuration used by this playback ID. Must only be set when `policy`
         * is set to `drm`.
         */
        drm_configuration_id?: string;

        /**
         * - `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](https://docs.mux.com/guides/secure-video-playback) for
         *   details about creating tokens.
         *
         * - `drm` playback IDs are protected with DRM technologies.
         *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
         */
        policy?: 'public' | 'signed' | 'drm';
      }

      /**
       * An array of objects that each describe an input file to be used to create the
       * asset. As a shortcut, `input` can also be a string URL for a file when only one
       * input file is used. See `input[].url` for requirements.
       */
      export interface Input {
        /**
         * Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        closed_captions?: boolean;

        /**
         * The time offset in seconds from the beginning of the video, indicating the
         * clip's ending marker. The default value is the duration of the video when not
         * included. This parameter is only applicable for creating clips when `input.url`
         * has `mux://assets/{asset_id}` format.
         */
        end_time?: number;

        /**
         * Generate subtitle tracks using automatic speech recognition with this
         * configuration. Subtitles are generated using the audio of the input they are
         * nested within. For direct uploads, this first input should omit the url
         * parameter, as the main input file is provided via the direct upload. Note that
         * subtitle generation happens after initial ingest, so the generated tracks will
         * be in the `preparing` state when the asset transitions to `ready`.
         */
        generated_subtitles?: Array<Input.GeneratedSubtitle>;

        /**
         * The language code value must be a valid
         * [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For
         * example, `en` for English or `en-US` for the US version of English. This
         * parameter is required for `text` and `audio` track types.
         */
        language_code?: string;

        /**
         * The name of the track containing a human-readable description. This value must
         * be unique within each group of `text` or `audio` track types. The HLS manifest
         * will associate a subtitle text track with this value. For example, the value
         * should be "English" for a subtitle text track with `language_code` set to `en`.
         * This optional parameter should be used only for `text` and `audio` type tracks.
         * This parameter can be optionally provided for the first video input to denote
         * the name of the muxed audio track if present. If this parameter is not included,
         * Mux will auto-populate based on the `input[].language_code` value.
         */
        name?: string;

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        overlay_settings?: Input.OverlaySettings;

        /**
         * This optional parameter should be used for tracks with `type` of `text` and
         * `text_type` set to `subtitles`.
         */
        passthrough?: string;

        /**
         * The time offset in seconds from the beginning of the video indicating the clip's
         * starting marker. The default value is 0 when not included. This parameter is
         * only applicable for creating clips when `input.url` has
         * `mux://assets/{asset_id}` format.
         */
        start_time?: number;

        /**
         * Type of text track. This parameter only supports subtitles value. For more
         * information on Subtitles / Closed Captions,
         * [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).
         * This parameter is required for `text` type tracks.
         */
        text_type?: 'subtitles';

        /**
         * This parameter is required for `text` type tracks.
         */
        type?: 'video' | 'audio' | 'text';

        /**
         * The URL of the file that Mux should download and use.
         *
         * - For the main input file, this should be the URL to the muxed file for Mux to
         *   download, for example an MP4, MOV, MKV, or TS file. Mux supports most
         *   audio/video file formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `audio` tracks, the URL is the location of the audio file for Mux to
         *   download, for example an M4A, WAV, or MP3 file. Mux supports most audio file
         *   formats and codecs, but for fastest processing, you should
         *   [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time).
         * - For `text` tracks, the URL is the location of subtitle/captions file. Mux
         *   supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and
         *   [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting
         *   Subtitles and Closed Captions.
         * - For Watermarking or Overlay, the URL is the location of the watermark image.
         *   The maximum size is 4096x4096.
         * - When creating clips from existing Mux assets, the URL is defined with
         *   `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier
         *   for creating the clip from. The url property may be omitted on the first input
         *   object when providing asset settings for LiveStream and Upload objects, in
         *   order to configure settings related to the primary (live stream or direct
         *   upload) input.
         */
        url?: string;
      }

      export namespace Input {
        export interface GeneratedSubtitle {
          /**
           * The language of the audio from which subtitles are generated. Selecting a
           * language of "auto" will allow language detection to set the language code
           * automatically.
           */
          language_code?:
            | 'en'
            | 'es'
            | 'it'
            | 'pt'
            | 'de'
            | 'fr'
            | 'pl'
            | 'ru'
            | 'nl'
            | 'ca'
            | 'tr'
            | 'sv'
            | 'uk'
            | 'no'
            | 'fi'
            | 'sk'
            | 'el'
            | 'cs'
            | 'hr'
            | 'da'
            | 'ro'
            | 'bg'
            | 'auto';

          /**
           * A name for this subtitle track.
           */
          name?: string;

          /**
           * Arbitrary metadata set for the subtitle track. Max 255 characters.
           */
          passthrough?: string;
        }

        /**
         * An object that describes how the image file referenced in URL should be placed
         * over the video (i.e. watermarking). Ensure that the URL is active and persists
         * the entire lifespan of the video object.
         */
        export interface OverlaySettings {
          /**
           * How tall the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the height will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If width is supplied with no height, the height will scale
           * proportionally to the width.
           */
          height?: string;

          /**
           * Where the horizontal positioning of the overlay/watermark should begin from.
           */
          horizontal_align?: 'left' | 'center' | 'right';

          /**
           * The distance from the horizontal_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'center', a
           * positive value will shift the image towards the right and and a negative value
           * will shift it towards the left.
           */
          horizontal_margin?: string;

          /**
           * How opaque the overlay should appear, expressed as a percent. (Default 100%)
           */
          opacity?: string;

          /**
           * Where the vertical positioning of the overlay/watermark should begin from.
           * Defaults to `"top"`
           */
          vertical_align?: 'top' | 'middle' | 'bottom';

          /**
           * The distance from the vertical_align starting point and the image's closest
           * edge. Can be expressed as a percent ("10%") or as a pixel value ("100px").
           * Negative values will move the overlay offscreen. In the case of 'middle', a
           * positive value will shift the overlay towards the bottom and and a negative
           * value will shift it towards the top.
           */
          vertical_margin?: string;

          /**
           * How wide the overlay should appear. Can be expressed as a percent ("10%") or as
           * a pixel value ("100px"). If both width and height are left blank the width will
           * be the true pixels of the image, applied as if the video has been scaled to fit
           * a 1920x1080 frame. If height is supplied with no width, the width will scale
           * proportionally to the height.
           */
          width?: string;
        }
      }

      /**
       * Customer provided metadata about this asset.
       *
       * Note: This metadata may be publicly available via the video player. Do not
       * include PII or sensitive information.
       */
      export interface Meta {
        /**
         * This is an identifier you provide to keep track of the creator of the asset. Max
         * 128 code points.
         */
        creator_id?: string;

        /**
         * This is an identifier you provide to link the asset to your own data. Max 128
         * code points.
         */
        external_id?: string;

        /**
         * The asset title. Max 512 code points.
         */
        title?: string;
      }

      export interface StaticRendition {
        resolution:
          | 'highest'
          | 'audio-only'
          | '2160p'
          | '1440p'
          | '1080p'
          | '720p'
          | '540p'
          | '480p'
          | '360p'
          | '270p';

        /**
         * Arbitrary user-supplied metadata set for the static rendition. Max 255
         * characters.
         */
        passthrough?: string;
      }
    }

    export interface PlaybackIds {
      /**
       * Unique identifier for the PlaybackID
       */
      id: string;

      /**
       * - `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](https://docs.mux.com/guides/secure-video-playback) for
       *   details about creating tokens.
       *
       * - `drm` playback IDs are protected with DRM technologies.
       *   [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
       */
      policy: 'public' | 'signed' | 'drm';

      /**
       * The DRM configuration used by this playback ID. Must only be set when `policy`
       * is set to `drm`.
       */
      drm_configuration_id?: string;
    }

    export interface SimulcastTarget {
      /**
       * ID of the Simulcast Target
       */
      id: string;

      /**
       * 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.
       */
      status: 'idle' | 'starting' | 'broadcasting' | 'errored';

      /**
       * 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.
       */
      url: string;

      /**
       * 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.
       */
      error_severity?: 'normal' | 'fatal';

      /**
       * Arbitrary user-supplied metadata set when creating a simulcast target.
       */
      passthrough?: string;

      /**
       * 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.
       */
      stream_key?: string;
    }
  }
}

export interface VideoLiveStreamWarningWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamWarningWebhookEvent.Data;

  type: 'video.live_stream.warning';
}

export namespace VideoLiveStreamWarningWebhookEvent {
  export interface Data {
    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    id?: string;

    /**
     * The Asset that is currently being created if there is an active broadcast.
     */
    active_asset_id?: string;

    /**
     * Arbitrary user-supplied metadata set for the asset. Max 255 characters.
     */
    passthrough?: string;

    /**
     * `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.
     */
    status?: 'active' | 'idle' | 'disabled';

    /**
     * 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.
     */
    stream_key?: string;

    warning?: Data.Warning;
  }

  export namespace Data {
    export interface Warning {
      message?: string;

      type?: string;
    }
  }
}

export interface VideoLiveStreamSimulcastTargetCreatedWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamSimulcastTargetCreatedWebhookEvent.Data;

  type: 'video.live_stream.simulcast_target.created';
}

export namespace VideoLiveStreamSimulcastTargetCreatedWebhookEvent {
  export interface Data {
    /**
     * ID of the Simulcast Target
     */
    id: string;

    /**
     * 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.
     */
    status: 'idle' | 'starting' | 'broadcasting' | 'errored';

    /**
     * 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.
     */
    url: string;

    /**
     * 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.
     */
    error_severity?: 'normal' | 'fatal';

    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    live_stream_id?: string;

    /**
     * Arbitrary user-supplied metadata set when creating a simulcast target.
     */
    passthrough?: string;

    /**
     * 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.
     */
    stream_key?: string;
  }
}

export interface VideoLiveStreamSimulcastTargetIdleWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamSimulcastTargetIdleWebhookEvent.Data;

  type: 'video.live_stream.simulcast_target.idle';
}

export namespace VideoLiveStreamSimulcastTargetIdleWebhookEvent {
  export interface Data {
    /**
     * ID of the Simulcast Target
     */
    id: string;

    /**
     * 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.
     */
    status: 'idle' | 'starting' | 'broadcasting' | 'errored';

    /**
     * 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.
     */
    url: string;

    /**
     * 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.
     */
    error_severity?: 'normal' | 'fatal';

    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    live_stream_id?: string;

    /**
     * Arbitrary user-supplied metadata set when creating a simulcast target.
     */
    passthrough?: string;

    /**
     * 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.
     */
    stream_key?: string;
  }
}

export interface VideoLiveStreamSimulcastTargetStartingWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamSimulcastTargetStartingWebhookEvent.Data;

  type: 'video.live_stream.simulcast_target.starting';
}

export namespace VideoLiveStreamSimulcastTargetStartingWebhookEvent {
  export interface Data {
    /**
     * ID of the Simulcast Target
     */
    id: string;

    /**
     * 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.
     */
    status: 'idle' | 'starting' | 'broadcasting' | 'errored';

    /**
     * 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.
     */
    url: string;

    /**
     * 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.
     */
    error_severity?: 'normal' | 'fatal';

    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    live_stream_id?: string;

    /**
     * Arbitrary user-supplied metadata set when creating a simulcast target.
     */
    passthrough?: string;

    /**
     * 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.
     */
    stream_key?: string;
  }
}

export interface VideoLiveStreamSimulcastTargetBroadcastingWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamSimulcastTargetBroadcastingWebhookEvent.Data;

  type: 'video.live_stream.simulcast_target.broadcasting';
}

export namespace VideoLiveStreamSimulcastTargetBroadcastingWebhookEvent {
  export interface Data {
    /**
     * ID of the Simulcast Target
     */
    id: string;

    /**
     * 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.
     */
    status: 'idle' | 'starting' | 'broadcasting' | 'errored';

    /**
     * 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.
     */
    url: string;

    /**
     * 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.
     */
    error_severity?: 'normal' | 'fatal';

    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    live_stream_id?: string;

    /**
     * Arbitrary user-supplied metadata set when creating a simulcast target.
     */
    passthrough?: string;

    /**
     * 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.
     */
    stream_key?: string;
  }
}

export interface VideoLiveStreamSimulcastTargetErroredWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamSimulcastTargetErroredWebhookEvent.Data;

  type: 'video.live_stream.simulcast_target.errored';
}

export namespace VideoLiveStreamSimulcastTargetErroredWebhookEvent {
  export interface Data {
    /**
     * ID of the Simulcast Target
     */
    id: string;

    /**
     * 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.
     */
    status: 'idle' | 'starting' | 'broadcasting' | 'errored';

    /**
     * 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.
     */
    url: string;

    /**
     * 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.
     */
    error_severity?: 'normal' | 'fatal';

    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    live_stream_id?: string;

    /**
     * Arbitrary user-supplied metadata set when creating a simulcast target.
     */
    passthrough?: string;

    /**
     * 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.
     */
    stream_key?: string;
  }
}

export interface VideoLiveStreamSimulcastTargetDeletedWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamSimulcastTargetDeletedWebhookEvent.Data;

  type: 'video.live_stream.simulcast_target.deleted';
}

export namespace VideoLiveStreamSimulcastTargetDeletedWebhookEvent {
  export interface Data {
    /**
     * ID of the Simulcast Target
     */
    id: string;

    /**
     * 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.
     */
    status: 'idle' | 'starting' | 'broadcasting' | 'errored';

    /**
     * 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.
     */
    url: string;

    /**
     * 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.
     */
    error_severity?: 'normal' | 'fatal';

    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    live_stream_id?: string;

    /**
     * Arbitrary user-supplied metadata set when creating a simulcast target.
     */
    passthrough?: string;

    /**
     * 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.
     */
    stream_key?: string;
  }
}

export interface VideoLiveStreamSimulcastTargetUpdatedWebhookEvent extends BaseWebhookEvent {
  data: VideoLiveStreamSimulcastTargetUpdatedWebhookEvent.Data;

  type: 'video.live_stream.simulcast_target.updated';
}

export namespace VideoLiveStreamSimulcastTargetUpdatedWebhookEvent {
  export interface Data {
    /**
     * ID of the Simulcast Target
     */
    id: string;

    /**
     * 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.
     */
    status: 'idle' | 'starting' | 'broadcasting' | 'errored';

    /**
     * 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.
     */
    url: string;

    /**
     * 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.
     */
    error_severity?: 'normal' | 'fatal';

    /**
     * Unique identifier for the Live Stream. Max 255 characters.
     */
    live_stream_id?: string;

    /**
     * Arbitrary user-supplied metadata set when creating a simulcast target.
     */
    passthrough?: string;

    /**
     * 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.
     */
    stream_key?: string;
  }
}

export interface VideoDeliveryHighTrafficWebhookEvent extends BaseWebhookEvent {
  data: VideoDeliveryHighTrafficWebhookEvent.Data;

  type: 'video.delivery.high_traffic';
}

export namespace VideoDeliveryHighTrafficWebhookEvent {
  export interface Data {
    id?: string;

    data?: Array<Data.Data>;

    /**
     * Current threshold set for alerting
     */
    threshold?: number;

    timeframe?: Array<number>;
  }

  export namespace Data {
    export interface Data {
      /**
       * The duration of the asset in seconds.
       */
      asset_duration: number;

      /**
       * @deprecated This field is deprecated. Please use `asset_video_quality` instead.
       * The encoding tier that the asset was ingested at.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      asset_encoding_tier: 'smart' | 'baseline' | 'premium';

      /**
       * Unique identifier for the asset.
       */
      asset_id: string;

      /**
       * The resolution tier that the asset was ingested at, affecting billing for ingest
       * & storage
       */
      asset_resolution_tier: 'audio-only' | '720p' | '1080p' | '1440p' | '2160p';

      /**
       * The state of the asset.
       */
      asset_state: 'ready' | 'errored' | 'deleted';

      /**
       * Time at which the asset was created. Measured in seconds since the Unix epoch.
       */
      created_at: number;

      /**
       * Total number of delivered seconds during this time window.
       */
      delivered_seconds: number;

      /**
       * Seconds delivered broken into resolution tiers. Each tier will only be displayed
       * if there was content delivered in the tier.
       */
      delivered_seconds_by_resolution: Data.DeliveredSecondsByResolution;

      /**
       * The video quality that the asset was ingested at. This field replaces
       * `asset_encoding_tier`.
       * [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
       */
      asset_video_quality?: 'basic' | 'plus' | 'premium';

      /**
       * If exists, time at which the asset was deleted. Measured in seconds since the
       * Unix epoch.
       */
      deleted_at?: number;

      /**
       * Unique identifier for the live stream that created the asset.
       */
      live_stream_id?: string;

      /**
       * The `passthrough` value for the asset.
       */
      passthrough?: string;
    }

    export namespace Data {
      /**
       * Seconds delivered broken into resolution tiers. Each tier will only be displayed
       * if there was content delivered in the tier.
       */
      export interface DeliveredSecondsByResolution {
        /**
         * Total number of delivered seconds during this time window that had a resolution
         * larger than the 720p tier but less than or equal to the 1440p tier (over 921,600
         * and <= 2,073,600 pixels total).
         */
        tier_1080p?: number;

        /**
         * Total number of delivered seconds during this time window that had a resolution
         * larger than the 1080p tier but less than or equal to the 2160p tier (over
         * 2,073,600 and <= 4,194,304 pixels total).
         */
        tier_1440p?: number;

        /**
         * Total number of delivered seconds during this time window that had a resolution
         * larger than the 1440p tier (over 4,194,304 pixels total).
         */
        tier_2160p?: number;

        /**
         * Total number of delivered seconds during this time window that had a resolution
         * within the 720p tier (up to 921,600 pixels total, based on typical 1280x720).
         */
        tier_720p?: number;

        /**
         * Total number of delivered seconds during this time window that had a resolution
         * of audio only.
         */
        tier_audio_only?: number;
      }
    }
  }
}

export interface RobotsJobAskQuestionsCancelledWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobAskQuestionsCancelledWebhookEvent.Data;

  type: 'robots.job.ask_questions.cancelled';
}

export namespace RobotsJobAskQuestionsCancelledWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'ask-questions';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to analyze.
       */
      asset_id: string;

      /**
       * One or more questions to ask about the video. Each question can specify its own
       * answer_options.
       */
      questions: Array<Parameters.Question>;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK uses the default track.
       */
      language_code?: string;
    }

    export namespace Parameters {
      export interface Question {
        /**
         * The question to ask about the video content.
         */
        question: string;

        /**
         * Allowed answer values for this question. Defaults to ["yes", "no"].
         */
        answer_options?: Array<string>;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * One answer per question, in the same order as the input questions.
       */
      answers: Array<Outputs.Answer>;
    }

    export namespace Outputs {
      export interface Answer {
        /**
         * The answer, constrained to one of the provided answer_options. Null when the
         * question was skipped.
         */
        answer: string | null;

        /**
         * Confidence score from 0.0 to 1.0. Values above 0.9 indicate clear, unambiguous
         * evidence; 0.7-0.9 strong evidence with minor ambiguity; 0.5-0.7 moderate
         * evidence; below 0.5 weak or uncertain evidence. Always 0 when skipped.
         */
        confidence: number;

        /**
         * The original question that was asked.
         */
        question: string;

        /**
         * Explanation citing specific visual or audio evidence from the video, or why the
         * question was skipped.
         */
        reasoning: string;

        /**
         * Whether the question was skipped due to irrelevance to the video content.
         */
        skipped: boolean;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobAskQuestionsCompletedWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobAskQuestionsCompletedWebhookEvent.Data;

  type: 'robots.job.ask_questions.completed';
}

export namespace RobotsJobAskQuestionsCompletedWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'ask-questions';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to analyze.
       */
      asset_id: string;

      /**
       * One or more questions to ask about the video. Each question can specify its own
       * answer_options.
       */
      questions: Array<Parameters.Question>;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK uses the default track.
       */
      language_code?: string;
    }

    export namespace Parameters {
      export interface Question {
        /**
         * The question to ask about the video content.
         */
        question: string;

        /**
         * Allowed answer values for this question. Defaults to ["yes", "no"].
         */
        answer_options?: Array<string>;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * One answer per question, in the same order as the input questions.
       */
      answers: Array<Outputs.Answer>;
    }

    export namespace Outputs {
      export interface Answer {
        /**
         * The answer, constrained to one of the provided answer_options. Null when the
         * question was skipped.
         */
        answer: string | null;

        /**
         * Confidence score from 0.0 to 1.0. Values above 0.9 indicate clear, unambiguous
         * evidence; 0.7-0.9 strong evidence with minor ambiguity; 0.5-0.7 moderate
         * evidence; below 0.5 weak or uncertain evidence. Always 0 when skipped.
         */
        confidence: number;

        /**
         * The original question that was asked.
         */
        question: string;

        /**
         * Explanation citing specific visual or audio evidence from the video, or why the
         * question was skipped.
         */
        reasoning: string;

        /**
         * Whether the question was skipped due to irrelevance to the video content.
         */
        skipped: boolean;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobAskQuestionsErroredWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobAskQuestionsErroredWebhookEvent.Data;

  type: 'robots.job.ask_questions.errored';
}

export namespace RobotsJobAskQuestionsErroredWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'ask-questions';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to analyze.
       */
      asset_id: string;

      /**
       * One or more questions to ask about the video. Each question can specify its own
       * answer_options.
       */
      questions: Array<Parameters.Question>;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK uses the default track.
       */
      language_code?: string;
    }

    export namespace Parameters {
      export interface Question {
        /**
         * The question to ask about the video content.
         */
        question: string;

        /**
         * Allowed answer values for this question. Defaults to ["yes", "no"].
         */
        answer_options?: Array<string>;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * One answer per question, in the same order as the input questions.
       */
      answers: Array<Outputs.Answer>;
    }

    export namespace Outputs {
      export interface Answer {
        /**
         * The answer, constrained to one of the provided answer_options. Null when the
         * question was skipped.
         */
        answer: string | null;

        /**
         * Confidence score from 0.0 to 1.0. Values above 0.9 indicate clear, unambiguous
         * evidence; 0.7-0.9 strong evidence with minor ambiguity; 0.5-0.7 moderate
         * evidence; below 0.5 weak or uncertain evidence. Always 0 when skipped.
         */
        confidence: number;

        /**
         * The original question that was asked.
         */
        question: string;

        /**
         * Explanation citing specific visual or audio evidence from the video, or why the
         * question was skipped.
         */
        reasoning: string;

        /**
         * Whether the question was skipped due to irrelevance to the video content.
         */
        skipped: boolean;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobAskQuestionsPendingWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobAskQuestionsPendingWebhookEvent.Data;

  type: 'robots.job.ask_questions.pending';
}

export namespace RobotsJobAskQuestionsPendingWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'ask-questions';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to analyze.
       */
      asset_id: string;

      /**
       * One or more questions to ask about the video. Each question can specify its own
       * answer_options.
       */
      questions: Array<Parameters.Question>;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK uses the default track.
       */
      language_code?: string;
    }

    export namespace Parameters {
      export interface Question {
        /**
         * The question to ask about the video content.
         */
        question: string;

        /**
         * Allowed answer values for this question. Defaults to ["yes", "no"].
         */
        answer_options?: Array<string>;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * One answer per question, in the same order as the input questions.
       */
      answers: Array<Outputs.Answer>;
    }

    export namespace Outputs {
      export interface Answer {
        /**
         * The answer, constrained to one of the provided answer_options. Null when the
         * question was skipped.
         */
        answer: string | null;

        /**
         * Confidence score from 0.0 to 1.0. Values above 0.9 indicate clear, unambiguous
         * evidence; 0.7-0.9 strong evidence with minor ambiguity; 0.5-0.7 moderate
         * evidence; below 0.5 weak or uncertain evidence. Always 0 when skipped.
         */
        confidence: number;

        /**
         * The original question that was asked.
         */
        question: string;

        /**
         * Explanation citing specific visual or audio evidence from the video, or why the
         * question was skipped.
         */
        reasoning: string;

        /**
         * Whether the question was skipped due to irrelevance to the video content.
         */
        skipped: boolean;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobAskQuestionsProcessingWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobAskQuestionsProcessingWebhookEvent.Data;

  type: 'robots.job.ask_questions.processing';
}

export namespace RobotsJobAskQuestionsProcessingWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'ask-questions';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to analyze.
       */
      asset_id: string;

      /**
       * One or more questions to ask about the video. Each question can specify its own
       * answer_options.
       */
      questions: Array<Parameters.Question>;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK uses the default track.
       */
      language_code?: string;
    }

    export namespace Parameters {
      export interface Question {
        /**
         * The question to ask about the video content.
         */
        question: string;

        /**
         * Allowed answer values for this question. Defaults to ["yes", "no"].
         */
        answer_options?: Array<string>;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * One answer per question, in the same order as the input questions.
       */
      answers: Array<Outputs.Answer>;
    }

    export namespace Outputs {
      export interface Answer {
        /**
         * The answer, constrained to one of the provided answer_options. Null when the
         * question was skipped.
         */
        answer: string | null;

        /**
         * Confidence score from 0.0 to 1.0. Values above 0.9 indicate clear, unambiguous
         * evidence; 0.7-0.9 strong evidence with minor ambiguity; 0.5-0.7 moderate
         * evidence; below 0.5 weak or uncertain evidence. Always 0 when skipped.
         */
        confidence: number;

        /**
         * The original question that was asked.
         */
        question: string;

        /**
         * Explanation citing specific visual or audio evidence from the video, or why the
         * question was skipped.
         */
        reasoning: string;

        /**
         * Whether the question was skipped due to irrelevance to the video content.
         */
        skipped: boolean;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobFindKeyMomentsCancelledWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobFindKeyMomentsCancelledWebhookEvent.Data;

  type: 'robots.job.find_key_moments.cancelled';
}

export namespace RobotsJobFindKeyMomentsCancelledWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'find-key-moments';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to analyze.
       */
      asset_id: string;

      /**
       * Maximum number of key moments to extract. Defaults to 5.
       */
      max_moments?: number;

      /**
       * Preferred highlight duration range in milliseconds. When provided, the model
       * will aim to select moments within this range.
       */
      target_duration_ms?: Parameters.TargetDurationMs;
    }

    export namespace Parameters {
      /**
       * Preferred highlight duration range in milliseconds. When provided, the model
       * will aim to select moments within this range.
       */
      export interface TargetDurationMs {
        /**
         * Preferred maximum highlight duration in milliseconds.
         */
        max: number;

        /**
         * Preferred minimum highlight duration in milliseconds.
         */
        min: number;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Extracted key moments, ordered by position in the video.
       */
      moments: Array<Outputs.Moment>;
    }

    export namespace Outputs {
      export interface Moment {
        /**
         * One-sentence summary of what is being said during the moment.
         */
        audible_narrative: string;

        /**
         * Contiguous transcript segments that comprise this moment.
         */
        cues: Array<Moment.Cue>;

        /**
         * Moment end time in milliseconds.
         */
        end_ms: number;

        /**
         * Multi-word descriptive phrases (2-5 words each) capturing key audible concepts.
         */
        notable_audible_concepts: Array<string>;

        /**
         * Weighted quality score from 0.0 to 1.0 based on hook strength, clarity,
         * emotional intensity, novelty, and soundbite quality.
         */
        overall_score: number;

        /**
         * Moment start time in milliseconds.
         */
        start_ms: number;

        /**
         * Short catchy title for the moment (3-8 words).
         */
        title: string;

        /**
         * Scored visual concepts extracted from sampled frames. Present for video assets
         * only.
         */
        notable_visual_concepts?: Array<Moment.NotableVisualConcept>;

        /**
         * One-sentence summary of what is visually happening. Present for video assets
         * only.
         */
        visual_narrative?: string;
      }

      export namespace Moment {
        export interface Cue {
          /**
           * Cue end time in milliseconds.
           */
          end_ms: number;

          /**
           * Cue start time in milliseconds.
           */
          start_ms: number;

          /**
           * Transcript text for this cue.
           */
          text: string;
        }

        export interface NotableVisualConcept {
          /**
           * Multi-word visual concept (2-5 words).
           */
          concept: string;

          /**
           * Brief explanation of the relevance score.
           */
          rationale: string;

          /**
           * Relevance score from 0.0 to 1.0 measuring how closely the visual concept relates
           * to the audible narrative.
           */
          score: number;
        }
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobFindKeyMomentsCompletedWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobFindKeyMomentsCompletedWebhookEvent.Data;

  type: 'robots.job.find_key_moments.completed';
}

export namespace RobotsJobFindKeyMomentsCompletedWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'find-key-moments';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to analyze.
       */
      asset_id: string;

      /**
       * Maximum number of key moments to extract. Defaults to 5.
       */
      max_moments?: number;

      /**
       * Preferred highlight duration range in milliseconds. When provided, the model
       * will aim to select moments within this range.
       */
      target_duration_ms?: Parameters.TargetDurationMs;
    }

    export namespace Parameters {
      /**
       * Preferred highlight duration range in milliseconds. When provided, the model
       * will aim to select moments within this range.
       */
      export interface TargetDurationMs {
        /**
         * Preferred maximum highlight duration in milliseconds.
         */
        max: number;

        /**
         * Preferred minimum highlight duration in milliseconds.
         */
        min: number;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Extracted key moments, ordered by position in the video.
       */
      moments: Array<Outputs.Moment>;
    }

    export namespace Outputs {
      export interface Moment {
        /**
         * One-sentence summary of what is being said during the moment.
         */
        audible_narrative: string;

        /**
         * Contiguous transcript segments that comprise this moment.
         */
        cues: Array<Moment.Cue>;

        /**
         * Moment end time in milliseconds.
         */
        end_ms: number;

        /**
         * Multi-word descriptive phrases (2-5 words each) capturing key audible concepts.
         */
        notable_audible_concepts: Array<string>;

        /**
         * Weighted quality score from 0.0 to 1.0 based on hook strength, clarity,
         * emotional intensity, novelty, and soundbite quality.
         */
        overall_score: number;

        /**
         * Moment start time in milliseconds.
         */
        start_ms: number;

        /**
         * Short catchy title for the moment (3-8 words).
         */
        title: string;

        /**
         * Scored visual concepts extracted from sampled frames. Present for video assets
         * only.
         */
        notable_visual_concepts?: Array<Moment.NotableVisualConcept>;

        /**
         * One-sentence summary of what is visually happening. Present for video assets
         * only.
         */
        visual_narrative?: string;
      }

      export namespace Moment {
        export interface Cue {
          /**
           * Cue end time in milliseconds.
           */
          end_ms: number;

          /**
           * Cue start time in milliseconds.
           */
          start_ms: number;

          /**
           * Transcript text for this cue.
           */
          text: string;
        }

        export interface NotableVisualConcept {
          /**
           * Multi-word visual concept (2-5 words).
           */
          concept: string;

          /**
           * Brief explanation of the relevance score.
           */
          rationale: string;

          /**
           * Relevance score from 0.0 to 1.0 measuring how closely the visual concept relates
           * to the audible narrative.
           */
          score: number;
        }
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobFindKeyMomentsErroredWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobFindKeyMomentsErroredWebhookEvent.Data;

  type: 'robots.job.find_key_moments.errored';
}

export namespace RobotsJobFindKeyMomentsErroredWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'find-key-moments';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to analyze.
       */
      asset_id: string;

      /**
       * Maximum number of key moments to extract. Defaults to 5.
       */
      max_moments?: number;

      /**
       * Preferred highlight duration range in milliseconds. When provided, the model
       * will aim to select moments within this range.
       */
      target_duration_ms?: Parameters.TargetDurationMs;
    }

    export namespace Parameters {
      /**
       * Preferred highlight duration range in milliseconds. When provided, the model
       * will aim to select moments within this range.
       */
      export interface TargetDurationMs {
        /**
         * Preferred maximum highlight duration in milliseconds.
         */
        max: number;

        /**
         * Preferred minimum highlight duration in milliseconds.
         */
        min: number;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Extracted key moments, ordered by position in the video.
       */
      moments: Array<Outputs.Moment>;
    }

    export namespace Outputs {
      export interface Moment {
        /**
         * One-sentence summary of what is being said during the moment.
         */
        audible_narrative: string;

        /**
         * Contiguous transcript segments that comprise this moment.
         */
        cues: Array<Moment.Cue>;

        /**
         * Moment end time in milliseconds.
         */
        end_ms: number;

        /**
         * Multi-word descriptive phrases (2-5 words each) capturing key audible concepts.
         */
        notable_audible_concepts: Array<string>;

        /**
         * Weighted quality score from 0.0 to 1.0 based on hook strength, clarity,
         * emotional intensity, novelty, and soundbite quality.
         */
        overall_score: number;

        /**
         * Moment start time in milliseconds.
         */
        start_ms: number;

        /**
         * Short catchy title for the moment (3-8 words).
         */
        title: string;

        /**
         * Scored visual concepts extracted from sampled frames. Present for video assets
         * only.
         */
        notable_visual_concepts?: Array<Moment.NotableVisualConcept>;

        /**
         * One-sentence summary of what is visually happening. Present for video assets
         * only.
         */
        visual_narrative?: string;
      }

      export namespace Moment {
        export interface Cue {
          /**
           * Cue end time in milliseconds.
           */
          end_ms: number;

          /**
           * Cue start time in milliseconds.
           */
          start_ms: number;

          /**
           * Transcript text for this cue.
           */
          text: string;
        }

        export interface NotableVisualConcept {
          /**
           * Multi-word visual concept (2-5 words).
           */
          concept: string;

          /**
           * Brief explanation of the relevance score.
           */
          rationale: string;

          /**
           * Relevance score from 0.0 to 1.0 measuring how closely the visual concept relates
           * to the audible narrative.
           */
          score: number;
        }
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobFindKeyMomentsPendingWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobFindKeyMomentsPendingWebhookEvent.Data;

  type: 'robots.job.find_key_moments.pending';
}

export namespace RobotsJobFindKeyMomentsPendingWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'find-key-moments';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to analyze.
       */
      asset_id: string;

      /**
       * Maximum number of key moments to extract. Defaults to 5.
       */
      max_moments?: number;

      /**
       * Preferred highlight duration range in milliseconds. When provided, the model
       * will aim to select moments within this range.
       */
      target_duration_ms?: Parameters.TargetDurationMs;
    }

    export namespace Parameters {
      /**
       * Preferred highlight duration range in milliseconds. When provided, the model
       * will aim to select moments within this range.
       */
      export interface TargetDurationMs {
        /**
         * Preferred maximum highlight duration in milliseconds.
         */
        max: number;

        /**
         * Preferred minimum highlight duration in milliseconds.
         */
        min: number;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Extracted key moments, ordered by position in the video.
       */
      moments: Array<Outputs.Moment>;
    }

    export namespace Outputs {
      export interface Moment {
        /**
         * One-sentence summary of what is being said during the moment.
         */
        audible_narrative: string;

        /**
         * Contiguous transcript segments that comprise this moment.
         */
        cues: Array<Moment.Cue>;

        /**
         * Moment end time in milliseconds.
         */
        end_ms: number;

        /**
         * Multi-word descriptive phrases (2-5 words each) capturing key audible concepts.
         */
        notable_audible_concepts: Array<string>;

        /**
         * Weighted quality score from 0.0 to 1.0 based on hook strength, clarity,
         * emotional intensity, novelty, and soundbite quality.
         */
        overall_score: number;

        /**
         * Moment start time in milliseconds.
         */
        start_ms: number;

        /**
         * Short catchy title for the moment (3-8 words).
         */
        title: string;

        /**
         * Scored visual concepts extracted from sampled frames. Present for video assets
         * only.
         */
        notable_visual_concepts?: Array<Moment.NotableVisualConcept>;

        /**
         * One-sentence summary of what is visually happening. Present for video assets
         * only.
         */
        visual_narrative?: string;
      }

      export namespace Moment {
        export interface Cue {
          /**
           * Cue end time in milliseconds.
           */
          end_ms: number;

          /**
           * Cue start time in milliseconds.
           */
          start_ms: number;

          /**
           * Transcript text for this cue.
           */
          text: string;
        }

        export interface NotableVisualConcept {
          /**
           * Multi-word visual concept (2-5 words).
           */
          concept: string;

          /**
           * Brief explanation of the relevance score.
           */
          rationale: string;

          /**
           * Relevance score from 0.0 to 1.0 measuring how closely the visual concept relates
           * to the audible narrative.
           */
          score: number;
        }
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobFindKeyMomentsProcessingWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobFindKeyMomentsProcessingWebhookEvent.Data;

  type: 'robots.job.find_key_moments.processing';
}

export namespace RobotsJobFindKeyMomentsProcessingWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'find-key-moments';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to analyze.
       */
      asset_id: string;

      /**
       * Maximum number of key moments to extract. Defaults to 5.
       */
      max_moments?: number;

      /**
       * Preferred highlight duration range in milliseconds. When provided, the model
       * will aim to select moments within this range.
       */
      target_duration_ms?: Parameters.TargetDurationMs;
    }

    export namespace Parameters {
      /**
       * Preferred highlight duration range in milliseconds. When provided, the model
       * will aim to select moments within this range.
       */
      export interface TargetDurationMs {
        /**
         * Preferred maximum highlight duration in milliseconds.
         */
        max: number;

        /**
         * Preferred minimum highlight duration in milliseconds.
         */
        min: number;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Extracted key moments, ordered by position in the video.
       */
      moments: Array<Outputs.Moment>;
    }

    export namespace Outputs {
      export interface Moment {
        /**
         * One-sentence summary of what is being said during the moment.
         */
        audible_narrative: string;

        /**
         * Contiguous transcript segments that comprise this moment.
         */
        cues: Array<Moment.Cue>;

        /**
         * Moment end time in milliseconds.
         */
        end_ms: number;

        /**
         * Multi-word descriptive phrases (2-5 words each) capturing key audible concepts.
         */
        notable_audible_concepts: Array<string>;

        /**
         * Weighted quality score from 0.0 to 1.0 based on hook strength, clarity,
         * emotional intensity, novelty, and soundbite quality.
         */
        overall_score: number;

        /**
         * Moment start time in milliseconds.
         */
        start_ms: number;

        /**
         * Short catchy title for the moment (3-8 words).
         */
        title: string;

        /**
         * Scored visual concepts extracted from sampled frames. Present for video assets
         * only.
         */
        notable_visual_concepts?: Array<Moment.NotableVisualConcept>;

        /**
         * One-sentence summary of what is visually happening. Present for video assets
         * only.
         */
        visual_narrative?: string;
      }

      export namespace Moment {
        export interface Cue {
          /**
           * Cue end time in milliseconds.
           */
          end_ms: number;

          /**
           * Cue start time in milliseconds.
           */
          start_ms: number;

          /**
           * Transcript text for this cue.
           */
          text: string;
        }

        export interface NotableVisualConcept {
          /**
           * Multi-word visual concept (2-5 words).
           */
          concept: string;

          /**
           * Brief explanation of the relevance score.
           */
          rationale: string;

          /**
           * Relevance score from 0.0 to 1.0 measuring how closely the visual concept relates
           * to the audible narrative.
           */
          score: number;
        }
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobGenerateChaptersCancelledWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobGenerateChaptersCancelledWebhookEvent.Data;

  type: 'robots.job.generate_chapters.cancelled';
}

export namespace RobotsJobGenerateChaptersCancelledWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'generate-chapters';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to generate chapters for.
       */
      asset_id: string;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK prefers English if available.
       */
      language_code?: string;

      /**
       * BCP 47 language code for the output chapter titles. Auto-detected from the
       * transcript if omitted.
       */
      output_language_code?: string;

      /**
       * Override specific sections of the chapter generation prompt.
       */
      prompt_overrides?: Parameters.PromptOverrides;
    }

    export namespace Parameters {
      /**
       * Override specific sections of the chapter generation prompt.
       */
      export interface PromptOverrides {
        /**
         * Override the chapter density and timing constraints.
         */
        chapter_guidelines?: string;

        /**
         * Override the JSON output format instructions.
         */
        output_format?: string;

        /**
         * Override the core task instruction for chapter generation.
         */
        task?: string;

        /**
         * Override the chapter title style requirements.
         */
        title_guidelines?: string;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Generated chapters, ordered by start time.
       */
      chapters: Array<Outputs.Chapter>;
    }

    export namespace Outputs {
      export interface Chapter {
        /**
         * Chapter start time in seconds. The first chapter always starts at 0.
         */
        start_time: number;

        /**
         * Concise chapter title.
         */
        title: string;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobGenerateChaptersCompletedWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobGenerateChaptersCompletedWebhookEvent.Data;

  type: 'robots.job.generate_chapters.completed';
}

export namespace RobotsJobGenerateChaptersCompletedWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'generate-chapters';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to generate chapters for.
       */
      asset_id: string;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK prefers English if available.
       */
      language_code?: string;

      /**
       * BCP 47 language code for the output chapter titles. Auto-detected from the
       * transcript if omitted.
       */
      output_language_code?: string;

      /**
       * Override specific sections of the chapter generation prompt.
       */
      prompt_overrides?: Parameters.PromptOverrides;
    }

    export namespace Parameters {
      /**
       * Override specific sections of the chapter generation prompt.
       */
      export interface PromptOverrides {
        /**
         * Override the chapter density and timing constraints.
         */
        chapter_guidelines?: string;

        /**
         * Override the JSON output format instructions.
         */
        output_format?: string;

        /**
         * Override the core task instruction for chapter generation.
         */
        task?: string;

        /**
         * Override the chapter title style requirements.
         */
        title_guidelines?: string;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Generated chapters, ordered by start time.
       */
      chapters: Array<Outputs.Chapter>;
    }

    export namespace Outputs {
      export interface Chapter {
        /**
         * Chapter start time in seconds. The first chapter always starts at 0.
         */
        start_time: number;

        /**
         * Concise chapter title.
         */
        title: string;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobGenerateChaptersErroredWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobGenerateChaptersErroredWebhookEvent.Data;

  type: 'robots.job.generate_chapters.errored';
}

export namespace RobotsJobGenerateChaptersErroredWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'generate-chapters';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to generate chapters for.
       */
      asset_id: string;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK prefers English if available.
       */
      language_code?: string;

      /**
       * BCP 47 language code for the output chapter titles. Auto-detected from the
       * transcript if omitted.
       */
      output_language_code?: string;

      /**
       * Override specific sections of the chapter generation prompt.
       */
      prompt_overrides?: Parameters.PromptOverrides;
    }

    export namespace Parameters {
      /**
       * Override specific sections of the chapter generation prompt.
       */
      export interface PromptOverrides {
        /**
         * Override the chapter density and timing constraints.
         */
        chapter_guidelines?: string;

        /**
         * Override the JSON output format instructions.
         */
        output_format?: string;

        /**
         * Override the core task instruction for chapter generation.
         */
        task?: string;

        /**
         * Override the chapter title style requirements.
         */
        title_guidelines?: string;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Generated chapters, ordered by start time.
       */
      chapters: Array<Outputs.Chapter>;
    }

    export namespace Outputs {
      export interface Chapter {
        /**
         * Chapter start time in seconds. The first chapter always starts at 0.
         */
        start_time: number;

        /**
         * Concise chapter title.
         */
        title: string;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobGenerateChaptersPendingWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobGenerateChaptersPendingWebhookEvent.Data;

  type: 'robots.job.generate_chapters.pending';
}

export namespace RobotsJobGenerateChaptersPendingWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'generate-chapters';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to generate chapters for.
       */
      asset_id: string;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK prefers English if available.
       */
      language_code?: string;

      /**
       * BCP 47 language code for the output chapter titles. Auto-detected from the
       * transcript if omitted.
       */
      output_language_code?: string;

      /**
       * Override specific sections of the chapter generation prompt.
       */
      prompt_overrides?: Parameters.PromptOverrides;
    }

    export namespace Parameters {
      /**
       * Override specific sections of the chapter generation prompt.
       */
      export interface PromptOverrides {
        /**
         * Override the chapter density and timing constraints.
         */
        chapter_guidelines?: string;

        /**
         * Override the JSON output format instructions.
         */
        output_format?: string;

        /**
         * Override the core task instruction for chapter generation.
         */
        task?: string;

        /**
         * Override the chapter title style requirements.
         */
        title_guidelines?: string;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Generated chapters, ordered by start time.
       */
      chapters: Array<Outputs.Chapter>;
    }

    export namespace Outputs {
      export interface Chapter {
        /**
         * Chapter start time in seconds. The first chapter always starts at 0.
         */
        start_time: number;

        /**
         * Concise chapter title.
         */
        title: string;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobGenerateChaptersProcessingWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobGenerateChaptersProcessingWebhookEvent.Data;

  type: 'robots.job.generate_chapters.processing';
}

export namespace RobotsJobGenerateChaptersProcessingWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'generate-chapters';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to generate chapters for.
       */
      asset_id: string;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK prefers English if available.
       */
      language_code?: string;

      /**
       * BCP 47 language code for the output chapter titles. Auto-detected from the
       * transcript if omitted.
       */
      output_language_code?: string;

      /**
       * Override specific sections of the chapter generation prompt.
       */
      prompt_overrides?: Parameters.PromptOverrides;
    }

    export namespace Parameters {
      /**
       * Override specific sections of the chapter generation prompt.
       */
      export interface PromptOverrides {
        /**
         * Override the chapter density and timing constraints.
         */
        chapter_guidelines?: string;

        /**
         * Override the JSON output format instructions.
         */
        output_format?: string;

        /**
         * Override the core task instruction for chapter generation.
         */
        task?: string;

        /**
         * Override the chapter title style requirements.
         */
        title_guidelines?: string;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Generated chapters, ordered by start time.
       */
      chapters: Array<Outputs.Chapter>;
    }

    export namespace Outputs {
      export interface Chapter {
        /**
         * Chapter start time in seconds. The first chapter always starts at 0.
         */
        start_time: number;

        /**
         * Concise chapter title.
         */
        title: string;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobModerateCancelledWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobModerateCancelledWebhookEvent.Data;

  type: 'robots.job.moderate.cancelled';
}

export namespace RobotsJobModerateCancelledWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'moderate';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to moderate.
       */
      asset_id: string;

      /**
       * BCP 47 language code for transcript analysis. Used only for audio-only assets;
       * ignored for video assets with visual content. If omitted for audio-only assets,
       * the first ready text track is used. Defaults to "en".
       */
      language_code?: string;

      /**
       * Maximum number of thumbnails to sample. Acts as a cap — if sampling_interval
       * produces fewer samples than this limit, the interval is respected; otherwise
       * samples are evenly distributed with first and last frames pinned.
       */
      max_samples?: number;

      /**
       * Interval, in seconds, between sampled thumbnails. Minimum 5 seconds. When
       * max_samples is also set, the actual sampling density is the more restrictive of
       * the two constraints.
       */
      sampling_interval?: number;

      /**
       * Score thresholds that determine whether content is flagged. When combined with
       * sampling_interval or max_samples, the exceeds_threshold flag reflects whether
       * any category's highest observed score exceeds its configured threshold. Defaults
       * to {sexual: 0.7, violence: 0.8}.
       */
      thresholds?: Parameters.Thresholds;
    }

    export namespace Parameters {
      /**
       * Score thresholds that determine whether content is flagged. When combined with
       * sampling_interval or max_samples, the exceeds_threshold flag reflects whether
       * any category's highest observed score exceeds its configured threshold. Defaults
       * to {sexual: 0.7, violence: 0.8}.
       */
      export interface Thresholds {
        /**
         * Score threshold for sexual content. Content scoring above this value triggers
         * exceeds_threshold.
         */
        sexual?: number;

        /**
         * Score threshold for violent content. Content scoring above this value triggers
         * exceeds_threshold.
         */
        violence?: number;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * True if any category's max score exceeds its configured threshold.
       */
      exceeds_threshold: boolean;

      /**
       * Highest scores across all thumbnails for each category.
       */
      max_scores: Outputs.MaxScores;

      /**
       * Per-thumbnail moderation scores.
       */
      thumbnail_scores: Array<Outputs.ThumbnailScore>;
    }

    export namespace Outputs {
      /**
       * Highest scores across all thumbnails for each category.
       */
      export interface MaxScores {
        sexual: number;

        violence: number;
      }

      export interface ThumbnailScore {
        /**
         * Sexual content score from 0.0 to 1.0.
         */
        sexual: number;

        /**
         * Violence content score from 0.0 to 1.0.
         */
        violence: number;

        /**
         * Time in seconds of the thumbnail within the video. Absent for transcript
         * moderation.
         */
        time?: number;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobModerateCompletedWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobModerateCompletedWebhookEvent.Data;

  type: 'robots.job.moderate.completed';
}

export namespace RobotsJobModerateCompletedWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'moderate';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to moderate.
       */
      asset_id: string;

      /**
       * BCP 47 language code for transcript analysis. Used only for audio-only assets;
       * ignored for video assets with visual content. If omitted for audio-only assets,
       * the first ready text track is used. Defaults to "en".
       */
      language_code?: string;

      /**
       * Maximum number of thumbnails to sample. Acts as a cap — if sampling_interval
       * produces fewer samples than this limit, the interval is respected; otherwise
       * samples are evenly distributed with first and last frames pinned.
       */
      max_samples?: number;

      /**
       * Interval, in seconds, between sampled thumbnails. Minimum 5 seconds. When
       * max_samples is also set, the actual sampling density is the more restrictive of
       * the two constraints.
       */
      sampling_interval?: number;

      /**
       * Score thresholds that determine whether content is flagged. When combined with
       * sampling_interval or max_samples, the exceeds_threshold flag reflects whether
       * any category's highest observed score exceeds its configured threshold. Defaults
       * to {sexual: 0.7, violence: 0.8}.
       */
      thresholds?: Parameters.Thresholds;
    }

    export namespace Parameters {
      /**
       * Score thresholds that determine whether content is flagged. When combined with
       * sampling_interval or max_samples, the exceeds_threshold flag reflects whether
       * any category's highest observed score exceeds its configured threshold. Defaults
       * to {sexual: 0.7, violence: 0.8}.
       */
      export interface Thresholds {
        /**
         * Score threshold for sexual content. Content scoring above this value triggers
         * exceeds_threshold.
         */
        sexual?: number;

        /**
         * Score threshold for violent content. Content scoring above this value triggers
         * exceeds_threshold.
         */
        violence?: number;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * True if any category's max score exceeds its configured threshold.
       */
      exceeds_threshold: boolean;

      /**
       * Highest scores across all thumbnails for each category.
       */
      max_scores: Outputs.MaxScores;

      /**
       * Per-thumbnail moderation scores.
       */
      thumbnail_scores: Array<Outputs.ThumbnailScore>;
    }

    export namespace Outputs {
      /**
       * Highest scores across all thumbnails for each category.
       */
      export interface MaxScores {
        sexual: number;

        violence: number;
      }

      export interface ThumbnailScore {
        /**
         * Sexual content score from 0.0 to 1.0.
         */
        sexual: number;

        /**
         * Violence content score from 0.0 to 1.0.
         */
        violence: number;

        /**
         * Time in seconds of the thumbnail within the video. Absent for transcript
         * moderation.
         */
        time?: number;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobModerateErroredWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobModerateErroredWebhookEvent.Data;

  type: 'robots.job.moderate.errored';
}

export namespace RobotsJobModerateErroredWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'moderate';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to moderate.
       */
      asset_id: string;

      /**
       * BCP 47 language code for transcript analysis. Used only for audio-only assets;
       * ignored for video assets with visual content. If omitted for audio-only assets,
       * the first ready text track is used. Defaults to "en".
       */
      language_code?: string;

      /**
       * Maximum number of thumbnails to sample. Acts as a cap — if sampling_interval
       * produces fewer samples than this limit, the interval is respected; otherwise
       * samples are evenly distributed with first and last frames pinned.
       */
      max_samples?: number;

      /**
       * Interval, in seconds, between sampled thumbnails. Minimum 5 seconds. When
       * max_samples is also set, the actual sampling density is the more restrictive of
       * the two constraints.
       */
      sampling_interval?: number;

      /**
       * Score thresholds that determine whether content is flagged. When combined with
       * sampling_interval or max_samples, the exceeds_threshold flag reflects whether
       * any category's highest observed score exceeds its configured threshold. Defaults
       * to {sexual: 0.7, violence: 0.8}.
       */
      thresholds?: Parameters.Thresholds;
    }

    export namespace Parameters {
      /**
       * Score thresholds that determine whether content is flagged. When combined with
       * sampling_interval or max_samples, the exceeds_threshold flag reflects whether
       * any category's highest observed score exceeds its configured threshold. Defaults
       * to {sexual: 0.7, violence: 0.8}.
       */
      export interface Thresholds {
        /**
         * Score threshold for sexual content. Content scoring above this value triggers
         * exceeds_threshold.
         */
        sexual?: number;

        /**
         * Score threshold for violent content. Content scoring above this value triggers
         * exceeds_threshold.
         */
        violence?: number;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * True if any category's max score exceeds its configured threshold.
       */
      exceeds_threshold: boolean;

      /**
       * Highest scores across all thumbnails for each category.
       */
      max_scores: Outputs.MaxScores;

      /**
       * Per-thumbnail moderation scores.
       */
      thumbnail_scores: Array<Outputs.ThumbnailScore>;
    }

    export namespace Outputs {
      /**
       * Highest scores across all thumbnails for each category.
       */
      export interface MaxScores {
        sexual: number;

        violence: number;
      }

      export interface ThumbnailScore {
        /**
         * Sexual content score from 0.0 to 1.0.
         */
        sexual: number;

        /**
         * Violence content score from 0.0 to 1.0.
         */
        violence: number;

        /**
         * Time in seconds of the thumbnail within the video. Absent for transcript
         * moderation.
         */
        time?: number;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobModeratePendingWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobModeratePendingWebhookEvent.Data;

  type: 'robots.job.moderate.pending';
}

export namespace RobotsJobModeratePendingWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'moderate';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to moderate.
       */
      asset_id: string;

      /**
       * BCP 47 language code for transcript analysis. Used only for audio-only assets;
       * ignored for video assets with visual content. If omitted for audio-only assets,
       * the first ready text track is used. Defaults to "en".
       */
      language_code?: string;

      /**
       * Maximum number of thumbnails to sample. Acts as a cap — if sampling_interval
       * produces fewer samples than this limit, the interval is respected; otherwise
       * samples are evenly distributed with first and last frames pinned.
       */
      max_samples?: number;

      /**
       * Interval, in seconds, between sampled thumbnails. Minimum 5 seconds. When
       * max_samples is also set, the actual sampling density is the more restrictive of
       * the two constraints.
       */
      sampling_interval?: number;

      /**
       * Score thresholds that determine whether content is flagged. When combined with
       * sampling_interval or max_samples, the exceeds_threshold flag reflects whether
       * any category's highest observed score exceeds its configured threshold. Defaults
       * to {sexual: 0.7, violence: 0.8}.
       */
      thresholds?: Parameters.Thresholds;
    }

    export namespace Parameters {
      /**
       * Score thresholds that determine whether content is flagged. When combined with
       * sampling_interval or max_samples, the exceeds_threshold flag reflects whether
       * any category's highest observed score exceeds its configured threshold. Defaults
       * to {sexual: 0.7, violence: 0.8}.
       */
      export interface Thresholds {
        /**
         * Score threshold for sexual content. Content scoring above this value triggers
         * exceeds_threshold.
         */
        sexual?: number;

        /**
         * Score threshold for violent content. Content scoring above this value triggers
         * exceeds_threshold.
         */
        violence?: number;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * True if any category's max score exceeds its configured threshold.
       */
      exceeds_threshold: boolean;

      /**
       * Highest scores across all thumbnails for each category.
       */
      max_scores: Outputs.MaxScores;

      /**
       * Per-thumbnail moderation scores.
       */
      thumbnail_scores: Array<Outputs.ThumbnailScore>;
    }

    export namespace Outputs {
      /**
       * Highest scores across all thumbnails for each category.
       */
      export interface MaxScores {
        sexual: number;

        violence: number;
      }

      export interface ThumbnailScore {
        /**
         * Sexual content score from 0.0 to 1.0.
         */
        sexual: number;

        /**
         * Violence content score from 0.0 to 1.0.
         */
        violence: number;

        /**
         * Time in seconds of the thumbnail within the video. Absent for transcript
         * moderation.
         */
        time?: number;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobModerateProcessingWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobModerateProcessingWebhookEvent.Data;

  type: 'robots.job.moderate.processing';
}

export namespace RobotsJobModerateProcessingWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'moderate';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to moderate.
       */
      asset_id: string;

      /**
       * BCP 47 language code for transcript analysis. Used only for audio-only assets;
       * ignored for video assets with visual content. If omitted for audio-only assets,
       * the first ready text track is used. Defaults to "en".
       */
      language_code?: string;

      /**
       * Maximum number of thumbnails to sample. Acts as a cap — if sampling_interval
       * produces fewer samples than this limit, the interval is respected; otherwise
       * samples are evenly distributed with first and last frames pinned.
       */
      max_samples?: number;

      /**
       * Interval, in seconds, between sampled thumbnails. Minimum 5 seconds. When
       * max_samples is also set, the actual sampling density is the more restrictive of
       * the two constraints.
       */
      sampling_interval?: number;

      /**
       * Score thresholds that determine whether content is flagged. When combined with
       * sampling_interval or max_samples, the exceeds_threshold flag reflects whether
       * any category's highest observed score exceeds its configured threshold. Defaults
       * to {sexual: 0.7, violence: 0.8}.
       */
      thresholds?: Parameters.Thresholds;
    }

    export namespace Parameters {
      /**
       * Score thresholds that determine whether content is flagged. When combined with
       * sampling_interval or max_samples, the exceeds_threshold flag reflects whether
       * any category's highest observed score exceeds its configured threshold. Defaults
       * to {sexual: 0.7, violence: 0.8}.
       */
      export interface Thresholds {
        /**
         * Score threshold for sexual content. Content scoring above this value triggers
         * exceeds_threshold.
         */
        sexual?: number;

        /**
         * Score threshold for violent content. Content scoring above this value triggers
         * exceeds_threshold.
         */
        violence?: number;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * True if any category's max score exceeds its configured threshold.
       */
      exceeds_threshold: boolean;

      /**
       * Highest scores across all thumbnails for each category.
       */
      max_scores: Outputs.MaxScores;

      /**
       * Per-thumbnail moderation scores.
       */
      thumbnail_scores: Array<Outputs.ThumbnailScore>;
    }

    export namespace Outputs {
      /**
       * Highest scores across all thumbnails for each category.
       */
      export interface MaxScores {
        sexual: number;

        violence: number;
      }

      export interface ThumbnailScore {
        /**
         * Sexual content score from 0.0 to 1.0.
         */
        sexual: number;

        /**
         * Violence content score from 0.0 to 1.0.
         */
        violence: number;

        /**
         * Time in seconds of the thumbnail within the video. Absent for transcript
         * moderation.
         */
        time?: number;
      }
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobSummarizeCancelledWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobSummarizeCancelledWebhookEvent.Data;

  type: 'robots.job.summarize.cancelled';
}

export namespace RobotsJobSummarizeCancelledWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'summarize';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to summarize.
       */
      asset_id: string;

      /**
       * Maximum description length in words.
       */
      description_length?: number;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK uses the default track.
       */
      language_code?: string;

      /**
       * BCP 47 language code for the generated summary output (e.g. "en", "fr", "ja").
       * Auto-detected from the transcript if omitted.
       */
      output_language_code?: string;

      /**
       * Override specific sections of the summarization prompt.
       */
      prompt_overrides?: Parameters.PromptOverrides;

      /**
       * Maximum number of tags to include in the generated output. Defaults to 10.
       */
      tag_count?: number;

      /**
       * Maximum title length in words.
       */
      title_length?: number;

      /**
       * Tone for the generated summary. "neutral" for straightforward analysis,
       * "playful" for witty and conversational, "professional" for executive-level
       * reporting.
       */
      tone?: 'neutral' | 'playful' | 'professional';
    }

    export namespace Parameters {
      /**
       * Override specific sections of the summarization prompt.
       */
      export interface PromptOverrides {
        /**
         * Override the description generation requirements.
         */
        description?: string;

        /**
         * Override the keyword/tag extraction requirements.
         */
        keywords?: string;

        /**
         * Override the quality standards for analysis.
         */
        quality_guidelines?: string;

        /**
         * Override the core task instruction for summarization.
         */
        task?: string;

        /**
         * Override the title generation requirements.
         */
        title?: string;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Generated description of the video content (typically 2-4 sentences).
       */
      description: string;

      /**
       * Generated keyword tags for the video.
       */
      tags: Array<string>;

      /**
       * Generated title capturing the essence of the video.
       */
      title: string;
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobSummarizeCompletedWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobSummarizeCompletedWebhookEvent.Data;

  type: 'robots.job.summarize.completed';
}

export namespace RobotsJobSummarizeCompletedWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'summarize';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to summarize.
       */
      asset_id: string;

      /**
       * Maximum description length in words.
       */
      description_length?: number;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK uses the default track.
       */
      language_code?: string;

      /**
       * BCP 47 language code for the generated summary output (e.g. "en", "fr", "ja").
       * Auto-detected from the transcript if omitted.
       */
      output_language_code?: string;

      /**
       * Override specific sections of the summarization prompt.
       */
      prompt_overrides?: Parameters.PromptOverrides;

      /**
       * Maximum number of tags to include in the generated output. Defaults to 10.
       */
      tag_count?: number;

      /**
       * Maximum title length in words.
       */
      title_length?: number;

      /**
       * Tone for the generated summary. "neutral" for straightforward analysis,
       * "playful" for witty and conversational, "professional" for executive-level
       * reporting.
       */
      tone?: 'neutral' | 'playful' | 'professional';
    }

    export namespace Parameters {
      /**
       * Override specific sections of the summarization prompt.
       */
      export interface PromptOverrides {
        /**
         * Override the description generation requirements.
         */
        description?: string;

        /**
         * Override the keyword/tag extraction requirements.
         */
        keywords?: string;

        /**
         * Override the quality standards for analysis.
         */
        quality_guidelines?: string;

        /**
         * Override the core task instruction for summarization.
         */
        task?: string;

        /**
         * Override the title generation requirements.
         */
        title?: string;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Generated description of the video content (typically 2-4 sentences).
       */
      description: string;

      /**
       * Generated keyword tags for the video.
       */
      tags: Array<string>;

      /**
       * Generated title capturing the essence of the video.
       */
      title: string;
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobSummarizeErroredWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobSummarizeErroredWebhookEvent.Data;

  type: 'robots.job.summarize.errored';
}

export namespace RobotsJobSummarizeErroredWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'summarize';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to summarize.
       */
      asset_id: string;

      /**
       * Maximum description length in words.
       */
      description_length?: number;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK uses the default track.
       */
      language_code?: string;

      /**
       * BCP 47 language code for the generated summary output (e.g. "en", "fr", "ja").
       * Auto-detected from the transcript if omitted.
       */
      output_language_code?: string;

      /**
       * Override specific sections of the summarization prompt.
       */
      prompt_overrides?: Parameters.PromptOverrides;

      /**
       * Maximum number of tags to include in the generated output. Defaults to 10.
       */
      tag_count?: number;

      /**
       * Maximum title length in words.
       */
      title_length?: number;

      /**
       * Tone for the generated summary. "neutral" for straightforward analysis,
       * "playful" for witty and conversational, "professional" for executive-level
       * reporting.
       */
      tone?: 'neutral' | 'playful' | 'professional';
    }

    export namespace Parameters {
      /**
       * Override specific sections of the summarization prompt.
       */
      export interface PromptOverrides {
        /**
         * Override the description generation requirements.
         */
        description?: string;

        /**
         * Override the keyword/tag extraction requirements.
         */
        keywords?: string;

        /**
         * Override the quality standards for analysis.
         */
        quality_guidelines?: string;

        /**
         * Override the core task instruction for summarization.
         */
        task?: string;

        /**
         * Override the title generation requirements.
         */
        title?: string;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Generated description of the video content (typically 2-4 sentences).
       */
      description: string;

      /**
       * Generated keyword tags for the video.
       */
      tags: Array<string>;

      /**
       * Generated title capturing the essence of the video.
       */
      title: string;
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobSummarizePendingWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobSummarizePendingWebhookEvent.Data;

  type: 'robots.job.summarize.pending';
}

export namespace RobotsJobSummarizePendingWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'summarize';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to summarize.
       */
      asset_id: string;

      /**
       * Maximum description length in words.
       */
      description_length?: number;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK uses the default track.
       */
      language_code?: string;

      /**
       * BCP 47 language code for the generated summary output (e.g. "en", "fr", "ja").
       * Auto-detected from the transcript if omitted.
       */
      output_language_code?: string;

      /**
       * Override specific sections of the summarization prompt.
       */
      prompt_overrides?: Parameters.PromptOverrides;

      /**
       * Maximum number of tags to include in the generated output. Defaults to 10.
       */
      tag_count?: number;

      /**
       * Maximum title length in words.
       */
      title_length?: number;

      /**
       * Tone for the generated summary. "neutral" for straightforward analysis,
       * "playful" for witty and conversational, "professional" for executive-level
       * reporting.
       */
      tone?: 'neutral' | 'playful' | 'professional';
    }

    export namespace Parameters {
      /**
       * Override specific sections of the summarization prompt.
       */
      export interface PromptOverrides {
        /**
         * Override the description generation requirements.
         */
        description?: string;

        /**
         * Override the keyword/tag extraction requirements.
         */
        keywords?: string;

        /**
         * Override the quality standards for analysis.
         */
        quality_guidelines?: string;

        /**
         * Override the core task instruction for summarization.
         */
        task?: string;

        /**
         * Override the title generation requirements.
         */
        title?: string;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Generated description of the video content (typically 2-4 sentences).
       */
      description: string;

      /**
       * Generated keyword tags for the video.
       */
      tags: Array<string>;

      /**
       * Generated title capturing the essence of the video.
       */
      title: string;
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobSummarizeProcessingWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobSummarizeProcessingWebhookEvent.Data;

  type: 'robots.job.summarize.processing';
}

export namespace RobotsJobSummarizeProcessingWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'summarize';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video to summarize.
       */
      asset_id: string;

      /**
       * Maximum description length in words.
       */
      description_length?: number;

      /**
       * BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When
       * omitted, the SDK uses the default track.
       */
      language_code?: string;

      /**
       * BCP 47 language code for the generated summary output (e.g. "en", "fr", "ja").
       * Auto-detected from the transcript if omitted.
       */
      output_language_code?: string;

      /**
       * Override specific sections of the summarization prompt.
       */
      prompt_overrides?: Parameters.PromptOverrides;

      /**
       * Maximum number of tags to include in the generated output. Defaults to 10.
       */
      tag_count?: number;

      /**
       * Maximum title length in words.
       */
      title_length?: number;

      /**
       * Tone for the generated summary. "neutral" for straightforward analysis,
       * "playful" for witty and conversational, "professional" for executive-level
       * reporting.
       */
      tone?: 'neutral' | 'playful' | 'professional';
    }

    export namespace Parameters {
      /**
       * Override specific sections of the summarization prompt.
       */
      export interface PromptOverrides {
        /**
         * Override the description generation requirements.
         */
        description?: string;

        /**
         * Override the keyword/tag extraction requirements.
         */
        keywords?: string;

        /**
         * Override the quality standards for analysis.
         */
        quality_guidelines?: string;

        /**
         * Override the core task instruction for summarization.
         */
        task?: string;

        /**
         * Override the title generation requirements.
         */
        title?: string;
      }
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Generated description of the video content (typically 2-4 sentences).
       */
      description: string;

      /**
       * Generated keyword tags for the video.
       */
      tags: Array<string>;

      /**
       * Generated title capturing the essence of the video.
       */
      title: string;
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobTranslateCaptionsCancelledWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobTranslateCaptionsCancelledWebhookEvent.Data;

  type: 'robots.job.translate_captions.cancelled';
}

export namespace RobotsJobTranslateCaptionsCancelledWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'translate-captions';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video whose captions will be translated.
       */
      asset_id: string;

      /**
       * BCP 47 language code for the translated output (e.g. "es", "ja"). The asset must
       * not already have a text track for this language.
       */
      to_language_code: string;

      /**
       * The Mux text track ID of the source caption track to translate. The asset must
       * have a ready text track matching this ID or the request will be rejected.
       */
      track_id: string;

      /**
       * Whether to upload the translated VTT and attach it as a text track on the Mux
       * asset. Defaults to true.
       */
      upload_to_mux?: boolean;
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Temporary pre-signed URL to download the translated VTT file. Present when
       * upload_to_mux is true.
       */
      temporary_vtt_url?: string;

      /**
       * The Mux text track ID of the source caption track that was translated.
       */
      track_id?: string;

      /**
       * Mux text track ID of the uploaded translated captions. Present when
       * upload_to_mux is true.
       */
      uploaded_track_id?: string;
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobTranslateCaptionsCompletedWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobTranslateCaptionsCompletedWebhookEvent.Data;

  type: 'robots.job.translate_captions.completed';
}

export namespace RobotsJobTranslateCaptionsCompletedWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'translate-captions';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video whose captions will be translated.
       */
      asset_id: string;

      /**
       * BCP 47 language code for the translated output (e.g. "es", "ja"). The asset must
       * not already have a text track for this language.
       */
      to_language_code: string;

      /**
       * The Mux text track ID of the source caption track to translate. The asset must
       * have a ready text track matching this ID or the request will be rejected.
       */
      track_id: string;

      /**
       * Whether to upload the translated VTT and attach it as a text track on the Mux
       * asset. Defaults to true.
       */
      upload_to_mux?: boolean;
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Temporary pre-signed URL to download the translated VTT file. Present when
       * upload_to_mux is true.
       */
      temporary_vtt_url?: string;

      /**
       * The Mux text track ID of the source caption track that was translated.
       */
      track_id?: string;

      /**
       * Mux text track ID of the uploaded translated captions. Present when
       * upload_to_mux is true.
       */
      uploaded_track_id?: string;
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobTranslateCaptionsErroredWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobTranslateCaptionsErroredWebhookEvent.Data;

  type: 'robots.job.translate_captions.errored';
}

export namespace RobotsJobTranslateCaptionsErroredWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'translate-captions';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video whose captions will be translated.
       */
      asset_id: string;

      /**
       * BCP 47 language code for the translated output (e.g. "es", "ja"). The asset must
       * not already have a text track for this language.
       */
      to_language_code: string;

      /**
       * The Mux text track ID of the source caption track to translate. The asset must
       * have a ready text track matching this ID or the request will be rejected.
       */
      track_id: string;

      /**
       * Whether to upload the translated VTT and attach it as a text track on the Mux
       * asset. Defaults to true.
       */
      upload_to_mux?: boolean;
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Temporary pre-signed URL to download the translated VTT file. Present when
       * upload_to_mux is true.
       */
      temporary_vtt_url?: string;

      /**
       * The Mux text track ID of the source caption track that was translated.
       */
      track_id?: string;

      /**
       * Mux text track ID of the uploaded translated captions. Present when
       * upload_to_mux is true.
       */
      uploaded_track_id?: string;
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobTranslateCaptionsPendingWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobTranslateCaptionsPendingWebhookEvent.Data;

  type: 'robots.job.translate_captions.pending';
}

export namespace RobotsJobTranslateCaptionsPendingWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'translate-captions';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video whose captions will be translated.
       */
      asset_id: string;

      /**
       * BCP 47 language code for the translated output (e.g. "es", "ja"). The asset must
       * not already have a text track for this language.
       */
      to_language_code: string;

      /**
       * The Mux text track ID of the source caption track to translate. The asset must
       * have a ready text track matching this ID or the request will be rejected.
       */
      track_id: string;

      /**
       * Whether to upload the translated VTT and attach it as a text track on the Mux
       * asset. Defaults to true.
       */
      upload_to_mux?: boolean;
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Temporary pre-signed URL to download the translated VTT file. Present when
       * upload_to_mux is true.
       */
      temporary_vtt_url?: string;

      /**
       * The Mux text track ID of the source caption track that was translated.
       */
      track_id?: string;

      /**
       * Mux text track ID of the uploaded translated captions. Present when
       * upload_to_mux is true.
       */
      uploaded_track_id?: string;
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export interface RobotsJobTranslateCaptionsProcessingWebhookEvent extends BaseWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  data: RobotsJobTranslateCaptionsProcessingWebhookEvent.Data;

  type: 'robots.job.translate_captions.processing';
}

export namespace RobotsJobTranslateCaptionsProcessingWebhookEvent {
  /**
   * The job that triggered the webhook event. In the actual payload this is nested
   * under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at
   * the top level.
   */
  export interface Data {
    /**
     * Unique job identifier.
     */
    id: string;

    /**
     * Unix timestamp (seconds) when the job was created.
     */
    created_at: number;

    parameters: Data.Parameters;

    /**
     * Current job status.
     */
    status: 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled';

    /**
     * Number of Mux AI units consumed by this job.
     */
    units_consumed: number;

    /**
     * Unix timestamp (seconds) when the job was last updated.
     */
    updated_at: number;

    workflow: 'translate-captions';

    /**
     * Error details. Present when status is 'errored'.
     */
    errors?: Array<Data.Error>;

    /**
     * Workflow results. Present when status is 'completed'.
     */
    outputs?: Data.Outputs;

    /**
     * Arbitrary string supplied at creation, returned as-is.
     */
    passthrough?: string;

    /**
     * Related Mux resources linked to this job.
     */
    resources?: Data.Resources;
  }

  export namespace Data {
    export interface Parameters {
      /**
       * The Mux asset ID of the video whose captions will be translated.
       */
      asset_id: string;

      /**
       * BCP 47 language code for the translated output (e.g. "es", "ja"). The asset must
       * not already have a text track for this language.
       */
      to_language_code: string;

      /**
       * The Mux text track ID of the source caption track to translate. The asset must
       * have a ready text track matching this ID or the request will be rejected.
       */
      track_id: string;

      /**
       * Whether to upload the translated VTT and attach it as a text track on the Mux
       * asset. Defaults to true.
       */
      upload_to_mux?: boolean;
    }

    export interface Error {
      /**
       * Human-readable public error message.
       */
      message: string;

      /**
       * Stable public error category identifier.
       */
      type: string;

      /**
       * Whether retrying this job may resolve the error.
       */
      retryable?: boolean;
    }

    /**
     * Workflow results. Present when status is 'completed'.
     */
    export interface Outputs {
      /**
       * Temporary pre-signed URL to download the translated VTT file. Present when
       * upload_to_mux is true.
       */
      temporary_vtt_url?: string;

      /**
       * The Mux text track ID of the source caption track that was translated.
       */
      track_id?: string;

      /**
       * Mux text track ID of the uploaded translated captions. Present when
       * upload_to_mux is true.
       */
      uploaded_track_id?: string;
    }

    /**
     * Related Mux resources linked to this job.
     */
    export interface Resources {
      /**
       * Mux assets associated with this job.
       */
      assets: Array<Resources.Asset>;
    }

    export namespace Resources {
      export interface Asset {
        /**
         * Mux asset ID.
         */
        id: string;

        /**
         * Hypermedia links for the asset.
         */
        _links: Asset._Links;

        /**
         * Mux asset metadata, if available.
         */
        meta?: Asset.Meta;

        /**
         * Passthrough string from the Mux asset.
         */
        passthrough?: string;
      }

      export namespace Asset {
        /**
         * Hypermedia links for the asset.
         */
        export interface _Links {
          self: _Links.Self;
        }

        export namespace _Links {
          export interface Self {
            /**
             * URL to the Mux asset resource.
             */
            href: string;
          }
        }

        /**
         * Mux asset metadata, if available.
         */
        export interface Meta {
          /**
           * Creator identifier from Mux metadata.
           */
          creator_id?: string;

          /**
           * External identifier from Mux metadata.
           */
          external_id?: string;

          /**
           * Asset title from Mux metadata.
           */
          title?: string;
        }
      }
    }
  }
}

export type UnwrapWebhookEvent =
  | VideoAssetCreatedWebhookEvent
  | VideoAssetReadyWebhookEvent
  | VideoAssetErroredWebhookEvent
  | VideoAssetUpdatedWebhookEvent
  | VideoAssetDeletedWebhookEvent
  | VideoAssetLiveStreamCompletedWebhookEvent
  | VideoAssetStaticRenditionsReadyWebhookEvent
  | VideoAssetStaticRenditionsPreparingWebhookEvent
  | VideoAssetStaticRenditionsDeletedWebhookEvent
  | VideoAssetStaticRenditionsErroredWebhookEvent
  | VideoAssetMasterReadyWebhookEvent
  | VideoAssetMasterPreparingWebhookEvent
  | VideoAssetMasterDeletedWebhookEvent
  | VideoAssetMasterErroredWebhookEvent
  | VideoAssetTrackCreatedWebhookEvent
  | VideoAssetTrackReadyWebhookEvent
  | VideoAssetTrackErroredWebhookEvent
  | VideoAssetTrackDeletedWebhookEvent
  | VideoAssetStaticRenditionCreatedWebhookEvent
  | VideoAssetStaticRenditionReadyWebhookEvent
  | VideoAssetStaticRenditionErroredWebhookEvent
  | VideoAssetStaticRenditionDeletedWebhookEvent
  | VideoAssetStaticRenditionSkippedWebhookEvent
  | VideoAssetWarningWebhookEvent
  | VideoAssetNonStandardInputDetectedWebhookEvent
  | VideoUploadAssetCreatedWebhookEvent
  | VideoUploadCancelledWebhookEvent
  | VideoUploadCreatedWebhookEvent
  | VideoUploadErroredWebhookEvent
  | VideoLiveStreamCreatedWebhookEvent
  | VideoLiveStreamConnectedWebhookEvent
  | VideoLiveStreamRecordingWebhookEvent
  | VideoLiveStreamActiveWebhookEvent
  | VideoLiveStreamDisconnectedWebhookEvent
  | VideoLiveStreamIdleWebhookEvent
  | VideoLiveStreamUpdatedWebhookEvent
  | VideoLiveStreamEnabledWebhookEvent
  | VideoLiveStreamDisabledWebhookEvent
  | VideoLiveStreamDeletedWebhookEvent
  | VideoLiveStreamWarningWebhookEvent
  | VideoLiveStreamSimulcastTargetCreatedWebhookEvent
  | VideoLiveStreamSimulcastTargetIdleWebhookEvent
  | VideoLiveStreamSimulcastTargetStartingWebhookEvent
  | VideoLiveStreamSimulcastTargetBroadcastingWebhookEvent
  | VideoLiveStreamSimulcastTargetErroredWebhookEvent
  | VideoLiveStreamSimulcastTargetDeletedWebhookEvent
  | VideoLiveStreamSimulcastTargetUpdatedWebhookEvent
  | VideoDeliveryHighTrafficWebhookEvent
  | RobotsJobAskQuestionsCancelledWebhookEvent
  | RobotsJobAskQuestionsCompletedWebhookEvent
  | RobotsJobAskQuestionsErroredWebhookEvent
  | RobotsJobAskQuestionsPendingWebhookEvent
  | RobotsJobAskQuestionsProcessingWebhookEvent
  | RobotsJobFindKeyMomentsCancelledWebhookEvent
  | RobotsJobFindKeyMomentsCompletedWebhookEvent
  | RobotsJobFindKeyMomentsErroredWebhookEvent
  | RobotsJobFindKeyMomentsPendingWebhookEvent
  | RobotsJobFindKeyMomentsProcessingWebhookEvent
  | RobotsJobGenerateChaptersCancelledWebhookEvent
  | RobotsJobGenerateChaptersCompletedWebhookEvent
  | RobotsJobGenerateChaptersErroredWebhookEvent
  | RobotsJobGenerateChaptersPendingWebhookEvent
  | RobotsJobGenerateChaptersProcessingWebhookEvent
  | RobotsJobModerateCancelledWebhookEvent
  | RobotsJobModerateCompletedWebhookEvent
  | RobotsJobModerateErroredWebhookEvent
  | RobotsJobModeratePendingWebhookEvent
  | RobotsJobModerateProcessingWebhookEvent
  | RobotsJobSummarizeCancelledWebhookEvent
  | RobotsJobSummarizeCompletedWebhookEvent
  | RobotsJobSummarizeErroredWebhookEvent
  | RobotsJobSummarizePendingWebhookEvent
  | RobotsJobSummarizeProcessingWebhookEvent
  | RobotsJobTranslateCaptionsCancelledWebhookEvent
  | RobotsJobTranslateCaptionsCompletedWebhookEvent
  | RobotsJobTranslateCaptionsErroredWebhookEvent
  | RobotsJobTranslateCaptionsPendingWebhookEvent
  | RobotsJobTranslateCaptionsProcessingWebhookEvent;

export declare namespace Webhooks {
  export {
    type BaseWebhookEvent as BaseWebhookEvent,
    type VideoAssetCreatedWebhookEvent as VideoAssetCreatedWebhookEvent,
    type VideoAssetReadyWebhookEvent as VideoAssetReadyWebhookEvent,
    type VideoAssetErroredWebhookEvent as VideoAssetErroredWebhookEvent,
    type VideoAssetUpdatedWebhookEvent as VideoAssetUpdatedWebhookEvent,
    type VideoAssetDeletedWebhookEvent as VideoAssetDeletedWebhookEvent,
    type VideoAssetLiveStreamCompletedWebhookEvent as VideoAssetLiveStreamCompletedWebhookEvent,
    type VideoAssetStaticRenditionsReadyWebhookEvent as VideoAssetStaticRenditionsReadyWebhookEvent,
    type VideoAssetStaticRenditionsPreparingWebhookEvent as VideoAssetStaticRenditionsPreparingWebhookEvent,
    type VideoAssetStaticRenditionsDeletedWebhookEvent as VideoAssetStaticRenditionsDeletedWebhookEvent,
    type VideoAssetStaticRenditionsErroredWebhookEvent as VideoAssetStaticRenditionsErroredWebhookEvent,
    type VideoAssetMasterReadyWebhookEvent as VideoAssetMasterReadyWebhookEvent,
    type VideoAssetMasterPreparingWebhookEvent as VideoAssetMasterPreparingWebhookEvent,
    type VideoAssetMasterDeletedWebhookEvent as VideoAssetMasterDeletedWebhookEvent,
    type VideoAssetMasterErroredWebhookEvent as VideoAssetMasterErroredWebhookEvent,
    type VideoAssetTrackCreatedWebhookEvent as VideoAssetTrackCreatedWebhookEvent,
    type VideoAssetTrackReadyWebhookEvent as VideoAssetTrackReadyWebhookEvent,
    type VideoAssetTrackErroredWebhookEvent as VideoAssetTrackErroredWebhookEvent,
    type VideoAssetTrackDeletedWebhookEvent as VideoAssetTrackDeletedWebhookEvent,
    type VideoAssetStaticRenditionCreatedWebhookEvent as VideoAssetStaticRenditionCreatedWebhookEvent,
    type VideoAssetStaticRenditionReadyWebhookEvent as VideoAssetStaticRenditionReadyWebhookEvent,
    type VideoAssetStaticRenditionErroredWebhookEvent as VideoAssetStaticRenditionErroredWebhookEvent,
    type VideoAssetStaticRenditionDeletedWebhookEvent as VideoAssetStaticRenditionDeletedWebhookEvent,
    type VideoAssetStaticRenditionSkippedWebhookEvent as VideoAssetStaticRenditionSkippedWebhookEvent,
    type VideoAssetWarningWebhookEvent as VideoAssetWarningWebhookEvent,
    type VideoAssetNonStandardInputDetectedWebhookEvent as VideoAssetNonStandardInputDetectedWebhookEvent,
    type VideoUploadAssetCreatedWebhookEvent as VideoUploadAssetCreatedWebhookEvent,
    type VideoUploadCancelledWebhookEvent as VideoUploadCancelledWebhookEvent,
    type VideoUploadCreatedWebhookEvent as VideoUploadCreatedWebhookEvent,
    type VideoUploadErroredWebhookEvent as VideoUploadErroredWebhookEvent,
    type VideoLiveStreamCreatedWebhookEvent as VideoLiveStreamCreatedWebhookEvent,
    type VideoLiveStreamConnectedWebhookEvent as VideoLiveStreamConnectedWebhookEvent,
    type VideoLiveStreamRecordingWebhookEvent as VideoLiveStreamRecordingWebhookEvent,
    type VideoLiveStreamActiveWebhookEvent as VideoLiveStreamActiveWebhookEvent,
    type VideoLiveStreamDisconnectedWebhookEvent as VideoLiveStreamDisconnectedWebhookEvent,
    type VideoLiveStreamIdleWebhookEvent as VideoLiveStreamIdleWebhookEvent,
    type VideoLiveStreamUpdatedWebhookEvent as VideoLiveStreamUpdatedWebhookEvent,
    type VideoLiveStreamEnabledWebhookEvent as VideoLiveStreamEnabledWebhookEvent,
    type VideoLiveStreamDisabledWebhookEvent as VideoLiveStreamDisabledWebhookEvent,
    type VideoLiveStreamDeletedWebhookEvent as VideoLiveStreamDeletedWebhookEvent,
    type VideoLiveStreamWarningWebhookEvent as VideoLiveStreamWarningWebhookEvent,
    type VideoLiveStreamSimulcastTargetCreatedWebhookEvent as VideoLiveStreamSimulcastTargetCreatedWebhookEvent,
    type VideoLiveStreamSimulcastTargetIdleWebhookEvent as VideoLiveStreamSimulcastTargetIdleWebhookEvent,
    type VideoLiveStreamSimulcastTargetStartingWebhookEvent as VideoLiveStreamSimulcastTargetStartingWebhookEvent,
    type VideoLiveStreamSimulcastTargetBroadcastingWebhookEvent as VideoLiveStreamSimulcastTargetBroadcastingWebhookEvent,
    type VideoLiveStreamSimulcastTargetErroredWebhookEvent as VideoLiveStreamSimulcastTargetErroredWebhookEvent,
    type VideoLiveStreamSimulcastTargetDeletedWebhookEvent as VideoLiveStreamSimulcastTargetDeletedWebhookEvent,
    type VideoLiveStreamSimulcastTargetUpdatedWebhookEvent as VideoLiveStreamSimulcastTargetUpdatedWebhookEvent,
    type VideoDeliveryHighTrafficWebhookEvent as VideoDeliveryHighTrafficWebhookEvent,
    type RobotsJobAskQuestionsCancelledWebhookEvent as RobotsJobAskQuestionsCancelledWebhookEvent,
    type RobotsJobAskQuestionsCompletedWebhookEvent as RobotsJobAskQuestionsCompletedWebhookEvent,
    type RobotsJobAskQuestionsErroredWebhookEvent as RobotsJobAskQuestionsErroredWebhookEvent,
    type RobotsJobAskQuestionsPendingWebhookEvent as RobotsJobAskQuestionsPendingWebhookEvent,
    type RobotsJobAskQuestionsProcessingWebhookEvent as RobotsJobAskQuestionsProcessingWebhookEvent,
    type RobotsJobFindKeyMomentsCancelledWebhookEvent as RobotsJobFindKeyMomentsCancelledWebhookEvent,
    type RobotsJobFindKeyMomentsCompletedWebhookEvent as RobotsJobFindKeyMomentsCompletedWebhookEvent,
    type RobotsJobFindKeyMomentsErroredWebhookEvent as RobotsJobFindKeyMomentsErroredWebhookEvent,
    type RobotsJobFindKeyMomentsPendingWebhookEvent as RobotsJobFindKeyMomentsPendingWebhookEvent,
    type RobotsJobFindKeyMomentsProcessingWebhookEvent as RobotsJobFindKeyMomentsProcessingWebhookEvent,
    type RobotsJobGenerateChaptersCancelledWebhookEvent as RobotsJobGenerateChaptersCancelledWebhookEvent,
    type RobotsJobGenerateChaptersCompletedWebhookEvent as RobotsJobGenerateChaptersCompletedWebhookEvent,
    type RobotsJobGenerateChaptersErroredWebhookEvent as RobotsJobGenerateChaptersErroredWebhookEvent,
    type RobotsJobGenerateChaptersPendingWebhookEvent as RobotsJobGenerateChaptersPendingWebhookEvent,
    type RobotsJobGenerateChaptersProcessingWebhookEvent as RobotsJobGenerateChaptersProcessingWebhookEvent,
    type RobotsJobModerateCancelledWebhookEvent as RobotsJobModerateCancelledWebhookEvent,
    type RobotsJobModerateCompletedWebhookEvent as RobotsJobModerateCompletedWebhookEvent,
    type RobotsJobModerateErroredWebhookEvent as RobotsJobModerateErroredWebhookEvent,
    type RobotsJobModeratePendingWebhookEvent as RobotsJobModeratePendingWebhookEvent,
    type RobotsJobModerateProcessingWebhookEvent as RobotsJobModerateProcessingWebhookEvent,
    type RobotsJobSummarizeCancelledWebhookEvent as RobotsJobSummarizeCancelledWebhookEvent,
    type RobotsJobSummarizeCompletedWebhookEvent as RobotsJobSummarizeCompletedWebhookEvent,
    type RobotsJobSummarizeErroredWebhookEvent as RobotsJobSummarizeErroredWebhookEvent,
    type RobotsJobSummarizePendingWebhookEvent as RobotsJobSummarizePendingWebhookEvent,
    type RobotsJobSummarizeProcessingWebhookEvent as RobotsJobSummarizeProcessingWebhookEvent,
    type RobotsJobTranslateCaptionsCancelledWebhookEvent as RobotsJobTranslateCaptionsCancelledWebhookEvent,
    type RobotsJobTranslateCaptionsCompletedWebhookEvent as RobotsJobTranslateCaptionsCompletedWebhookEvent,
    type RobotsJobTranslateCaptionsErroredWebhookEvent as RobotsJobTranslateCaptionsErroredWebhookEvent,
    type RobotsJobTranslateCaptionsPendingWebhookEvent as RobotsJobTranslateCaptionsPendingWebhookEvent,
    type RobotsJobTranslateCaptionsProcessingWebhookEvent as RobotsJobTranslateCaptionsProcessingWebhookEvent,
    type UnwrapWebhookEvent as UnwrapWebhookEvent,
  };
}