UIMediaController

public classUIMediaControllerextendsObject
implements RemoteMediaClient.Listener SessionManagerListener<CastSession>

AUIMediaControllerlets you bind the state of Android UI components to the state of a remoteCastSession. This class simplifies writing a sender UI with playback controls. To use this class, create an instance of this class, then call various bind methods to associate state of your Android UI components to a remote playback control, or the change of the remote playback state or metadata.

When aViewis bound to the UIMediaController,on the one hand,UIMediaControllerwill update its UI state according to theCastSession state, the remote playback state or metadata. On the other hand, if theViewis bound to a remote playback command (such as "SkipNext" button),UIMediaControllerwill also register relevant listeners to theViewso that when the user interacts with the control, the controller will perform the corresponding action.

TakebindViewToSkipNext(View, int)as an example. When aViewis bound to the UIMediaController,UIMediaControllerwill update the state of theViewbased on the status of theCastSession, such that it will only be enabled when theCastSession is connected and there is a next item in the queue. AView.OnClickListener will also be set on theViewsuch that when the Viewis clicked, the event will be forwarded toonSkipNextClicked(View),whose default behavior is to callRemoteMediaClient.queueNext(JSONObject)on theRemoteMediaClient:

protected void onSkipNextClicked(View view) {
RemoteMediaClient remoteMediaClient = getRemoteMediaClient();
if ((remoteMediaClient!= null) && remoteMediaClient.hasMediaSession()) {
remoteMediaClient.queueNext(null /* customData */);
}
}

If the app needs to perform custom behavior in addition to, or instead of, the default behavior for a given action, it can subclass UIMediaController and override the corresponding event-handling method. For example:

public class CustomUIMediaController extends UIMediaController {
// Omitting other methods.

@Override
protected void onSkipNextClicked(View view) {
doSomeCustomAction();
super.onSkipNextClicked(view); // Optional
}
}

Public Constructor Summary

UIMediaController(Activity activity)

Constructs an instance of


UIMediaController

that will be used to bind UI elements of an activity.

Public Method Summary

