MiniControllerFragment

AI-generated Key Takeaways

MiniControllerFragment is an Android fragment for remote media casting control with album art, a progress bar, and three customizable buttons.
Control buttons are configured using an array of button ID resources with support for various predefined actions and custom buttons.
Custom buttons require obtaining the ImageView, implementing a UIController subclass, and binding the view to the controller.
The album art can be hidden, which also removes the first control button.
The fragment's visibility is automatically managed based on the media session state.

public class MiniControllerFragment extends Fragment
implements ControlButtonsContainer

A fragment that provides remote control functionality. This fragment provides an image for the album art, a ProgressBar for playback progression, and three configurable control buttons. If developers want to use this fragment, they should add it to their layout XML file, and the CastContext will automatically manage its state, and handle any user interactions.

 <fragment
     android:id="@+id/cast_mini_controller"
     android:layout_width="fill_parent"
     android:layout_height="wrap_content"
     android:layout_alignParentBottom="true"
     android:visibility="gone"
     class="com.google.android.gms.cast.framework.media.widget.MiniControllerFragment">

Configurable control buttons

The fragment can show up to three control buttons, from start to end. By default the fragment shows a play/pause toggle button. Developers can use the attribute castControlButtons to override what buttons to show. The list of supported control buttons are defined as ID resources:

@id/cast_button_type_empty: Not placing a button in this slot.
@id/cast_button_type_custom: A custom button.
@id/cast_button_type_play_pause_toggle: A button that toggles playback.
@id/cast_button_type_skip_previous: A button that skips to the previous item in the queue.
@id/cast_button_type_skip_next: A button that skips to the next item in the queue.
@id/cast_button_type_rewind_30_seconds: A button that rewinds the playback by 30 seconds.
@id/cast_button_type_forward_30_seconds: A button that skips forward the playback by 30 seconds.
@id/cast_button_type_mute_toggle: A button that mutes and unmutes the remote receiver.
@id/cast_button_type_closed_caption: A button that opens a dialog to select text and audio tracks.

Here is an example of showing a rewind button, a play/pause toggle button and a forward button, from start to end:

 <array name="cast_mini_controller_control_buttons">
     <item>@id/cast_button_type_rewind_30_seconds</item>
     <item>@id/cast_button_type_play_pause_toggle</item>
     <item>@id/cast_button_type_forward_30_seconds</item>
 </array>
 ...
 <fragment
     android:id="@+id/cast_mini_controller"
     ...
     app:castControlButtons="@array/cast_mini_controller_control_buttons"
     class="com.google.android.gms.cast.framework.media.widget.MiniControllerFragment">

The array must contain exactly three items, otherwise a runtime exception will be thrown. If you don't want to show a button in a slot, use @id/cast_button_type_empty.

Add custom control buttons

This fragment supports adding custom control buttons which are not provided by the SDK, such as a "thumb up" button.

1. Specify a slot to contain a custom button using @id/cast_button_type_custom in the castControlButtons attribute. You can then use getButtonImageViewAt(int) to obtain the ImageView for that custom button.

2. Implement a subclass of UIController. The UIController contains methods that are called by the SDK when the state of the cast session or media session changes. Your subclass of UIController should take a ImageView as one of the parameters, and update its state as needed.

3. Override onCreateView(LayoutInflater, ViewGroup, Bundle), call getButtonImageViewAt(int) to get the view object of the button, and then call UIMediaController.bindViewToUIController(View, UIController) to associate the view with your custom UIController.

4. See MediaIntentReceiver for how to handle the action from your custom button.

