https://github.com/react-native-google-cast/react-native-google-cast

React Native wrapper for the Google Cast SDK
https://github.com/react-native-google-cast/react-native-google-cast

android cast-library chromecast ios react-native sdk

Last synced: 3 days ago
JSON representation

React Native wrapper for the Google Cast SDK

• Host: GitHub
• URL: https://github.com/react-native-google-cast/react-native-google-cast
• Owner: react-native-google-cast
• License: mit
• Created: 2016-05-23T04:06:07.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-09-11T16:00:36.000Z (5 months ago)
• Last Synced: 2025-01-16T06:03:20.601Z (10 days ago)
• Topics: android, cast-library, chromecast, ios, react-native, sdk
• Language: Java
• Homepage: https://react-native-google-cast.github.io
• Size: 10.1 MB
• Stars: 668
• Watchers: 19
• Forks: 256
• Open Issues: 79
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-react-native-native-modules - react-native-google-cast ★217

README

        
[![npm version](https://badge.fury.io/js/react-native-google-cast.svg)](https://badge.fury.io/js/react-native-google-cast)

# react-native-google-cast

This library wraps the native Google Cast SDK for Android and iOS (and maybe web/Chrome in the future), providing a unified JavaScript interface.

It is written in TypeScript so types will always be up-to-date.

## Version History

| RNGC | React Native | iOS | Android | Maintained | Notes                                                                            |

| ---- | ------------ | --- | ------- | ---------- | -------------------------------------------------------------------------------- |

| 1.x  | 🤷‍♂️           | 🤷‍♂️  | 🤷‍♂️      | 🛑         | Old version implemented for Google Cast SDK v2 with manual discoverability.      |

| 3.x  | >=0.40       | 🤷‍♂️  | 🤷‍♂️      | 🛑         | Rewrite of the library for Google Cast SDK v3 with automatic session management. |

| 4.x  | >=0.60       | 10+ |         | 🐜         | Completely rewritten API, closely resembling native Android/iOS APIs.            |

## Documentation

https://react-native-google-cast.github.io/docs/getting-started/installation

## Example

Refer to the [example](example/) folder to find a React Native version of the CastVideos reference app.

## Playground

Refer to the [playground](playground/) folder to find a sample app demonstrating the available APIs provided by the library.

## Expo

This library can by used by custom built Expo apps (not Expo Go) since Expo SDK 42. The config plugin is now included in this project. Follow [Installation](https://react-native-google-cast.github.io/docs/getting-started/installation#expo) and [Setup](https://react-native-google-cast.github.io/docs/getting-started/setup#expo) sections of the docs.

## Troubleshooting

See [Troubleshooting](https://react-native-google-cast.github.io/docs/getting-started/troubleshooting) in the docs.

## Contribution

1. Read [CONTRIBUTING.md](CONTRIBUTING.md)

2. Fork the repo

3. Implement your shiny new thing

4. Demonstrate how to use it in the [playground project](playground/)

5. Document the functionality in JSDoc and the [docs](docs/)

6. Create a pull request