void	bindImageViewToImageOfCurrentItem(ImageView view, int imageType, int placeHolderDrawableResId) This method is deprecated. Use`bindImageViewToImageOfCurrentItem(ImageView, ImageHints, int)` instead
void	bindImageViewToImageOfCurrentItem(ImageView view, int imageType,View placeHolderView) This method is deprecated. Use`bindImageViewToImageOfCurrentItem(ImageView, ImageHints, View)` instead
void	bindImageViewToImageOfCurrentItem(ImageView view,ImageHints imageHints, int placeHolderDrawableResId) Binds an`ImageView` to the first image of the current item.
void	bindImageViewToImageOfCurrentItem(ImageView view,ImageHints imageHints,View placeHolderView) Binds an`ImageView` to an image of the current item.
void	bindImageViewToImageOfPreloadedItem(ImageView view, int imageType, int placeHolderDrawableResId) This method is deprecated. Use`bindImageViewToImageOfPreloadedItem(ImageView, ImageHints, int)` instead
void	bindImageViewToImageOfPreloadedItem(ImageView view,ImageHints imageHints, int placeHolderDrawableResId) Binds an`ImageView` to the first image of the preloaded item.
void	bindImageViewToMuteToggle(ImageView view) Binds an`ImageView` to mute and unmute the Cast receiver device volume.
void	bindImageViewToPlayPauseToggle(ImageView view,Drawable playDrawable,Drawable pauseDrawable,Drawable stopDrawable,View loadingIndicator, boolean hideViewWhenLoading) Binds an`ImageView` to toggle play / pause of the current item.
void	bindProgressBar(ProgressBar view) Binds a`ProgressBar` to the playback progress of the current item.
void	bindProgressBar(ProgressBar view, long progressUpdateStepMs) Binds a`ProgressBar` to the playback progress of the current item.
void	bindSeekBar(CastSeekBar view) Binds a`CastSeekBar`to control the playback position of the current item.
void	bindSeekBar(SeekBarview, long progressUpdateStepMs) Binds a`SeekBar` to control the playback position of the current item.
void	bindSeekBar(CastSeekBar view, long progressUpdateStepMs) Binds a`CastSeekBar`to control the playback position of the current item.
void	bindSeekBar(SeekBarview) Binds a`SeekBar` to control the playback position of the current item.
void	bindTextViewToMetadataOfCurrentItem(TextView view,Stringkey) Binds a`TextView` to the metadata of the current item, keyed by`key`.
void	bindTextViewToMetadataOfCurrentItem(TextView view,List<String> keysInPreference) Binds a`TextView` to the metadata of the current item, keyed by a list of keys in the order of preferences.
void	bindTextViewToMetadataOfPreloadedItem(TextView view,List<String> keysInPreference) Binds an`TextView` to the metadata of the preloaded item, keyed by a list of keys in the order of preferences.
void	bindTextViewToMetadataOfPreloadedItem(TextView view,Stringkey) Binds an`TextView` to the metadata of the preloaded item, keyed by`key`.
void	bindTextViewToSmartSubtitle(TextView textView) Binds a`TextView` to the most appropriate item in`MediaMetadata` for subtitle.
void	bindTextViewToStreamDuration(TextView view,View liveStreamIndicator) Binds a`TextView` to the playback duration of the current item.
void	bindTextViewToStreamDuration(TextView view) Binds a`TextView` to the playback duration of the current item.
void	bindTextViewToStreamPosition(TextView view, boolean updateWhileScrubbing) Binds a`TextView` to the playback position of the current item.
void	bindTextViewToStreamPosition(TextView view, boolean updateWhileScrubbing, long progressUpdateStepMs) Binds a`TextView` to the playback position of the current item.
void	bindViewToClosedCaption(Viewview) Binds a`View`to launching the`TracksChooserDialogFragment`when clicked.
void	bindViewToForward(Viewview, long skipStepMs) Binds a`View`to skip forward playback of the current item`skipStepMs`milliseconds.
void	bindViewToLaunchExpandedController(Viewview) Binds a`View`to launching the expanded controller`Activity` specified by the name in`CastMediaOptions.getExpandedControllerActivityClassName()`.
void	bindViewToLoadingIndicator(Viewview) Binds a`View`'s visibility state to`View.VISIBLE` only when the remote receiver is either buffering, or loading the next item.
void	bindViewToRewind(Viewview, long skipStepMs) Binds a`View`to rewind playback of the current item`skipStepMs`milliseconds.
void	bindViewToSkipNext(Viewview, int invisibleState) Binds a`View`to skip to the next item in the queue.
void	bindViewToSkipPrev(Viewview, int invisibleState) Binds a`View`to skip to the previous item in the queue.
void	bindViewToUIController(Viewview, UIControlleruiController) Binds a`View`to a `UIController`.
void	bindViewVisibilityToMediaSession(Viewview, int invisibleState) Binds a`View`'s visibility state to the availability of a Cast media session.
void	bindViewVisibilityToPreloadingEvent(Viewview, int invisibleState) Binds a`View`'s visibility state to the availability of a preloaded item.
void	dispose() Disposes this instance.
RemoteMediaClient	getRemoteMediaClient() Returns the managed`RemoteMediaClient`of the current active`CastSession`.
boolean	isActive() Returns true if there is an active connected Cast Session.
void	onAdBreakStatusUpdated() Called when updated ad break status information is received.
void	onMetadataUpdated() Called when updated media metadata is received.
void	onPreloadStatusUpdated() Called when updated player queue preload status information is received, for example, the next item to play has been preloaded.
void	onQueueStatusUpdated() Called when updated player queue status information is received.
void	onSendingRemoteMediaRequest() Called when there is an outgoing request to the receiver.
void	onSessionEnded(CastSession session, int error)
void	onSessionEnding(CastSession session)
void	onSessionResumeFailed(CastSession session, int error)
void	onSessionResumed(CastSession session, boolean wasSuspended)
void	onSessionResuming(CastSession session,StringsessionId)
void	onSessionStartFailed(CastSession session, int error)
void	onSessionStarted(CastSession session,StringsessionId)
void	onSessionStarting(CastSession session)
void	onSessionSuspended(CastSession session, int reason)
void	onStatusUpdated() Called when updated player status information is received.
void	setPostRemoteMediaClientListener(RemoteMediaClient.Listener listener) Sets a`RemoteMediaClient.Listener`that will be called after all the other registered listeners in the`UIMediaController`instance are invoked.

Protected Method Summary

