| java.lang.Object | |
| ↳ | com.google.android.gms.cast.framework.CastContext |
A singleton class containing global context for the Cast SDK. The shared instance can be accessed
by calling getSharedInstance(Context).
To properly initialize CastContext, the application must have a class that implements
OptionsProvider interface:
package com.example.app;
public class CastOptionsProvider implements OptionsProvider {
@Override
public CastOptions getCastOptions(Context appContext) {
...
}
}
and specify its fully qualified class name in the AndroidManifest.xml with the key
OPTIONS_PROVIDER_CLASS_NAME_KEY:
...
<meta-data
android:name="com.google.android.gms.cast.framework.OPTIONS_PROVIDER_CLASS_NAME"
android:value="com.example.app.CastOptionsProvider" />
...
All public methods must be called from the main thread.
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | OPTIONS_PROVIDER_CLASS_NAME_KEY | The metadata key to specify the fully qualified name of the OptionsProvider
implementation in the AndroidManifest.xml. |
|||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Adds an
AppVisibilityListener to listen for UI visibility events. | |||||||||||
Adds a
CastStateListener to monitor changes of the current CastState. | |||||||||||
Returns the
CastOptions. | |||||||||||
Returns the
SessionManager, never returns null. | |||||||||||
Returns a shared instance of
CastContext. | |||||||||||
Returns
true if the application is visible. | |||||||||||
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.
| |||||||||||
If your application supports Android SDK versions below Ice Cream Sandwich, the SDK requires
your application to call this method in each of your
onCreate(Bundle) methods, so
that it can be notified of the visibility of your application. | |||||||||||
Removes an
AppVisibilityListener. | |||||||||||
Removes a
CastStateListener. | |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
The metadata key to specify the fully qualified name of the OptionsProvider
implementation in the AndroidManifest.xml.
Adds an AppVisibilityListener to listen for UI visibility events.
| IllegalStateException | If this method is not called on the main thread. |
|---|---|
| NullPointerException | If listener is null.
|
Adds a CastStateListener to monitor changes of the current CastState.
| IllegalStateException | If this method is not called on the main thread. |
|---|---|
| NullPointerException | If listener is null.
|
Returns the CastOptions.
| IllegalStateException | If this method is not called on the main thread. |
|---|
Returns the SessionManager, never returns null.
| IllegalStateException | If this method is not called on the main thread. |
|---|
Returns a shared instance of CastContext. The shared instance will be initialized
on the first time this method is called.
| context | An application Context. If this is not an application Context,
getApplicationContext() will be called on the given context, to retrieve it. |
|---|
| IllegalStateException | If
|
|---|
Returns true if the application is visible.
| IllegalStateException | If this method is not called on the main thread. |
|---|
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
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
setVolumeDeltaBeforeIceCreamSandwich(double).
This method is a no-op on platform JELLY BEAN and above.| event | The dispatched event. |
|---|
If your application supports Android SDK versions below Ice Cream Sandwich, the SDK requires
your application to call this method in each of your onCreate(Bundle) methods, so
that it can be notified of the visibility of your application. This method is a no-op on
Android devices running Ice Cream Sandwich or newer.
| activity | The calling FragmentActivity. |
|---|---|
| savedInstanceState | The savedInstanceState Bundle from the caller's
onCreate(Bundle) parameter. |
| IllegalStateException | If this method is not called on the main thread. |
|---|
Removes an AppVisibilityListener.
| IllegalStateException | If this method is not called on the main thread. |
|---|
Removes a CastStateListener.
| IllegalStateException | If this method is not called on the main thread. |
|---|