capacitor-airplay

A Capacitor plugin that opens Apple's native iOS AirPlay picker from JavaScript or TypeScript.

Compatibility

| Plugin version | Capacitor compatibility | Maintained | | -------------- | ----------------------- | ---------- | | v8.*.* | v8.*.* | ✅ |

Install

npm install capacitor-airplay
npx cap sync

Basic usage

import { AirPlay } from 'capacitor-airplay';

await AirPlay.show();

Availability check

const { available } = await AirPlay.isAvailable();

if (available) {
  await AirPlay.show();
}

API

• show()
• isAvailable()

show()

show() => Promise<void>

Opens Apple's native AirPlay route picker on iOS.

isAvailable()

isAvailable() => Promise<{ available: boolean; }>

Returns whether the native AirPlay route picker can be opened on the current platform.

Returns: Promise<{ available: boolean; }>