void	onClosedCaptionClicked(Viewview) The callback that is invoked when the user clicks on an`View` bound to this`UIMediaController`through`bindViewToClosedCaption(View)`.
void	onForwardClicked(Viewview, long skipStepMs) The callback that is invoked when the user clicks on an`View` bound to this`UIMediaController`through`bindViewToForward(View, long)`.
void	onLaunchExpandedControllerClicked(Viewview) The callback that is invoked when the user clicks on an`View` bound to this`UIMediaController`through`bindViewToLaunchExpandedController(View)`.
void	onMuteToggleClicked(ImageView view) The callback that is invoked when the user clicks on an`ImageView` bound to this`UIMediaController`through`bindImageViewToMuteToggle(ImageView)`.
void	onPlayPauseToggleClicked(ImageView view) The callback that is invoked when the user clicks on an`ImageView` bound to this`UIMediaController`through`bindImageViewToPlayPauseToggle(ImageView, Drawable, Drawable, Drawable, View, boolean)`.
void	onRewindClicked(Viewview, long skipStepMs) The callback that is invoked when the user clicks on an`View` bound to this`UIMediaController`through`bindViewToRewind(View, long)`.
void	onSeekBarProgressChanged(SeekBar seekBar, int progress, boolean fromUser) The callback that is invoked on progress change of a`SeekBar` bound to this`UIMediaController`through`bindSeekBar(SeekBar)`.
void	onSeekBarStartTrackingTouch(SeekBar seekBar) The callback that is invoked when the user starts a touch gesture on a `SeekBar` bound to this`UIMediaController`through`bindSeekBar(SeekBar)`.
void	onSeekBarStopTrackingTouch(SeekBar seekBar) The callback that is invoked when the user finished a touch gesture on a `SeekBar` bound to this`UIMediaController`through`bindSeekBar(SeekBar)`.
void	onSkipNextClicked(Viewview) The callback that is invoked when the user clicks on an`View` bound to this`UIMediaController`through`bindViewToSkipNext(View, int)`.
void	onSkipPrevClicked(Viewview) The callback that is invoked when the user clicks on an`View` bound to this`UIMediaController`through`bindViewToSkipPrev(View, int)`.

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()

From interface com.google.android.gms.cast.framework.media.RemoteMediaClient.Listener

abstract void	onAdBreakStatusUpdated() Called when updated ad break status information is received.
abstract void	onMetadataUpdated() Called when updated media metadata is received.
abstract void	onPreloadStatusUpdated() Called when updated player queue preload status information is received, for example, the next item to play has been preloaded.
abstract void	onQueueStatusUpdated() Called when updated player queue status information is received.
abstract void	onSendingRemoteMediaRequest() Called when there is an outgoing request to the receiver.
abstract void	onStatusUpdated() Called when updated player status information is received.

From interfacecom.google.android.gms.cast.framework.SessionManagerListener

abstract void	onSessionEnded(CastSession session, int error) Called when a`session`has ended.
abstract void	onSessionEnding(CastSession session) Called when a`session`is ending.
abstract void	onSessionResumeFailed(CastSession session, int error) Called when a previous saved`session`failed to resume.
abstract void	onSessionResumed(CastSession session, boolean wasSuspended) Called when`session`has been successfully resumed.
abstract void	onSessionResuming(CastSession session,String sessionId) Called when a`session`is attempting to resume.
abstract void	onSessionStartFailed(CastSession session, int error) Called when a`session`failed to start.
abstract void	onSessionStarted(CastSession session,String sessionId) Called when a`session`has been successfully started.
abstract void	onSessionStarting(CastSession session) Called when a`session`is attempting to start.
abstract void	onSessionSuspended(CastSession session, int reason) Called when a`session`has been suspended.

Public Constructors

publicUIMediaController(Activity activity)

Constructs an instance ofUIMediaControllerthat will be used to bind UI elements of an activity.

Public Methods

public voidbindImageViewToImageOfCurrentItem(ImageViewview, int imageType, int placeHolderDrawableResId)

This method is deprecated.
UsebindImageViewToImageOfCurrentItem(ImageView, ImageHints, int)instead

Binds anImageView to the first image of the current item. If the current item doesn't contain any image or the framework fails to fetch the Bitmap for the image,imagePlaceHolder will be used instead.

Parameters

view	the`View`to bind
imageType	the type of image, used by the`ImagePicker` to choose the proper image
placeHolderDrawableResId	the resource ID of a`Drawable` used as a placeholder if no image is available from the current item

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindImageViewToImageOfCurrentItem(ImageViewview, int imageType,View placeHolderView)

This method is deprecated.
UsebindImageViewToImageOfCurrentItem(ImageView, ImageHints, View)instead

Binds anImageView to an image of the current item. When an item is loaded, and there is aWebImage that is suitable to be displayed, theBitmapof that image will be fetched and set on theImageView. If the item contains multiple images, this class will choose one using the ImagePicker configured inCastMediaOptions, with the givenimageType.

Parameters

view	the`ImageView`
imageType	type of image, used by the`ImagePicker` to choose the proper image
placeHolderView	the`View`to show as a placeholder if no image is available from the current item

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindImageViewToImageOfCurrentItem(ImageViewview, ImageHints imageHints, int placeHolderDrawableResId)

Parameters

