Guide
How to use Mux Player in Capacitor
Using @capgo/capacitor-mux-player
Native Mux Player SDK to play video on IOS and Android.
Install
bun add @capgo/capacitor-mux-player
bunx cap sync
bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.
Import
import { MuxPlayer } from '@capgo/capacitor-mux-player';
API at a glance
| 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. |
Examples
play()
Launch the native Mux Player in fullscreen and begin playback.
import { MuxPlayer } from '@capgo/capacitor-mux-player';
await MuxPlayer.play({ playbackId: 'playback-id-123' });
dismiss()
Dismiss the player if it is visible.
import { MuxPlayer } from '@capgo/capacitor-mux-player';
await MuxPlayer.dismiss();
isActive()
Returns whether the player is currently being displayed.
import { MuxPlayer } from '@capgo/capacitor-mux-player';
const result = await MuxPlayer.isActive();
console.log(result);
Listen to events
addListener returns a handle. Call handle.remove() when the screen unmounts, or MuxPlayer.removeAllListeners() to clear every listener.
Full reference
Keep going from Using @capgo/capacitor-mux-player
If you are using Using @capgo/capacitor-mux-player to plan native media and interface behavior, connect it with @capgo/capacitor-mux-player for the implementation detail in @capgo/capacitor-mux-player, Getting Started for the implementation detail in Getting Started, 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, and Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player.