Skip to content
CapNative

AirPlay

Open the native iOS AirPlay route picker from a Capacitor app.

  • iOS, supported
  • Android, not supported
  • Web, not supported
Package
@capnative/capacitor-airplay
npm version
8.0.1
Capacitor
8.x · MIT
npmGitHubIssuesREADME

API checked against the repository README, TypeScript definitions, and npm on October 25, 2026.The README marks this major as maintained.

Install

Peer dependency: @capacitor/core >= 8.0.0

bash
npm install @capnative/capacitor-airplay
npx cap sync

Usage

typescript
import { AirPlay } from '@capnative/capacitor-airplay';

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

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

Platform setup

AirPlay is an iOS plugin. The repository README does not add Info.plist keys.

iOS

Minimum version is iOS 15. show() opens the system route picker. isAvailable() resolves with whether that picker can be opened from the current view controller.

Android

The plugin is not supported. isAvailable() resolves { available: false }. show() rejects with AirPlay is only available on iOS. The Android manifest shipped in the repository is empty.

Web

isAvailable() resolves { available: false }. show() rejects with AirPlay is not available on Web. AirPlay is only available on iOS.

TODO: the README does not say whether a consuming app must add any AirPlay-specific usage description. None is listed in the repository.

API

Method signatures match AirPlay in the plugin repository. Import it from @capnative/capacitor-airplay.

show()

Opens Apple's native AirPlay route picker on iOS.

Signature
show() => Promise<void>

isAvailable()

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

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

Returns Promise<{ available: boolean }>