Driftwatch

APIs / Mux

Mux API changes

Breaking changes, deprecations and new fields in the Mux API, as they ship.

Mux2 behavioral4 additive
4 new response fields
  • ErrorResponse.error.messages
  • FindBestThumbnailsJobOutputs.asset_updates
  • GenerateChaptersJobOutputs.asset_updates
  • SummarizeJobOutputs.asset_updates
Mux1 breaking17 additive
  • Breakingdirection flip: their tools call this safe

    text_type can now return "chapters"

    Producer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.

    can now return "chapters"

    2 places: Track.text_type, InputSettings.text_type
    Code that breaks
    switch (response.text_type) {
      // existing branches …
      // no branch for "chapters"
      default:
        throw new Error("unexpected text_type");
    }
9 new response fields
  • TranslateAudioBindingParameters.track_name
  • EditCaptionsBindingParameters.replace_existing_tracks
  • EditCaptionsBindingParameters.track_name
  • TranslateCaptionsBindingParameters.track_name
  • EditCaptionsJobOutputs.replaced_tracks
  • EditCaptionsJobParameters.replace_existing_tracks
  • EditCaptionsJobParameters.track_name
  • TranslateAudioJobParameters.track_name
  • TranslateCaptionsJobParameters.track_name
8 new request properties
  • EditCaptionsBindingParameters.replace_existing_tracks
  • EditCaptionsBindingParameters.track_name
  • TranslateAudioBindingParameters.track_name
  • TranslateCaptionsBindingParameters.track_name
  • EditCaptionsJobParameters.replace_existing_tracks
  • EditCaptionsJobParameters.track_name
  • TranslateAudioJobParameters.track_name
  • TranslateCaptionsJobParameters.track_name
Mux1 additive
  • Additive

    Response field created_at added

    No action needed unless you validate responses against a closed schema.

    AssetShots.created_at · reachable from 8 operations
Mux2 breaking7 additive
  • Breaking

    Response field total_views removed

    Reads of this field return undefined, and the failure surfaces wherever that value is used rather than at the call.

    2 places: EngagementHeatmap.total_views, EngagementHotspots.total_views
    Code that breaks
    // response.total_views is now undefined
    const total_views = response.total_views;
  • Breaking

    Response field value removed

    EngagementHeatmap.value · reachable from 3 operations
    Code that breaks
    // response.value is now undefined
    const value = response.value;
7 new response fields
  • EngagementHotspots.asset_id
  • EngagementHotspots.playback_id
  • EngagementHeatmap.asset_id
  • EngagementHeatmap.heatmap
  • EngagementHeatmap.playback_id
  • EngagementHeatmap.video_id
  • EngagementHotspots.video_id