CastContext

The metadata key to specify the fully qualified name of theOptionsProvider implementation in theAndroidManifest.xml.

Adds aCastStateListener to monitor changes of the currentCastState.

Adds a SessionTransferCallbackto monitor the transfer between different endpoints.

Returns theCastOptions.

Returns theCastReasonCodes for the givenCastStatusCodes.

Some of theCastStatusCodes are used by Cast SDK internally. This method translates thoseCastStatusCodes toCastReasonCodes which is developer-friendly.

Returns the currentCastState.

Returns the MediaNotificationManager.

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

Returns thePrecacheManager.

Returns theSessionManager, never returnsnull.

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

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

Returns an asynchronousTask APIcall on the shared instance ofCastContext, 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 providesCastButtonFactory to set up a Cast button.

Note that other activity methods, e.g.Activity.onResume(), need to check the availability of theCastContext object before using it, because theCastContext is initialized on theExecutor.

Note that ModuleUnavailableExceptioncould be thrown when the SDK fails to load the internal Cast module. The caller will get the exception fromTask.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);
}

The amount of volume delta to increase or decrease is set through CastOptions.Builder.setVolumeDeltaBeforeIceCreamSandwich(double).This method is a no-op on platform JELLY BEAN and above.

Removes aCastStateListener.

Removes a SessionTransferCallbackfrom 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 inCastOptions.

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, useMediaRouter APIs instead.