Hide

Registration

You must register your application if you are using the Styled Media Receiver or if you are building a Custom Receiver. Once you've registered your application, you'll receive an application ID that your sender application must use to perform API calls such as to launch the receiver application.

If you use the Default Media Receiver, you do not have to register your application. The Default Media Receiver does not allow you to provide any styling to the media player UI, and uses a provided constant as the application ID.

You must also register your Google Cast device so that it may access your receiver application before you publish it. Once you publish your receiver application, it will be available to all Google Cast devices.

Applications

Registering your application allows you to test it against your registered Cast device before you publish the application. Publishing the application makes it available to all Cast devices.

Register your application

You must register your Styled Media Receiver or Custom Receiver in order to receive an application ID that's used with API calls from the sender application.

To register your Cast application:

  1. Sign in to the Google Cast SDK Developer Console.
  2. From either the Overview page or Applications page, click Add New Application.
  3. Select the type of receiver app you will use:
    Custom Receiver
    Select this if your app requires user interface components or interaction patterns that are not provided by the Styled Media Receiver. Selecting Custom Receiver may also be necessary if your content type is not listed as one of Styled Media Receiver's supported media types.

    Be aware that this option requires that you build a complete web app for the receiver app.

    For details, read Custom Receiver Application.

    Styled Media Receiver
    Select this if your app streams video or audio content using one of the supported media types and you'd like to provide a user interface on the TV that uses either the default media player UI or a set of custom styles on top of the default media player UI.

    The custom styles you may provide allow you to define the look for various elements of the player UI (such as the splash screen and progress bar) simply by providing a CSS file—you do not need to build a receiver app.

    For details, read Styled Media Receiver.

  4. Fill in the details for your receiver app:
    1. In the Name field, enter your app name.

      This is the application name as it appears when the receiver is loading or in the idle state if you are using the Styled Media Receiver. If you're using a Custom Receiver, how and when the app name appears is up to you.

    2. Specify the receiver app's appearance:
      • For a Custom Receiver, in the URL field, specify the app URL.

        Enter a URL that the Google Cast device should request when loading your receiver app. During development the URL can use HTTP but when the app is published it has to use HTTPS. The URL may be for an HTML page or other file type accessible from a web browser. It's okay for your receiver to be on an internal (NAT-registered) IP address, but not on localhost, as it is rarely a top level domain. Although the receiver app must be served over SSL (HTTPS) when published, the content loaded on the receiver app may be served over HTTP.

      • For a Styled Media Receiver, in the Skin URL field, specify the URL for the style sheet.

        Provide an HTTPS URL that points to your CSS file located on your own web site or on Google Drive. To use the default styles, leave the field empty. You can always edit this later to provide or update your custom styles.

      • Check or leave unchecked the Supports Google Cast Guest mode checkbox.

        Guest mode allows your receiver to support casting from senders not connected to the same WiFi network as the receiver. To disable guest mode for your receiver, uncheck this box. See Guest Mode for more information.

      • Check or leave unchecked the Supports casting to audio-only devices checkbox.

        To allow your app to discover Google Cast for audio devices, check this box. To disable support for audio-only devices, uncheck this box. See Audio Devices for more information.

  5. Click Save.

    Your registration details, including the application ID, name, type, and status are displayed. Make note of the application ID, as you will provide it with your application's Cast API calls.

  6. Click Done to return to the Applications page.

Edit application information

Before you can publish your application, you must provide some additional information. Here you can also update the information you provided about your application during registration.

