DOCSEARCHbyAlgolia
Submit Docs

Mux Video Documentation

website·Indexed 43 days ago

https://www.mux.com/docs

Developer guides and API references for Mux, a platform for video and audio streaming. Includes documentation on assets, live streams, playback IDs, webhooks, and official SDKs for Node.js, Python, PHP, Ruby, Elixir, Java, and .NET. Covers core concepts like organizations, environments, and secure video playback using signing keys and JWTs.

Tokens
231.1K
Snippets
980
Records
1.5K
Agent score
75%

What's inside Mux

  1. Overview of Mux Data Custom Dimensions

    Custom Dimensions allow developers to define, submit, and report on metadata that is not part of the pre-defined Mux Data collection (e.g., device firmware version or subscription plan type). Each custom dimension has a pre-defined field name (such as custom_1) used in code and API calls, as well as a configurable display name and category for reporting in the Mux Dashboard.

  2. Overview of Mux Data for Kaltura Player (iOS and tvOS)

    Mux Data allows you to collect playback performance metrics from the Kaltura player on iOS and tvOS. It supports iOS 13.0+ and tvOS 13.0+, is built on Mux's core Objective-C SDK, and supports Mac Catalyst via XCFramework. You do not need Mux Video to use Mux Data.

    Collected metrics include:

    • Engagement and Quality of Experience (QoE) metrics
    • Average Bitrate and renditionchange events
    • Request metrics
    • Customizable Error Tracking
    • Ads metrics
    • Custom Dimensions

  3. Overview of Mux Data Alert Types

    Mux Data provides two types of alerts to notify teams when quality metrics cross thresholds or deviate from normal ranges:

    1. Anomaly Alerts: Automatically configured based on historical failure rates. They trigger when failures are elevated over a moving-window historical level. They operate at two levels: Organization-wide (1000 view buckets) and Per Video Title (100 view buckets).
    2. Threshold Alerts: User-defined criteria for specific viewer experience metrics. These are available on Mux Data Media plans.

  4. Overview of static MP4 and M4A renditions

    Static renditions are downloadable versions of video assets in MPEG-4 video (.mp4) or audio (.m4a) format, created alongside the default HLS streaming format. They are primarily used for offline playback, social media cards (Open Graph), transcription services, and compatibility with very old devices (e.g., Android < v4.0) or very short videos (< 10s).

    Static renditions are created at the same quality level (Basic, Plus, or Premium) as the original Mux video. Note that static renditions take longer to process than HLS versions; they are ready when the individual file status is ready, which triggers a video.asset.static_rendition.ready webhook.

  5. Overview of Mux Video Usage Exports

    Mux Video Usage Exports allow users on paid plans to export up to 13 months of daily usage data as CSV files. These exports provide a granular breakdown of input, storage, and delivery usage by environment_id and creator_id. Each CSV contains a row for every asset that generated usage during that calendar day (00:00:00–23:59:59 UTC). To utilize creator-level reporting, a creator_id must be set on the assets.

  6. Overview of Mux Data and PagerDuty integration

    Mux Data integrates with PagerDuty to send alert incidents (based on specified thresholds or machine-learned anomaly detection) to on-call teams. When a video metric triggers a new incident in Mux Data, a trigger event is sent to PagerDuty to generate a corresponding incident. When the incident is resolved in Mux Data, a resolve event is sent to PagerDuty to close the incident.

  7. Overview of Mux Robots AI workflows

    The Mux Robots API allows developers to run AI workflows on videos using a single API request without managing their own AI pipeline. It handles model selection, prompting, retries, and webhook delivery.

    Available workflows include:

    • Accessibility: Generate premium captions, edit captions, translate captions, and translate audio (dubbing).
    • Insights: Summarize (title, description, tags), ask questions about video content, find key moments, find best thumbnails, and generate engagement insights.
    • Structure: Generate timestamped chapters and find scenes.
    • Trust & Safety: Moderate video for inappropriate content.

    For complex orchestration (running multiple workflows in order or triggering them on ingestion), use Mux Directives. For low-level control (custom prompts, specific LLM providers), use the @mux/ai TypeScript SDK.

  8. Overview of Mux Simulcasting

    Simulcasting allows developers to enable users to publish a single Mux live stream to multiple social platforms (such as YouTube, Facebook, and Twitch) simultaneously. It works with any arbitrary RTMP server, supporting any platform that uses the RTMP or RTMPS protocol. Common targets include Facebook Live, YouTube Live, Instagram Live, Twitch, Crowdcast, and Vimeo.

  9. Overview of Mux DRM capabilities and device support

    Mux DRM provides content security to block screen recording, screen sharing, and downloading tools using Google Widevine, Microsoft PlayReady, and Apple FairPlay. It requires the use of Signed URLs and can be further hardened with Domain and User-Agent restrictions.

    Protection levels vary by device:

    • iPhone/iPad: Full support for encrypted video, screen capture protection, and HDCP enforcement.
    • Modern Android (Android 12+, Pixel, Samsung with Widevine L1): Encrypted video and usually screen capture protection; no HDCP enforcement.
    • Older/Low-end Android: Encrypted video; screen capture protection is inconsistent and less secure; no HDCP enforcement.
    • Chrome/Edge (Desktop): Encrypted video; screen capture protection is inconsistent (software-based); no HDCP enforcement.

  10. Overview of Mux Data engagement and quality metrics

    Mux provides two primary categories of metrics to track viewership and optimize the end-user experience: engagement metrics and five top-level quality of experience (QoE) metrics. These metrics are accessible through the Mux Data Dashboard and the Mux Data API. To make these metrics actionable and allow for data segmentation, users should provide metadata for each view.

  11. Overview of Mux Data for CTS PDK

    Mux Data integrates with the Comcast Technology Solutions Player Development Kit (CTS PDK) to collect playback performance metrics. It allows developers to monitor the viewer experience without requiring Mux Video. Collected data includes engagement metrics, Quality of Experience (QoE) metrics, web metrics (e.g., Player Startup Time, Page Load Time), custom dimensions, and custom beacon domains. Note that Video Quality metrics are not available for this integration.

  12. Overview of auto-generated live closed captions

    Mux provides AI-based speech-to-text auto-generated live closed captions for English, French, German, Italian, Portuguese, and Spanish. This feature is best suited for non-technical content with clear audio and minimal background noise. Content with music or multiple overlapping speakers is not recommended. Accuracy typically ranges from 70% to 95%.