Installation

$ npm install react-native-google-cast --save

or

$ yarn add react-native-google-cast

Expo

Since Expo SDK 42, you can use this library in a custom-built Expo app. There is a config plugin included to auto-configure react-native-google-cast when the native code is generated (npx expo prebuild).

This package cannot be used in the "Expo Go" app because it requires custom native code.

Add the config plugin to the plugins array of your app.json or app.config.js:

{
  "expo": {
    "plugins": [
      "react-native-google-cast",
      ["expo-build-properties", { "ios": { "deploymentTarget": "14.0" } }]
    ]
  }
}

The latest Google Cast SDK (currently 4.8.1) only supports iOS 14 or newer, which we can configure using expo-build-properties. If you need to support older iOS versions, use an older version of the library but note that some features might not be available.

Next, rebuild your app as described in the "Adding custom native code" guide.

Then ignore the rest of this page and continue to Setup.

iOS

Thanks to autolinking, the package and its Google Cast SDK dependency are automatically installed when you run pod install.

The latest Google Cast SDK (currently 4.8.1) only supports iOS 14 or newer. Ensure that you set deployment target to iOS 14 or higher. Otherwise, an older version of the SDK will be installed and some features might not be available.

Before v4.8.1, Google Cast used to publish different variants of the SDK based on whether they included Guest Mode support. That feature has been removed in the latest versions so now there's only a single SDK variant.

Android

Insert the following into android/app/build.gradle:

dependencies {
  // ...
  implementation "com.google.android.gms:play-services-cast-framework:${safeExtGet('castFrameworkVersion', '+')}"
}

def safeExtGet(prop, fallback) {
  rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
}

By default, the latest version (+) of the Cast SDK is used. To use a specific version, set it in the root android/build.gradle:

buildscript {
  ext {
    buildToolsVersion = "34.0.0"
    minSdkVersion = 22
    compileSdkVersion = 34
    targetSdkVersion = 34
    castFrameworkVersion = "21.4.0" // <-- Cast SDK version
  }
}

Chrome

Not supported yet