Here is an example of associating a button at slot 2 to a UIController called MyCustomUIController:

 // arrays.xml
 <array name="cast_mini_controller_control_buttons">
     <item>@id/cast_button_type_empty</item>
     <item>@id/cast_button_type_rewind_30_seconds</item>
     <item>@id/cast_button_type_custom</item>
     <item>@id/cast_button_type_empty</item>
 </array>

 // MyCustomUIController.java
 class MyCustomUIController extends UIController {
     private final View mView;

     public MyCustomUIController(View view) {
         mView = view;
     }

     @Override
     public onMediaStatusUpdated() {
         // Update the state of mView based on the latest the media status.
         ...
         mView.setVisible(false);
         ...
     }
 }

 // MyMiniControllerFragment.java
 class MyMiniControllerFragment extends MiniControllerFragment {
     @Override
     public View onCreateView(LayoutInflater inflater, ViewGroup container,
             Bundle savedInstanceState) {
         super.onCreateView(inflater, container, savedInstanceState);
         ImageView customButtonView = getButtonImageViewAt(2);
         MyCustomUIController myCustomUiController = new MyCustomUIController(customButtonView);
         getUIMediaController().bindViewToUIController(customButtonView, myCustomUiController);
         ...
     }
 }

Show or hide album art

The album art can be hidden by setting attribute castShowImageThumbnail to false:

 ...
 app:castShowImageThumbnail="false"
 ...

If the album art is shown, then the first control button will not be displayed.

The fragment will be visible when a media session starts, and will be invisible when a media session ends.

XML Attribute Summary

Inherited Field Summary

From class androidx.fragment.app.Fragment

public String mPreviousWho

Public Constructor Summary

MiniControllerFragment()

Public Method Summary

final ImageView	getButtonImageViewAt(int slotIndex) Returns the `ImageView` of the button at `slotIndex` in this container.
final int	getButtonSlotCount() Returns the number of slots to hold control buttons in this container.
final int	getButtonTypeAt(int slotIndex) Returns the type of the button at `slotIndex` in this container.
UIMediaController	getUIMediaController() Returns the `UIMediaController` used to bind views in this container.
View	onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
void	onDestroy()
void	onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState)

Inherited Method Summary

From class androidx.fragment.app.Fragment