view	the`View`to bind
imageHints	`ImageHints` used by the`ImagePicker` to choose the proper image
placeHolderDrawableResId	the resource ID of a`Drawable` used as a placeholder if no image is available from the current item

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindImageViewToImageOfCurrentItem(ImageViewview, ImageHints imageHints,View placeHolderView)

Parameters

view	the`ImageView`
imageHints	`ImageHints` used by the`ImagePicker` to choose the proper image
placeHolderView	the`View`to show as a placeholder if no image is available from the current item

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindImageViewToImageOfPreloadedItem(ImageViewview, int imageType, int placeHolderDrawableResId)

This method is deprecated.
UsebindImageViewToImageOfPreloadedItem(ImageView, ImageHints, int)instead

Binds anImageView to the first image of the preloaded item. If the current item doesn't contain any image or the framework fails to fetch the Bitmap for the image,imagePlaceHolder will be used instead.

Parameters

view	the`View`to bind
imageType	type of image, used by the`ImagePicker` to choose the proper image
placeHolderDrawableResId	the resource ID of a`Drawable` used as a placeholder if no image is available from the preloaded item

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindImageViewToImageOfPreloadedItem(ImageViewview, ImageHints imageHints, int placeHolderDrawableResId)

Parameters

view	the`View`to bind
imageHints	`ImageHints` used by the`ImagePicker` to choose the proper image
placeHolderDrawableResId	the resource ID of a`Drawable` used as a placeholder if no image is available from the preloaded item

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindImageViewToMuteToggle(ImageView view)

Binds anImageView to mute and unmute the Cast receiver device volume.

TheImageView will be updated based on theCastSession connection state and muted state. AView.OnClickListener will also be set to theImageView so that when it is clicked, the listener will callonMuteToggleClicked(ImageView)to handle the click event. Do not call View.setOnClickListener(View.OnClickListener)on theImageView. To override the behavior, create a subclass ofUIMediaControllerand override theonMuteToggleClicked(ImageView)method.

Parameters

view	the`ImageView` to bind

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindImageViewToPlayPauseToggle(ImageViewview, Drawable playDrawable,Drawable pauseDrawable,Drawable stopDrawable,View loadingIndicator, boolean hideViewWhenLoading)

Binds anImageView to toggle play / pause of the current item.

TheImageView will be updated based on theCastSession state and remote playback state. AView.OnClickListener will also be set to theImageView so that when it is clicked, the listener will callonPlayPauseToggleClicked(ImageView)to handle the click event. Do not call View.setOnClickListener(View.OnClickListener)on theImageView. To override the behavior, create a subclass ofUIMediaControllerand override theonPlayPauseToggleClicked(ImageView)method.

Parameters

view	the`ImageView` to bind
playDrawable	the`Drawable` to use when the state of the control is "play"
pauseDrawable	the`Drawable` to use when the state of the control is "pause"
stopDrawable	the`Drawable` to use when the state of the control is "stop live stream"; if set to `null`,the framework will display the`pauseDrawable`when a "stop live stream" icon is needed
loadingIndicator	a`View`that should be displayed to indicate that a remote request is ongoing
hideViewWhenLoading	`true`if visibility of`imageView`should be set to `View.INVISIBLE` when loading an item,`false`if it should be set to`View.VISIBLE` when loading an item

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindProgressBar(ProgressBar view)

Binds aProgressBar to the playback progress of the current item. Progress will be updated once per second. If no item is loaded the progress of theProgressBar will be set to zero.

Parameters

view	the`ProgressBar` to bind

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindProgressBar(ProgressBarview, long progressUpdateStepMs)

Binds aProgressBar to the playback progress of the current item. Progress will be updated once per progressUpdateStepMsmilliseconds. If no item is loaded the progress of theProgressBar will be set to zero.

Parameters

view	the`ProgressBar` to bind
progressUpdateStepMs	the interval between each update of the progress, in milliseconds

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindSeekBar(CastSeekBar view)

Binds aCastSeekBarto control the playback position of the current item.

TheCastSeekBarwill be updated based on theCastSession state and remote playback progress. Progress will be updated once per second. If no item is loaded, the progress of theCastSeekBarwill be set to zero and theCastSeekBarwill be disabled.

TheCastSeekBarwill be able to handle live content. When playing live streams, the seek bar will draw the seekable range properly, and seek is only allowed within the seekable range.

Parameters

view	the`CastSeekBar`to bind

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindSeekBar(SeekBarview, long progressUpdateStepMs)

Binds aSeekBarto control the playback position of the current item.

