CastContext

The metadata key to specify the fully qualified name of the OptionsProvider implementation in the AndroidManifest.xml.

Adds a CastStateListener to monitor changes of the current CastState.

Adds a SessionTransferCallback to monitor the transfer between different endpoints.

Returns the CastOptions.

Returns the CastReasonCodes for the given CastStatusCodes.

Some of the CastStatusCodes are used by Cast SDK internally. This method translates those CastStatusCodes to CastReasonCodes which is developer-friendly.

Returns the current CastState.

Returns the MediaNotificationManager.

Returns the merged MediaRouteSelector used for discovering devices and deciding whether to show the MediaRouteButton. This selector is merged with any additional SessionProviders that might be registered with the CastContext.

Returns the PrecacheManager.

Returns the SessionManager, never returns null.

Returns a shared instance of CastContext. The shared instance will be initialized on the first time this method is called.

Returns the shared instance of CastContext. This method must be called after CastContext is initialized through getSharedInstance(Context, Executor). Otherwise, this method will return null.

Returns an asynchronous Task API call on the shared instance of CastContext, which will not block the caller thread. The shared instance will be initialized on the first time this method is called.

Note that getSharedInstance(Context, Executor) should be called in the Activity.onCreate(Bundle) method of the activities that might display a Cast button. The Cast SDK provides CastButtonFactory to set up a Cast button.

Note that other activity methods, for example Activity.onResume(), need to check the availability of the CastContext object before using it, because the CastContext is initialized on the Executor.

Note that ModuleUnavailableException could be thrown when the SDK fails to load the internal Cast module. The caller will get the exception from Task.getException() when the task completes.

If your application supports SDK versions before JELLY BEAN, you should call this method to delegate the handling of physical volume key events to the SDK so that users can use the physical volume keys to control device volume of the Cast receiver. Clients should override Activity.dispatchKeyEvent(KeyEvent) and call this method:

     @Override
     public boolean dispatchKeyEvent(KeyEvent event) {
         return CastContext.getSharedInstance().onDispatchVolumeKeyEventBeforeJellyBean(event)
                 || super.dispatchKeyEvent(event);
     }
 

Removes a CastStateListener.

Removes a SessionTransferCallback from monitoring endpoint transferring events.

Sets the credentials data of the current user. You should call this API with the current user information right after getSharedInstance() and whenever user account is changed.

Currently it serves two purposes:

• The credentials data will be embedded in the launch request. If it is to launch an Android TV app, the app can use the credentials data to determine if the app supports this specific user. If not, the cast app will be launched instead.
• If an Android TV app is launched, the credential data will be passed to the app, within the launch intent. The app can use this data to personalize the user experience.

Sets the receiver application ID. This overrides the receiver application ID specified in CastOptions.

Calling this method will result in the receiver application ID used for discovery and application launch being changed. The Cast button status will also changed accordingly. If the new application ID is different than the current one, the current session will be ended if there is any.

Specifying null or an empty string indicates that the app does not want to discover receiver devices or launch a receiver application.

For discovering for multiple application IDs at the same time, or for discovering for other application ID without affect the current session, use MediaRouter APIs instead.