void	dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3)
final boolean	equals(Object arg0)
final FragmentActivity	getActivity()
boolean	getAllowEnterTransitionOverlap()
boolean	getAllowReturnTransitionOverlap()
final Bundle	getArguments()
final FragmentManager	getChildFragmentManager()
Context	getContext()
CreationExtras	getDefaultViewModelCreationExtras()
ViewModelProvider.Factory	getDefaultViewModelProviderFactory()
Object	getEnterTransition()
Object	getExitTransition()
final FragmentManager	getFragmentManager()
final Object	getHost()
final int	getId()
LayoutInflater	getLayoutInflater(Bundle arg0)
final LayoutInflater	getLayoutInflater()
Lifecycle	getLifecycle()
LoaderManager	getLoaderManager()
final Fragment	getParentFragment()
final FragmentManager	getParentFragmentManager()
Object	getReenterTransition()
final Resources	getResources()
final boolean	getRetainInstance()
Object	getReturnTransition()
final SavedStateRegistry	getSavedStateRegistry()
Object	getSharedElementEnterTransition()
Object	getSharedElementReturnTransition()
final String	getString(int arg0, Object... arg1)
final String	getString(int arg0)
final String	getTag()
final Fragment	getTargetFragment()
final int	getTargetRequestCode()
final CharSequence	getText(int arg0)
boolean	getUserVisibleHint()
View	getView()
LifecycleOwner	getViewLifecycleOwner()
LiveData<LifecycleOwner>	getViewLifecycleOwnerLiveData()
ViewModelStore	getViewModelStore()
final boolean	hasOptionsMenu()
final int	hashCode()
static Fragment	instantiate(Context arg0, String arg1)
static Fragment	instantiate(Context arg0, String arg1, Bundle arg2)
final boolean	isAdded()
final boolean	isDetached()
final boolean	isHidden()
final boolean	isInLayout()
final boolean	isMenuVisible()
final boolean	isRemoving()
final boolean	isResumed()
final boolean	isStateSaved()
final boolean	isVisible()
void	onActivityCreated(Bundle arg0)
void	onActivityResult(int arg0, int arg1, Intent arg2)
void	onAttach(Activity arg0)
void	onAttach(Context arg0)
void	onAttachFragment(Fragment arg0)
void	onConfigurationChanged(Configuration arg0)
boolean	onContextItemSelected(MenuItem arg0)
void	onCreate(Bundle arg0)
Animation	onCreateAnimation(int arg0, boolean arg1, int arg2)
Animator	onCreateAnimator(int arg0, boolean arg1, int arg2)
void	onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)
void	onCreateOptionsMenu(Menu arg0, MenuInflater arg1)
View	onCreateView(LayoutInflater arg0, ViewGroup arg1, Bundle arg2)
void	onDestroy()
void	onDestroyOptionsMenu()
void	onDestroyView()
void	onDetach()
LayoutInflater	onGetLayoutInflater(Bundle arg0)
void	onHiddenChanged(boolean arg0)
void	onInflate(Activity arg0, AttributeSet arg1, Bundle arg2)
void	onInflate(Context arg0, AttributeSet arg1, Bundle arg2)
void	onLowMemory()
void	onMultiWindowModeChanged(boolean arg0)
boolean	onOptionsItemSelected(MenuItem arg0)
void	onOptionsMenuClosed(Menu arg0)
void	onPause()
void	onPictureInPictureModeChanged(boolean arg0)
void	onPrepareOptionsMenu(Menu arg0)
void	onPrimaryNavigationFragmentChanged(boolean arg0)
void	onRequestPermissionsResult(int arg0, String[] arg1, int[] arg2)
void	onResume()
void	onSaveInstanceState(Bundle arg0)
void	onStart()
void	onStop()
void	onViewCreated(View arg0, Bundle arg1)
void	onViewStateRestored(Bundle arg0)
void	postponeEnterTransition()
final void	postponeEnterTransition(long arg0, TimeUnit arg1)
final <I, O> ActivityResultLauncher<I>	registerForActivityResult(ActivityResultContract<I, O> arg0, ActivityResultCallback<O> arg1)
final <I, O> ActivityResultLauncher<I>	registerForActivityResult(ActivityResultContract<I, O> arg0, ActivityResultRegistry arg1, ActivityResultCallback<O> arg2)
void	registerForContextMenu(View arg0)
final void	requestPermissions(String[] arg0, int arg1)
final FragmentActivity	requireActivity()
final Bundle	requireArguments()
final Context	requireContext()
final FragmentManager	requireFragmentManager()
final Object	requireHost()
final Fragment	requireParentFragment()
final View	requireView()
void	setAllowEnterTransitionOverlap(boolean arg0)
void	setAllowReturnTransitionOverlap(boolean arg0)
void	setArguments(Bundle arg0)
void	setEnterSharedElementCallback(SharedElementCallback arg0)
void	setEnterTransition(Object arg0)
void	setExitSharedElementCallback(SharedElementCallback arg0)
void	setExitTransition(Object arg0)
void	setHasOptionsMenu(boolean arg0)
void	setInitialSavedState(SavedState arg0)
void	setMenuVisibility(boolean arg0)
void	setReenterTransition(Object arg0)
void	setRetainInstance(boolean arg0)
void	setReturnTransition(Object arg0)
void	setSharedElementEnterTransition(Object arg0)
void	setSharedElementReturnTransition(Object arg0)
void	setTargetFragment(Fragment arg0, int arg1)
void	setUserVisibleHint(boolean arg0)
boolean	shouldShowRequestPermissionRationale(String arg0)
void	startActivity(Intent arg0)
void	startActivity(Intent arg0, Bundle arg1)
void	startActivityForResult(Intent arg0, int arg1)
void	startActivityForResult(Intent arg0, int arg1, Bundle arg2)
void	startIntentSenderForResult(IntentSender arg0, int arg1, Intent arg2, int arg3, int arg4, int arg5, Bundle arg6)
void	startPostponedEnterTransition()
String	toString()
void	unregisterForContextMenu(View arg0)

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	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 android.content.ComponentCallbacks