TheSeekBarwill be updated based on theCastSession state and remote playback progress. Progress will be updated once per progressUpdateStepMsmilliseconds. If no item is loaded, the progress of theSeekBarwill be set to zero and theSeekBarwill be disabled. ASeekBar.OnSeekBarChangeListenerwill also be set to theSeekBarso that when the user interacts with theSeekBar,it will forward the listener events to thisUIMediaControllerto handle the event.SeekBar.OnSeekBarChangeListener.onStopTrackingTouch(SeekBar)will be forwarded toonSeekBarStopTrackingTouch(SeekBar).SeekBar.OnSeekBarChangeListener.onStartTrackingTouch(SeekBar)will be forwarded toonSeekBarStartTrackingTouch(SeekBar).SeekBar.OnSeekBarChangeListener.onProgressChanged(SeekBar, int, boolean) will be forwarded toonSeekBarProgressChanged(SeekBar, int, boolean).Do not callSeekBar.setOnSeekBarChangeListener(SeekBar.OnSeekBarChangeListener)on the SeekBar.To override the behavior, create a subclass ofUIMediaControllerand override theonSeekBarProgressChanged(SeekBar, int, boolean),onSeekBarStartTrackingTouch(SeekBar)andonSeekBarStopTrackingTouch(SeekBar)methods.

TheSeekBar's behavior will be undefined for live content. It should not be used in this case.

If the client wants to set the thumb on theSeekBarvia AbsSeekBar.setThumb(Drawable),it need to call the method before binding the SeekBar. After binding, the method should not be called.

Parameters

view	the`SeekBar` to bind
progressUpdateStepMs	the interval between each update of the progress, in milliseconds

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindSeekBar(CastSeekBar view, long progressUpdateStepMs)

Binds aCastSeekBarto control the playback position of the current item.

TheCastSeekBarwill be able to handle live content. The ad breaks and seekable range will be drawn properly, and seek is only allowed in the seekable range.

Parameters

view	the`CastSeekBar`to bind
progressUpdateStepMs	the interval between each update of the progress, in milliseconds

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindSeekBar(SeekBar view)

Binds aSeekBarto control the playback position of the current item.

TheSeekBarwill be updated based on theCastSession state and remote playback progress. Progress will be updated once per second. If no item is loaded, the progress of theSeekBarwill be set to zero and theSeekBarwill be disabled. ASeekBar.OnSeekBarChangeListenerwill also be set to theSeekBarso that when the user interacts with theSeekBar,it will forward the listener events to thisUIMediaControllerto handle the event.SeekBar.OnSeekBarChangeListener.onStopTrackingTouch(SeekBar)will be forwarded toonSeekBarStopTrackingTouch(SeekBar).SeekBar.OnSeekBarChangeListener.onStartTrackingTouch(SeekBar)will be forwarded toonSeekBarStartTrackingTouch(SeekBar).SeekBar.OnSeekBarChangeListener.onProgressChanged(SeekBar, int, boolean) will be forwarded toonSeekBarProgressChanged(SeekBar, int, boolean).Do not callSeekBar.setOnSeekBarChangeListener(SeekBar.OnSeekBarChangeListener)on the SeekBar.To override the behavior, create a subclass ofUIMediaControllerand override theonSeekBarProgressChanged(SeekBar, int, boolean),onSeekBarStartTrackingTouch(SeekBar)andonSeekBarStopTrackingTouch(SeekBar)methods.

TheSeekBar's behavior will be undefined for live content. It should not be used in this case.

If the client wants to set the thumb on theSeekBarvia AbsSeekBar.setThumb(Drawable),it need to call the method before binding the SeekBar. After binding, the method should not be called.

Parameters

view	the`SeekBar` to bind

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindTextViewToMetadataOfCurrentItem(TextViewview, String key)

Binds aTextViewto the metadata of the current item, keyed bykey.If metadata for keyis unavailable, the TextView will be left untouched.

Parameters

view	the`View`to bind
key	the key of the metadata field to bind

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindTextViewToMetadataOfCurrentItem(TextViewview, List<String> keysInPreference)

Binds aTextViewto the metadata of the current item, keyed by a list of keys in the order of preferences.

Parameters

view	the`View`to bind
keysInPreference	the list of keys in the order of preference

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindTextViewToMetadataOfPreloadedItem(TextViewview, List<String> keysInPreference)

Binds anTextViewto the metadata of the preloaded item, keyed by a list of keys in the order of preferences.

Parameters

view	the`View`to bind
keysInPreference	the list of keys in the order of preference

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindTextViewToMetadataOfPreloadedItem(TextViewview, String key)

Binds anTextViewto the metadata of the preloaded item, keyed bykey.If metadata for keyis unavailable, the TextView will be left untouched.