To edit application information:

  1. In the Google Cast SDK Developer Console, from either the Overview page or Applications page, click on the Application ID or click Edit for the application you want to edit.
  2. In the Name field, update the name you provided when you registered the application.
  3. For Custom Receiver applications, in the URL field, update the location of the receiver application that you have registered.
  4. For Styled Receiver applications, in the Skin URL field, update the location of your application's style sheet.
  5. Check or leave unchecked the Supports Google Cast Guest mode checkbox.

    Guest mode allows your receiver to support casting from senders not connected to the same WiFi network as the receiver. To disable guest mode for your receiver, uncheck this box. See Guest Mode for more information.

  6. Check or leave unchecked the Supports casting to audio-only devices checkbox.

    To allow your app to discover Google Cast for audio devices, check this box. To disable support for audio-only devices, uncheck this box. See Audio Devices for more information.

  7. In the Sender Details section, provide the following for each platform your app supports:
    • Android: the fully-qualified name of your application package.
    • iOS: the iTunes ID and bundle ID required by Apple.
    • Chrome: the website URL for your application.
  8. In the Listing Details section, choose whether to list your application on Google properties such as chromecast.com/apps.
  9. From the Category drop-down menu, select the category which best describes your application.

    Note: Your app must support the media types described here as well as those implied by other settings. For example, if your app supports Google Cast for audio, and you select TV & Movies here, your app must support audio-only devices as described in Audio Devices, as well as the provisions for video playback.

  10. To describe the countries in which your app is available, select either the All countries or Only in selected countries radio button; if specifying countries, check the boxes for those countries in the list that appears.
  11. In the Title field, provide a descriptive title for your application.

    Use 50 characters or fewer. For example, "YouTube."

  12. In the Description field, enter a description for your application.

    Use 80 characters or fewer. For example, "Enjoy your favorite YouTube channels on the best screen in the house."

  13. In the Graphics section, click the plus sign to upload the icon image for your application.

    The image must be 512 X 512 pixels, and may have a transparent background.

  14. Under Add Your Own Translations, if you want to provide translations for the Title and Description fields, select the language from the drop-down menu, click Add, and enter the translated text in the dialog that appears; you can also upload an image for the icon specific to that translation.
  15. When you've finished updating your application information, click Save.

Publish your application

Publishing your application makes your application available to all Cast devices worldwide. It also creates a listing for your application on Google properties such as the chromecast.com/apps listing site, where users can discover and download your app. If you have elected to list your app when you edited application information in step 6, above, it will appear in chromecast.com/apps once it is published.

You must provide all of the information described in Edit application information before you can publish your application.

To publish your application:

  1. In the Google Cast SDK Developer Console, from either the Overview page or Applications page, for the application you want to publish, click Publish.

    If your application information is complete, a preview sceen appears with the application information you entered in Edit application information, above. If not, a message appears citing the information you need to provide.

  2. You can click Edit to go back and update any information.
  3. If you're ready to publish your application, click Publish.

Devices

By default, Google Cast devices (such as a Chromecast or an Android TV device) are not enabled for development and testing. To turn your device into a development device and gain access to your receiver app while it is not yet published, you must register the device. Registering also makes the receiver app accessible from a remote browser window for debugging (see Debugging).

To register your Google Cast device:

  1. Set up your Google Cast device and connect it to the wifi network.

    See the Cast Device Setup instructions.

  2. On a computer connected to the same wifi network as your Google Cast device, run the latest Chrome browser with the Google Cast extension installed.
  3. Sign in to the Google Cast SDK Developer Console.
  4. From either the Overview page or Devices page, click Add New Device.
  5. Enter the serial number of your device.

    Obtain the serial number as follows:

    1. Click the Cast button (as if you were casting this page).

      The extension displays Cast: cast.google.com to... and lists the devices available.

    2. From the drop-down menu, select the device for which you want to obtain the serial number.

      For Chromecast and Android TV devices, the serial number displays on the TV screen and plays aloud on the TV speakers. For Cast for audio devices, the serial number plays aloud on the Cast for audio device speakers.

    For an Android TV device you can also get the serial number on Android TV: from the Settings menu, select About and scroll down to see the Serial Number.

  6. Enter a description, and click OK.

    This is just a friendly name for your device (it does not need to match the name you gave to the device during user setup).

  7. Wait fifteen minutes before continuing.

    Once registration is complete, the Status for the device will read "Ready for Testing."

  8. Restart your Cast device: disconnect the power or USB cable from the device, then reconnect it.