abstract void	onConfigurationChanged(Configuration arg0)
abstract void	onLowMemory()

From interface android.view.View.OnCreateContextMenuListener

abstract void

onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)

From interface androidx.lifecycle.LifecycleOwner

abstract Lifecycle

getLifecycle()

From interface androidx.lifecycle.ViewModelStoreOwner

abstract ViewModelStore

getViewModelStore()

From interface androidx.lifecycle.HasDefaultViewModelProviderFactory

CreationExtras	getDefaultViewModelCreationExtras()
abstract ViewModelProvider.Factory	getDefaultViewModelProviderFactory()

From interface androidx.savedstate.SavedStateRegistryOwner

abstract SavedStateRegistry

getSavedStateRegistry()

From interface androidx.activity.result.ActivityResultCaller

abstract <I, O> ActivityResultLauncher<I>	registerForActivityResult(ActivityResultContract<I, O> arg0, ActivityResultCallback<O> arg1)
abstract <I, O> ActivityResultLauncher<I>	registerForActivityResult(ActivityResultContract<I, O> arg0, ActivityResultRegistry arg1, ActivityResultCallback<O> arg2)

From interface com.google.android.gms.cast.framework.media.widget.ControlButtonsContainer

abstract ImageView	getButtonImageViewAt(int slotIndex) Returns the `ImageView` of the button at `slotIndex` in this container.
abstract int	getButtonSlotCount() Returns the number of slots to hold control buttons in this container.
abstract int	getButtonTypeAt(int slotIndex) Returns the type of the button at `slotIndex` in this container.
abstract UIMediaController	getUIMediaController() Returns the `UIMediaController` used to bind views in this container.

XML Attributes

CastMiniController_castBackground

CastMiniController_castButtonColor

CastMiniController_castClosedCaptionsButtonDrawable

CastMiniController_castControlButtons

CastMiniController_castForward30ButtonDrawable

CastMiniController_castLargePauseButtonDrawable

CastMiniController_castLargePlayButtonDrawable

CastMiniController_castLargeStopButtonDrawable

CastMiniController_castMuteToggleButtonDrawable

CastMiniController_castPauseButtonDrawable

CastMiniController_castPlayButtonDrawable

CastMiniController_castProgressBarColor

CastMiniController_castRewind30ButtonDrawable

CastMiniController_castShowImageThumbnail

CastMiniController_castSkipNextButtonDrawable

CastMiniController_castSkipPreviousButtonDrawable

CastMiniController_castStopButtonDrawable

CastMiniController_castSubtitleTextAppearance

CastMiniController_castTitleTextAppearance

Public Constructors

public MiniControllerFragment ()

Public Methods

public final ImageView getButtonImageViewAt (int slotIndex)

Returns the ImageView of the button at slotIndex in this container. The ImageView is defined in the layout of the Activity which implements this interface.

Parameters

slotIndex	the index of the slot in this container.

Throws

IndexOutOfBoundsException

public final int getButtonSlotCount ()

Returns the number of slots to hold control buttons in this container.

public final int getButtonTypeAt (int slotIndex)

Returns the type of the button at slotIndex in this container.

Button types are defined as one of the ID resources:

@id/cast_button_type_empty: Not placing a button in this slot.
@id/cast_button_type_custom: A custom button.
@id/cast_button_type_play_pause_toggle: A button that toggles playback.
@id/cast_button_type_skip_previous: A button that skips to the previous item in the queue.
@id/cast_button_type_skip_next: A button that skips to the next item in the queue.
@id/cast_button_type_rewind_30_seconds: A button that rewinds the playback by 30 seconds.
@id/cast_button_type_forward_30_seconds: A button that skips forward the playback by 30 seconds.
@id/cast_button_type_mute_toggle: A button that mutes and unmutes the remote receiver.
@id/cast_button_type_closed_caption: A button that opens a dialog to select text and audio tracks.