Parameters

view	the`View`to bind
key	the key of the metadata field to bind

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindTextViewToSmartSubtitle(TextView textView)

Binds aTextViewto the most appropriate item inMediaMetadata for subtitle. For example the studio name for a movie or the artist name for a music track.

public voidbindTextViewToStreamDuration(TextView view,View liveStreamIndicator)

Binds aTextViewto the playback duration of the current item. If no item is loaded, or if the currently playing item is a live stream, then the text will be set to "--:--".

When playing a live stream item, ifliveStreamIndicatoris not null,thenviewwill be hidden and liveStreamIndicatorwill be shown to better indicate that a live stream is playing.

Parameters

view	the`TextView` to bind
liveStreamIndicator	if`View`to indicate that a live stream items is playing

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindTextViewToStreamDuration(TextView view)

Binds aTextViewto the playback duration of the current item. If no item is loaded, or if the currently playing item is a live stream, then the text will be set to "--:--".

Parameters

view	the`TextView` to bind

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindTextViewToStreamPosition(TextView view, boolean updateWhileScrubbing)

Binds aTextViewto the playback position of the current item. Position will be updated once per second. If no item is loaded the text will be set to "--:--".

Parameters

view	the`TextView` to bind
updateWhileScrubbing	if this is set to`true`,the`View`will be put in the update-when-scrubbing set and will be updated to the position of a bound `SeekBar` or`CastSeekBar`while it is being scrubbed

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindTextViewToStreamPosition(TextView view, boolean updateWhileScrubbing, long progressUpdateStepMs)

Binds aTextViewto the playback position of the current item. Position will be updated once per progressUpdateStepMsmilliseconds. If no item is loaded the text will be set to "--:--".

Parameters

view	the`TextView` to bind
updateWhileScrubbing	if this is set to`true`,the`View`will be put in the update-when-scrubbing set and will be updated to the position of a bound `SeekBar` or`CastSeekBar`while it is being scrubbed
progressUpdateStepMs	the interval between each update of the progress, in milliseconds

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindViewToClosedCaption(Viewview)

Binds aViewto launching theTracksChooserDialogFragmentwhen clicked.

The view will be updated based on theCastSession state and the availability of audio and text tracks. AView.OnClickListener will also be set to the view so that when the view is clicked, it will call onClosedCaptionClicked(View)to handle the click event. Do not call View.setOnClickListener(View.OnClickListener)on the view. To override the behavior, create a subclass ofUIMediaControllerand override theonClosedCaptionClicked(View)method.

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindViewToForward(Viewview, long skipStepMs)

Binds aViewto skip forward playback of the current itemskipStepMsmilliseconds.

TheViewwill be updated based on theCastSession state, the remote playback progress and whether it is livestream. AView.OnClickListener will also be set to theViewso that when it is clicked, the listener will callonForwardClicked(View, long)to handle the click event. Do not call View.setOnClickListener(View.OnClickListener)on theView.To override the behavior, create a subclass ofUIMediaControllerand override theonForwardClicked(View, long)method.

Parameters

view	the`View`to bind
skipStepMs	the time (in milliseconds) to skip forward

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindViewToLaunchExpandedController(View view)

Binds aViewto launching the expanded controllerActivity specified by the name inCastMediaOptions.getExpandedControllerActivityClassName().If the specified class name isnull,then clicking the button is a no-op.

TheViewwill be updated based on theCastSession state. AView.OnClickListener will also be set to theViewso that when it is clicked, the listener will callonLaunchExpandedControllerClicked(View)to handle the click event. Do not callView.setOnClickListener(View.OnClickListener)on theView.To override the behavior, create a subclass ofUIMediaControllerand override theonLaunchExpandedControllerClicked(View)method.

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindViewToLoadingIndicator(Viewview)

Binds aView's visibility state toView.VISIBLE only when the remote receiver is either buffering, or loading the next item. Otherwise visibility of theViewwill be set toView.GONE.

Parameters

view	the`View`to bind

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindViewToRewind(Viewview, long skipStepMs)

Binds aViewto rewind playback of the current itemskipStepMsmilliseconds.

TheViewwill be updated based on theCastSession state, the remote playback state and whether it is livestream. AView.OnClickListener will also be set to theViewso that when it is clicked, the listener will callonRewindClicked(View, long)to handle the click event. Do not call View.setOnClickListener(View.OnClickListener)on theView.To override the behavior, create a subclass ofUIMediaControllerand override theonRewindClicked(View, long)method.

Parameters

view	the`View`to bind
skipStepMs	the time (in milliseconds) to rewind

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindViewToSkipNext(Viewview, int invisibleState)

