SessionManager

public classSessionManagerextendsObject

A class that managesSession instances. The application can attach aSessionManagerListener to be notified of session events.

SessionManager works with AndroidMediaRouteron managing session lifecycle. The current session always uses the current selected route (which corresponds toMediaRouter.getSelectedRoute()).

SessionManager listens to route changes fromMediaRoutervia MediaRouter.addCallback(MediaRouteSelector, MediaRouter.Callback).For each session type it supports, either a Cast session type or a custom session type as specified by aSessionProvider, aMediaRouter.Callback will be added toMediaRouterwith a correspondingMediaRouteSelector generated using the category fromSessionProvider.getCategory().For Cast sessions, the category is generated according toCastOptions.getReceiverApplicationId().

When a route is selected inMediaRouter,the corresponding callback will be executed andSessionManager will callSessionProvider.createSession(String)to create a session. Then it will try to start a new session or resume the session that was shutdown incorrectly. When a session has ended, failed on start or failed on resume,SessionManager will unselect the corresponding route.

When a route is unselected inMediaRouter,the corresponding callback will be executed andSessionManager will end the current session if it is using the unselected route.

BecauseSessionManager listens to route selection signals to start and end sessions, Cast dialog must make sure to update the route selection state in AndroidMediaRouter.The device chooser dialog must callMediaRouter.selectRoute(MediaRouter.RouteInfo)orMediaRouter.RouteInfo.select() when the user selects a device. The route controller dialog must callMediaRouter.unselect(int) (orendCurrentSession(boolean)when the user clicks the "Stop Casting" (or "Disconnect" ) button.

Based on how an app creates Cast dialogs, the following actions needs to be done:

If the app creates Cast dialogs usingMediaRouteChooserDialog andMediaRouteControllerDialog, then these dialogs will update route selection inMediaRouter automatically, so nothing needs to be done.
If the app sets up the Cast button usingCastButtonFactory.setUpMediaRouteButton(Context, Menu, int)orCastButtonFactory.setUpMediaRouteButton(Context, MediaRouteButton),then the dialogs are actually created usingMediaRouteChooserDialog andMediaRouteControllerDialog, so nothing needs to be done.
For other cases, the app will be creating custom Cast dialogs, so it needs to follow the above instructions to update the route selection state inMediaRouter.

Public Method Summary

void	addSessionManagerListener(SessionManagerListener<Session> listener) Adds a`SessionManagerListener`to monitor events from any type of `Session` instance.
<T extendsSession> void	addSessionManagerListener(SessionManagerListener<T> listener,Class<T> sessionClass) Adds a`SessionManagerListener`to monitor events from a`Session` instance whose class is`sessionClass`.
void	endCurrentSession(boolean stopCasting) Ends the current session.
CastSession	getCurrentCastSession() Returns the current session if it is an instance of`CastSession`, otherwise returns`null`.
Session	getCurrentSession() Returns the currently active session.
void	removeSessionManagerListener(SessionManagerListener<Session> listener) Removes the`SessionManagerListener`.
<T extendsSession> void	removeSessionManagerListener(SessionManagerListener<T> listener,Class<T> sessionClass) Removes the`SessionManagerListener`.
void	startSession(Intent startSessionIntent) Starts a session.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Objectarg0)
void	finalize()
finalClass<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public voidaddSessionManagerListener(SessionManagerListener<Session> listener)

Adds aSessionManagerListener to monitor events from any type ofSession instance.

Throws

NullPointerException	If listener is`null`.
IllegalStateException	If this method is not called on the main thread.

public voidaddSessionManagerListener(SessionManagerListener<T> listener,Class<T> sessionClass)

Adds aSessionManagerListener to monitor events from aSession instance whose class issessionClass.

Throws

NullPointerException	If`listener`or`sessionClass`are `null`.
IllegalStateException	If this method is not called on the main thread.

public voidendCurrentSession(boolean stopCasting)

Ends the current session.

Parameters

stopCasting	Should the receiver application be stopped when ending the current Session.

Throws

IllegalStateException	If this method is not called on the main thread.

publicCastSession getCurrentCastSession()

Returns the current session if it is an instance ofCastSession, otherwise returnsnull.

Throws

IllegalStateException	If this method is not called on the main thread.

publicSession getCurrentSession()

Returns the currently active session. Returnsnullif no session is active.

Throws

IllegalStateException	If this method is not called on the main thread.

public voidremoveSessionManagerListener(SessionManagerListener<Session> listener)

Removes theSessionManagerListener.

Parameters

listener	The`SessionManagerListener`to be removed.

Throws

IllegalStateException	If this method is not called on the main thread.

public voidremoveSessionManagerListener(SessionManagerListener<T> listener,Class<T> sessionClass)

Removes theSessionManagerListener.

Parameters

listener	The`SessionManagerListener`to be removed.
sessionClass

Throws

NullPointerException	If`sessionClass`is`null`.
IllegalStateException	If this method is not called on the main thread.

public voidstartSession(Intent startSessionIntent)

Starts a session. The sender app should call this method after the app is launched by an implicit intent fired by a component outside the app, such as Google Home app. We recommended calling this method in onResume() instead of onCreate() because onCreate() is called only when the app launches. If the app is running when the intent is fired, it will be brought to the foreground and onCreate() will not be called.

public class MyActivity extends Activity {
...
@Override
protected void onResume() {
...
Intent intent = getIntent();
// You need define your own intent filter and figure out how to check if the intent is
// for joining a cast session.
if (intentIsForStartingSession(intent)) {
CastContext castContext = CastContext.getSharedInstance(this);
castContext.getSessionManager().startSession(intent);
}
...
}
}

Parameters

startSessionIntent	The intent that is used to start the app and ask it to join a cast session. The intent contains necessary information for starting a session, such as the route ID, device name, session ID, etc. This information is set by the component that fires the intent.