Java tutorial
/* * Copyright (C) 2014 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.torrenttunes.android.ui; import android.app.Activity; import android.content.BroadcastReceiver; import android.content.Context; import android.content.Intent; import android.content.IntentFilter; import android.media.session.PlaybackState; import android.net.ConnectivityManager; import android.os.Bundle; import android.support.v4.app.Fragment; import android.support.v4.media.MediaMetadataCompat; import android.support.v4.media.browse.MediaBrowserCompat; import android.support.v4.media.session.MediaControllerCompat; import android.support.v4.media.session.PlaybackStateCompat; import android.view.LayoutInflater; import android.view.View; import android.view.ViewGroup; import android.widget.AdapterView; import android.widget.ArrayAdapter; import android.widget.ListView; import android.widget.TextView; import android.widget.Toast; import com.torrenttunes.android.R; import com.torrenttunes.android.MusicService; import com.torrenttunes.android.utils.LogHelper; import com.torrenttunes.android.utils.MediaIDHelper; import com.torrenttunes.android.utils.NetworkHelper; import java.util.ArrayList; import java.util.List; /** * A Fragment that lists all the various browsable queues available * from a {@link android.service.media.MediaBrowserService}. * <p/> * It uses a {@link MediaBrowserCompat} to connect to the {@link MusicService}. * Once connected, the fragment subscribes to get all the children. * All {@link MediaBrowserCompat.MediaItem}'s that can be browsed are shown in a ListView. */ public class MediaBrowserFragment extends Fragment { private static final String TAG = LogHelper.makeLogTag(MediaBrowserFragment.class); private static final String ARG_MEDIA_ID = "media_id"; private BrowseAdapter mBrowserAdapter; private String mMediaId; private MediaFragmentListener mMediaFragmentListener; private MediaControllerProvider mMediaControllerProvider; private View mErrorView; private TextView mErrorMessage; private BroadcastReceiver mConnectivityChangeReceiver = new BroadcastReceiver() { private boolean oldOnline = false; @Override public void onReceive(Context context, Intent intent) { // We don't care about network changes while this fragment is not associated // with a media ID (for example, while it is being initialized) if (mMediaId != null) { boolean isOnline = NetworkHelper.isOnline(context); if (isOnline != oldOnline) { oldOnline = isOnline; checkForUserVisibleErrors(false); if (isOnline) { mBrowserAdapter.notifyDataSetChanged(); } } } } }; // Receive callbacks from the MediaController. Here we update our state such as which queue // is being shown, the current title and description and the PlaybackState. private MediaControllerCompat.Callback mMediaControllerCallback = new MediaControllerCompat.Callback() { @Override public void onMetadataChanged(MediaMetadataCompat metadata) { super.onMetadataChanged(metadata); if (metadata == null) { return; } LogHelper.d(TAG, "Received metadata change to media ", metadata.getDescription().getMediaId()); mBrowserAdapter.notifyDataSetChanged(); } @Override public void onPlaybackStateChanged(PlaybackStateCompat state) { super.onPlaybackStateChanged(state); LogHelper.d(TAG, "Received state change: ", state); checkForUserVisibleErrors(false); mBrowserAdapter.notifyDataSetChanged(); } }; private MediaBrowserCompat.SubscriptionCallback mSubscriptionCallback = new MediaBrowserCompat.SubscriptionCallback() { @Override public void onChildrenLoaded(String parentId, List<MediaBrowserCompat.MediaItem> children) { try { LogHelper.d(TAG, "fragment onChildrenLoaded, parentId=" + parentId + " count=" + children.size()); checkForUserVisibleErrors(children.isEmpty()); mBrowserAdapter.clear(); for (MediaBrowserCompat.MediaItem item : children) { mBrowserAdapter.add(item); } mBrowserAdapter.notifyDataSetChanged(); } catch (Throwable t) { LogHelper.e(TAG, "Error on childrenloaded", t); } } @Override public void onError(String id) { LogHelper.e(TAG, "browse fragment subscription onError, id=" + id); Toast.makeText(getActivity(), R.string.error_loading_media, Toast.LENGTH_LONG).show(); checkForUserVisibleErrors(true); } }; @Override public void onAttach(Activity activity) { super.onAttach(activity); // If used on an activity that doesn't implement MediaFragmentListener, it // will throw an exception as expected: mMediaFragmentListener = (MediaFragmentListener) activity; mMediaControllerProvider = (MediaControllerProvider) activity; } @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { LogHelper.d(TAG, "fragment.onCreateView"); View rootView = inflater.inflate(R.layout.fragment_list, container, false); mErrorView = rootView.findViewById(R.id.playback_error); mErrorMessage = (TextView) mErrorView.findViewById(R.id.error_message); mBrowserAdapter = new BrowseAdapter(getActivity(), (MediaControllerProvider) getActivity()); ListView listView = (ListView) rootView.findViewById(R.id.list_view); listView.setAdapter(mBrowserAdapter); listView.setOnItemClickListener(new AdapterView.OnItemClickListener() { @Override public void onItemClick(AdapterView<?> parent, View view, int position, long id) { checkForUserVisibleErrors(false); MediaBrowserCompat.MediaItem item = mBrowserAdapter.getItem(position); mMediaFragmentListener.onMediaItemSelected(item); } }); return rootView; } @Override public void onStart() { super.onStart(); // fetch browsing information to fill the listview: MediaBrowserCompat mediaBrowser = mMediaFragmentListener.getMediaBrowser(); LogHelper.d(TAG, "fragment.onStart, mediaId=", mMediaId, " onConnected=" + mediaBrowser.isConnected()); if (mediaBrowser != null && mediaBrowser.isConnected()) { onConnected(); } // Registers BroadcastReceiver to track network connection changes. this.getActivity().registerReceiver(mConnectivityChangeReceiver, new IntentFilter(ConnectivityManager.CONNECTIVITY_ACTION)); } @Override public void onStop() { super.onStop(); MediaBrowserCompat mediaBrowser = mMediaFragmentListener.getMediaBrowser(); if (mediaBrowser != null && mediaBrowser.isConnected() && mMediaId != null) { mediaBrowser.unsubscribe(mMediaId); } if (mMediaControllerProvider.getSupportMediaController() != null) { mMediaControllerProvider.getSupportMediaController().unregisterCallback(mMediaControllerCallback); } this.getActivity().unregisterReceiver(mConnectivityChangeReceiver); } @Override public void onDetach() { super.onDetach(); mMediaFragmentListener = null; mMediaControllerProvider = null; } public String getMediaId() { Bundle args = getArguments(); if (args != null) { return args.getString(ARG_MEDIA_ID); } return null; } public void setMediaId(String mediaId) { Bundle args = new Bundle(1); args.putString(MediaBrowserFragment.ARG_MEDIA_ID, mediaId); setArguments(args); } // Called when the MediaBrowserCompat is connected. This method is either called by the // fragment.onStart() or explicitly by the activity in the case where the connection // completes after the onStart() public void onConnected() { if (isDetached()) { return; } mMediaId = getMediaId(); if (mMediaId == null) { mMediaId = mMediaFragmentListener.getMediaBrowser().getRoot(); } updateTitle(); // Unsubscribing before subscribing is required if this mediaId already has a subscriber // on this MediaBrowserCompat instance. Subscribing to an already subscribed mediaId will replace // the callback, but won't trigger the initial callback.onChildrenLoaded. // // This is temporary: A bug is being fixed that will make subscribe // consistently call onChildrenLoaded initially, no matter if it is replacing an existing // subscriber or not. Currently this only happens if the mediaID has no previous // subscriber or if the media content changes on the service side, so we need to // unsubscribe first. mMediaFragmentListener.getMediaBrowser().unsubscribe(mMediaId); mMediaFragmentListener.getMediaBrowser().subscribe(mMediaId, mSubscriptionCallback); // Add MediaController callback so we can redraw the list when metadata changes: if (mMediaControllerProvider.getSupportMediaController() != null) { mMediaControllerProvider.getSupportMediaController().registerCallback(mMediaControllerCallback); } } private void checkForUserVisibleErrors(boolean forceError) { boolean showError = forceError; // If offline, message is about the lack of connectivity: if (!NetworkHelper.isOnline(getActivity())) { mErrorMessage.setText(R.string.error_no_connection); showError = true; } else { // otherwise, if state is ERROR and metadata!=null, use playback state error message: MediaControllerCompat controller = mMediaControllerProvider.getSupportMediaController(); if (controller != null && controller.getMetadata() != null && controller.getPlaybackState().getState() == PlaybackState.STATE_ERROR && controller.getPlaybackState().getErrorMessage() != null) { mErrorMessage.setText(controller.getPlaybackState().getErrorMessage()); showError = true; } else if (forceError) { // Finally, if the caller requested to show error, show a generic message: mErrorMessage.setText(R.string.error_loading_media); showError = true; } } mErrorView.setVisibility(showError ? View.VISIBLE : View.GONE); LogHelper.d(TAG, "checkForUserVisibleErrors. forceError=", forceError, " showError=", showError, " isOnline=", NetworkHelper.isOnline(getActivity())); } private void updateTitle() { if (MediaIDHelper.MEDIA_ID_ROOT.equals(mMediaId)) { mMediaFragmentListener.setToolbarTitle(null); return; } final String parentId = MediaIDHelper.getParentMediaID(mMediaId); // MediaBrowserCompat doesn't provide metadata for a given mediaID, only for its children. Since // the mediaId contains the item's hierarchy, we know the item's parent mediaId and we can // fetch and iterate over it and find the proper MediaItem, from which we get the title, // This is temporary - a better solution (a method to get a mediaItem by its mediaID) // is being worked out in the platform and should be available soon. LogHelper.d(TAG, "on updateTitle: mediaId=", mMediaId, " parentID=", parentId); if (parentId != null) { MediaBrowserCompat mediaBrowser = mMediaFragmentListener.getMediaBrowser(); LogHelper.d(TAG, "on updateTitle: mediaBrowser is ", mediaBrowser == null ? "null" : ("not null, connected=" + mediaBrowser.isConnected())); if (mediaBrowser != null && mediaBrowser.isConnected()) { // Unsubscribing is required to guarantee that we will get the initial values. // Otherwise, if there is another callback subscribed to this mediaID, mediaBrowser // will only call this callback when the media content change. mediaBrowser.unsubscribe(parentId); mediaBrowser.subscribe(parentId, new MediaBrowserCompat.SubscriptionCallback() { @Override public void onChildrenLoaded(String parentId, List<MediaBrowserCompat.MediaItem> children) { LogHelper.d(TAG, "Got ", children.size(), " children for ", parentId, ". Looking for ", mMediaId); for (MediaBrowserCompat.MediaItem item : children) { LogHelper.d(TAG, "child ", item.getMediaId()); if (item.getMediaId().equals(mMediaId)) { if (mMediaFragmentListener != null) { mMediaFragmentListener.setToolbarTitle(item.getDescription().getTitle()); } return; } } mMediaFragmentListener.getMediaBrowser().unsubscribe(parentId); } @Override public void onError(String id) { super.onError(id); LogHelper.d(TAG, "subscribe error: id=", id); } }); } } } // An adapter for showing the list of browsed MediaItem's private static class BrowseAdapter extends ArrayAdapter<MediaBrowserCompat.MediaItem> { private MediaControllerProvider mMediaControllerProvider; public BrowseAdapter(Activity context, MediaControllerProvider mediaControllerProvider) { super(context, R.layout.media_list_item, new ArrayList<MediaBrowserCompat.MediaItem>()); mMediaControllerProvider = mediaControllerProvider; } @Override public View getView(int position, View convertView, ViewGroup parent) { MediaBrowserCompat.MediaItem item = getItem(position); int state = MediaItemViewHolder.STATE_NONE; if (item.isPlayable()) { state = MediaItemViewHolder.STATE_PLAYABLE; MediaControllerCompat controller = mMediaControllerProvider.getSupportMediaController(); if (controller != null && controller.getMetadata() != null) { String currentPlaying = controller.getMetadata().getDescription().getMediaId(); String musicId = MediaIDHelper.extractMusicIDFromMediaID(item.getDescription().getMediaId()); if (currentPlaying != null && currentPlaying.equals(musicId)) { if (controller.getPlaybackState().getState() == PlaybackStateCompat.STATE_PLAYING) { state = MediaItemViewHolder.STATE_PLAYING; } else if (controller.getPlaybackState().getState() != PlaybackStateCompat.STATE_ERROR) { state = MediaItemViewHolder.STATE_PAUSED; } } } } return MediaItemViewHolder.setupView((Activity) getContext(), convertView, parent, item.getDescription(), state); } } public static interface MediaFragmentListener extends MediaBrowserProvider { void onMediaItemSelected(MediaBrowserCompat.MediaItem item); void setToolbarTitle(CharSequence title); } }