Binds aViewto skip to the next item in the queue.

TheViewwill be updated based on theCastSession state, the remote playback state and the availability of the next queue item. A View.OnClickListener will also be set to theViewso that when it is clicked, the listener will callonSkipNextClicked(View)to handle the click event. Do not call View.setOnClickListener(View.OnClickListener)on theView.To override the behavior, create a subclass ofUIMediaControllerand override theonSkipNextClicked(View)method.

Parameters

view	the`View`to bind
invisibleState	either`View.INVISIBLE` or`View.GONE`; this parameter will be set as the visibility of`View`when there isn't a previous item in the queue

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindViewToSkipPrev(Viewview, int invisibleState)

Binds aViewto skip to the previous item in the queue.

TheViewwill be updated based on theCastSession state, the remote playabck state and the availability of the previous queue item. A View.OnClickListener will also be set to theViewso that when it is clicked, the listener will callonSkipPrevClicked(View)to handle the click event. Do not call View.setOnClickListener(View.OnClickListener)on theView.To override the behavior, create a subclass ofUIMediaControllerand override theonSkipPrevClicked(View)method.

Parameters

view	the`View`to bind
invisibleState	either`View.INVISIBLE` or`View.GONE`; this parameter will be set as the visibility of`View`when there isn't a previous item in the queue

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindViewToUIController(Viewview, UIControlleruiController)

Binds aViewto a UIController.This method is typically used when the uiControlleris used to implement a custom control button.

Parameters

view	the`View`to bind
uiController	the`UIController`of the`view`

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindViewVisibilityToMediaSession(Viewview, int invisibleState)

Binds aView's visibility state to the availability of a Cast media session.Viewwill be set to View.VISIBLE when there is a media session, and will be set toinvisibleStatewhen there isn't a media session.

Parameters

view	the`View`to bind
invisibleState	either`View.INVISIBLE` or`View.GONE`, which will be set as the visibility of`view`when there isn't a media session

Throws

IllegalStateException	if this method is not called on the main thread

public voidbindViewVisibilityToPreloadingEvent(Viewview, int invisibleState)

Binds aView's visibility state to the availability of a preloaded item.Viewwill be set to View.VISIBLE when there is a preloaded item, and will be set toinvisibleStatewhen there isn't a preloaded item.

Parameters

view	the`View`to bind
invisibleState	either`View.INVISIBLE` or`View.GONE`, which will be set as the visibility of`view`when there isn't a preloaded item

Throws

IllegalStateException	if this method is not called on the main thread

public voiddispose()

Disposes this instance. TheUIMediaControllercan not be reused after this method is called.

Throws

IllegalStateException	if this method is not called on the main thread

publicRemoteMediaClient getRemoteMediaClient()

Returns the managedRemoteMediaClientof the current activeCastSession.

Throws

IllegalStateException	if this method is not called on the main thread

public booleanisActive()

Returns true if there is an active connected Cast Session.

Throws

IllegalStateException	if this method is not called on the main thread

public voidonAdBreakStatusUpdated()

Called when updated ad break status information is received.

public voidonMetadataUpdated()

Called when updated media metadata is received.

public voidonPreloadStatusUpdated()

Called when updated player queue preload status information is received, for example, the next item to play has been preloaded. This gives the caller a chance to respond to preloading related event, such as displaying what will be played next in the UI.

public voidonQueueStatusUpdated()

Called when updated player queue status information is received.

public voidonSendingRemoteMediaRequest()

Called when there is an outgoing request to the receiver. This gives the caller a chance to update state of the UI of the sender app, for example, disable some controls.

public voidonSessionEnded(CastSession session, int error)

public voidonSessionEnding(CastSession session)

public voidonSessionResumeFailed(CastSession session, int error)

public voidonSessionResumed(CastSession session, boolean wasSuspended)

public voidonSessionResuming(CastSession session,String sessionId)

public voidonSessionStartFailed(CastSession session, int error)

public voidonSessionStarted(CastSession session,String sessionId)

public voidonSessionStarting(CastSession session)

public voidonSessionSuspended(CastSession session, int reason)

public voidonStatusUpdated()

Called when updated player status information is received.

public voidsetPostRemoteMediaClientListener(RemoteMediaClient.Listener listener)

Sets aRemoteMediaClient.Listenerthat will be called after all the other registered listeners in theUIMediaControllerinstance are invoked. Also, the states of all the bound Viewinstances are guaranteed to be updated before this listener is invoked.

This listener is useful if you want to modify the state of the boundView instances.

Throws

IllegalStateException	if this method is not called on the main thread

Protected Methods

protected voidonClosedCaptionClicked(Viewview)

