@capgo/capacitor-mux-player

Play adaptive bitrate Mux streams in a native player surface from your Capacitor app.

Overview

Pass a Mux playback ID or signed URL to play() and let the native Mux player handle ABR streaming, DRM tokens when required, and dismissal when the user closes the player. Use isActive() to avoid opening duplicate player instances.

Typical fits: course video, sports highlights, and any premium video that already lives on Mux.

Platform support

Platform	Support	Notes
iOS	Yes	Native Mux player integration
Android	Yes	Native Mux player integration
Web	See repo	Use Mux web player for browser targets

Core Capabilities

play - Launch the native Mux Player in fullscreen and begin playback.
dismiss - Dismiss the player if it is visible.
isActive - Returns whether the player is currently being displayed.

Public API

Method	Description
`play`	Launch the native Mux Player in fullscreen and begin playback.
`dismiss`	Dismiss the player if it is visible.
`isActive`	Returns whether the player is currently being displayed.
`removeAllListeners`	Remove all event listeners registered on the plugin instance.
`addListener`	Listen to player lifecycle or playback events emitted by the plugin.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-mux-player.

Keep going from @capgo/capacitor-mux-player

If you are using @capgo/capacitor-mux-player to plan native media and interface behavior, connect it with Using @capgo/capacitor-mux-player for the native capability in Using @capgo/capacitor-mux-player, Using @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities for the implementation detail in @capgo/capacitor-live-activities, Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player, and @capgo/capacitor-video-player for the implementation detail in @capgo/capacitor-video-player.