Mux v1.9.0 API Reference

Modules

Mux

Official Mux API wrapper for Elixir projects, supporting both Mux Data and Mux Video.

This module provides functions for working with playback errors, which is typically an error thrown by the player that caused playback failure. API Documentation.

This module provides functions for accessing lists of data exports. Currently the only exports available are raw video views. API Documentation

This module includes functions for retrieving available filters and their values in our system. These endpoints, for example, are used to construct the breakdown tables in the metrics UI. API Documentation

This module includes functions for retrieving available incidents and their values in our system. These endpoints, for example, are used to construct the incidents tables in the alerts UI. API Documentation

This module provides functions that interact with the metrics endpoints, which includes a bulk of the data product's statistical data.

This module provides functions that interact with the real-time endpoints

This module provides functions for interacting with individual video views. Note, the raw video views contain quite a lot of data, so the list endpoint includes a filtered set of keys for each view. API Documentation.

This module provides helpers for working with Playback IDs with signed playback policies. API Documentation

This module provides functions for managing assets in Mux Video. API Documentation

This module provides functions for reading delivery usage in Mux Video. API Documentation

This module provides functions for managing live streams in Mux Video. API Documentation

This module provides functions around managing Playback IDs in Mux Video. Playback IDs are the public identifier for streaming a piece of content and can include policies such as signed or public. API Documentation.

This module provides functions for managing signing keys in Mux Video. API Documentation

This module provides functions around managing tracks in Mux Video. Tracks are used for subtitles/captions. API Documentation.

This module provides functions for managing direct uploads in Mux Video. API Documentation

This module provides a function for verifying webhook signatures

This module provides a utility function for generating valid signatures. You are encouraged to use it for testing how your application behaves against malicious requests.