The callback that is invoked when the user clicks on anViewbound to thisUIMediaControllerthroughbindViewToClosedCaption(View).

The default behavior is to launch theTracksChooserDialogFragmentif theActivityused to construct thisUIMediaControlleris aFragmentActivity and the remote media is loaded.

Parameters

view	the`View`that the user clicked

protected voidonForwardClicked(Viewview, long skipStepMs)

The callback that is invoked when the user clicks on anViewbound to thisUIMediaControllerthroughbindViewToForward(View, long).

The default behavior is to call theRemoteMediaClient.seek(MediaSeekOptions)method ofgetRemoteMediaClient()if the remote media is loaded, with the position of getRemoteMediaClient().getApproximateStreamPosition() + skipStepMs.

Parameters

view	the`View`that the user clicked
skipStepMs	the amount of time, in milliseconds, that the playback position will move forward by when the`View`is clicked

protected voidonLaunchExpandedControllerClicked(View view)

The callback that is invoked when the user clicks on anViewbound to thisUIMediaControllerthroughbindViewToLaunchExpandedController(View).

The default behavior is to launch the expanded controllerActivity specified by the name inCastMediaOptions.getExpandedControllerActivityClassName()ofCastMediaOptions.

Parameters

view	the`View`that the user clicked

protected voidonMuteToggleClicked(ImageView view)

The callback that is invoked when the user clicks on anImageView bound to thisUIMediaControllerthroughbindImageViewToMuteToggle(ImageView).

The default behavior is to toggle the muted state of theCastSession if there is one and it is connected.

Parameters

view	the`ImageView` that the user clicked

protected voidonPlayPauseToggleClicked(ImageView view)

The callback that is invoked when the user clicks on anImageView bound to thisUIMediaControllerthroughbindImageViewToPlayPauseToggle(ImageView, Drawable, Drawable, Drawable, View, boolean).

The default behavior is to call theRemoteMediaClient.togglePlayback()method ofgetRemoteMediaClient()if the remote media is loaded.

Parameters

view	the`ImageView` that the user clicked

protected voidonRewindClicked(Viewview, long skipStepMs)

The callback that is invoked when the user clicks on anViewbound to thisUIMediaControllerthroughbindViewToRewind(View, long).

Parameters

view	the`View`that the user clicked
skipStepMs	the amount of time, in milliseconds, that the playback position will move backward by when the`View`is clicked

protected voidonSeekBarProgressChanged(SeekBarseekBar, int progress, boolean fromUser)

The callback that is invoked on progress change of aSeekBar bound to thisUIMediaControllerthroughbindSeekBar(SeekBar).

The default behavior is: if the progress change comes from a user action, use progressto update the progress of all views in the update-when-scrubbing set.

Parameters

seekBar	the`SeekBar` that the user is scrubbing
progress	the current progress level
fromUser	`true`if the progress change was initiated by the user

protected voidonSeekBarStartTrackingTouch(SeekBar seekBar)

The callback that is invoked when the user starts a touch gesture on a SeekBar bound to thisUIMediaControllerthroughbindSeekBar(SeekBar).

The default behavior is to detach theseekBarand all the views in the update-when-scrubbing set from theCastSession to stop receiving furthur playback progress updates.

Parameters

seekBar	the`SeekBar` that the user is scrubbing

protected voidonSeekBarStopTrackingTouch(SeekBar seekBar)

The callback that is invoked when the user finished a touch gesture on a SeekBar bound to thisUIMediaControllerthroughbindSeekBar(SeekBar).

The default behavior is to reattach theseekBarand all the views in the update-when-scrubbing set to theCastSession to receive furthur playback progress updates. Then the method will callRemoteMediaClient.seek(MediaSeekOptions)method ofgetRemoteMediaClient()if the remote media is loaded.

Parameters

seekBar	the`SeekBar` that the user is scrubbing

protected voidonSkipNextClicked(Viewview)

The callback that is invoked when the user clicks on anViewbound to thisUIMediaControllerthroughbindViewToSkipNext(View, int).

The default behavior is to call theRemoteMediaClient.queueNext(JSONObject)method ofgetRemoteMediaClient()if the remote media is loaded, with customDataofnull.

Parameters

view	the`View`that the user clicked

protected voidonSkipPrevClicked(Viewview)

The callback that is invoked when the user clicks on anViewbound to thisUIMediaControllerthroughbindViewToSkipPrev(View, int).

The default behavior is to call theRemoteMediaClient.queuePrev(JSONObject)method ofgetRemoteMediaClient()if the remote media is loaded, with customDataofnull.

Parameters

view	the`View`that the user clicked