Chromecast

npm install @capnative/capacitor-chromecast
npx cap sync

import { Chromecast } from '@capnative/capacitor-chromecast';

await Chromecast.initialize({
  receiverApplicationId: 'YOUR_RECEIVER_APPLICATION_ID',
});

await Chromecast.addListener('sessionStateChanged', async (event) => {
  if (event.state === 'connected') {
    await Chromecast.loadMedia({
      url: 'https://example.com/video.mp4',
    });
  }
});

await Chromecast.show();

Platform setup

Chromecast runs on the native iOS and Android implementations. Web calls reject with UNSUPPORTED_PLATFORM.

You must provide a Google Cast receiver application ID, either to initialize or in Capacitor config. The package trims and uppercases the ID, then requires it to match ^[A-F0-9]{8}$. The shape cited in the plugin source is CC1AD845. Replace YOUR_RECEIVER_APPLICATION_ID with the ID from the Google Cast Developer Console.

Capacitor config

capacitor.config.ts, as published in the plugin README:

import { CapacitorConfig } from '@capacitor/cli';

export default CapacitorConfig({
  plugins: {
    Chromecast: {
      receiverApplicationId: 'YOUR_RECEIVER_APPLICATION_ID',
    },
  },
});

capacitor.config.json:

{
  "plugins": {
    "Chromecast": {
      "receiverApplicationId": "YOUR_RECEIVER_APPLICATION_ID"
    }
  }
}

iOS

Google Cast discovery needs local-network and Bonjour entries in the app Info.plist:

<key>NSLocalNetworkUsageDescription</key>
<string>This app uses Google Cast to discover and connect to nearby devices.</string>
<key>NSBonjourServices</key>
<array>
  <string>_googlecast._tcp</string>
  <string>_YOUR_RECEIVER_APPLICATION_ID._googlecast._tcp</string>
</array>

Minimum version is iOS 15. The README says a Bluetooth-enabled Google Cast SDK may also need Bluetooth usage descriptions, and points at Google’s Cast iOS setup for the SDK distribution you use. This repository does not list those keys.

Android

Minimum version is API 24. The plugin manifest is merged into the app and already declares:

• android.permission.INTERNET
• android.permission.ACCESS_NETWORK_STATE
• android.permission.ACCESS_WIFI_STATE
• android.permission.CHANGE_WIFI_STATE
• android.hardware.wifi with android:required="true"

It also registers the Cast options provider com.marioshtika.capacitorchromecast.ChromecastOptionsProvider and androidx.mediarouter.media.MediaTransferReceiver. Do not copy those entries into the app manifest.

The Android library depends on com.google.android.gms:play-services-cast-framework. The default version in the plugin Gradle file is 21.4.0 unless the app sets playServicesCastFrameworkVersion.

android:required="true" on Wi-Fi is part of the merged manifest, so the app will require Wi-Fi hardware.

Not implemented

The README lists follow-up APIs that are not in this version: getSession, disconnect, play, pause, stop, seek, setVolume, and getMediaStatus.

initialize(options: InitializeOptions) => Promise<void>

show() => Promise<void>

loadMedia(options: LoadMediaOptions) => Promise<void>

isConnected() => Promise<boolean>

removeAllListeners() => Promise<void>

addListener('sessionStateChanged', listenerFunc: (event: SessionStateChangedEvent) => void) => Promise<PluginListenerHandle>