Get Started

The Google Cast SDK includes API libraries and sample application code to help your applications go big. These APIs are documented in the API references, and the sample code is discussed in the Sender Applications and Receiver Applications overviews.

App Components

Here's what you need to build a Cast app.

  • A sender application, written for the Android, iOS, or Chrome platform which uses the following Cast APIs:
  • A receiver application that handles communication between the sender app and the receiver device. You have the following options:
    • The Default Media Receiver presented with the Google Cast branding and styling.
    • The Styled Media Receiver for which you can develop the styles and branding. See Styled Media Receiver.
    • A custom receiver, as described in Custom receiver that implements the Receiver API and handles custom messages from your sender app; it may also interface with the media player types provided through the Media Player Library.
    How you implement your receiver may depend upon which media types your application needs to support.

In accordance with the Google Cast SDK Additional Developer Terms of Service, a Cast media application must use the Media Playback Messages defined for the SDK to control media playback on the receiver. Doing so provides the media app with a consistent user experience across platforms and it ensures that a Cast application will support new and future use cases. These structures also support custom data, where appropriate, and an application may define its own messages for commands not supported by the SDK.

Setup for Development

  1. For all Google Cast devices, do the following:
    1. Install your Cast device and run through the setup instructions:

      For Chromecast devices, get the Google Cast app or Chrome extension. For other devices, see the manufacturer's instructions.

    2. Run the Google Cast app (for a phone or tablet) or extension (for a laptop) on your sender device, following the setup prompts as directed.
    3. Register your Google Cast device at the Google Cast SDK Developer Console.

      You must register the device so that you can use it for testing. See Devices for more information about registering devices.

  2. For Android TV, see Android TV with Google Cast.
  3. For Google Cast for audio devices, see Audio Devices.
  4. Review the User Experience Guidelines showing you how to implement a UI that is consistent with other Cast apps.
  5. Get the API libraries for sender and receiver apps.
  6. Try the Sample Apps to help you get started.
  7. Register your application.

    You will receive an app ID to include with your API calls.

  8. Develop your app.

Install API libraries

In this section you can download the APIs that will enable your application to cast content to a Google Cast receiver device.

The Google Cast SDK and API libraries support the development of Android, iOS, and Chrome sender applications, and the development of receiver applications in JavaScript - written for the Chrome browser.

iOS Sender API library

The iOS Sender API library Supports iOS version 8 and later.

You can install iOS Sender API libraries either manually or using Cocoapods, which we recommend.

Install Manually

Follow the instructions at Xcode setup.

Download the Cast v3 iOS Sender API libraries.

If you are using the Remote Display API (beta version), also download the Remote Display v2 API libraries.

If you are using the Game Manager API, also download the Game Manager v2 API libraries.

Install by Cocoapod

You can install the iOS Sender API libraries via Cocoapods.

  1. Install the Cocoapods binary, as explained in Cocoapods Getting Started.
    • The iOS SDK library is called google-cast-sdk.
    • The Remote Display API library is called google-cast-remote-display-sdk.
    • The Game Manager API library is called google-cast-games-sdk.
  2. Set up your XCode project to use the Google Cast SDK pod, as described in Using CocoaPods.

Android Sender API library

To set up your Android project, you need to:

  1. Add the Google Play services library to your project. For setup instructions, read Set Up Google Play Services SDK.
  2. Add the v7 mediarouter library to your project. This library provides the framework and UI components that allow your app to select the Google Cast media route. For setup instructions, read Support Library Setup and be sure you follow the section about Adding libraries with resources.

Chrome Sender API library

To use the Chrome Sender API, include in your Chrome page. The API requires Chrome version 32 or later and the Cast Extension version or later.

If you are using the Game Manager API, append ?loadGamesSDK to the cast_sender.js reference shown above.

Receiver API library

The receiver API is available from the receiver application once you register your receivers and devices for development. To use the API, include in your receiver application.

If you are using the Game Manager API, also include a reference to in your application.

Download Cast Icons

Download the Cast Icons for Android, iOS, and Chrome.

This file includes both bitmaps and vectors for the icons. These are also included with the Android v7 mediarouter library.