Merge changes from topic "add_cast_volume"

* changes:
  Add SliceWorker for remote volume controller
  Add remote volume slider to sound settings
This commit is contained in:
Lei Yu
2019-03-06 23:59:44 +00:00
committed by Android (Google) Code Review
10 changed files with 545 additions and 4 deletions

View File

@@ -100,6 +100,7 @@
<uses-permission android:name="android.permission.USE_RESERVED_DISK" />
<uses-permission android:name="android.permission.MANAGE_SCOPED_ACCESS_DIRECTORY_PERMISSIONS" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.MEDIA_CONTENT_CONTROL" />
<application android:label="@string/settings_label"
android:icon="@drawable/ic_launcher_settings"

View File

@@ -7193,6 +7193,9 @@
<!-- Sound: Title for the option managing media volume. [CHAR LIMIT=30] -->
<string name="media_volume_option_title">Media volume</string>
<!-- Sound: Title for the option managing remote media volume. [CHAR LIMIT=30] -->
<string name="remote_media_volume_option_title">Cast volume</string>
<!-- Sound: Title for the option managing call volume. [CHAR LIMIT=30] -->
<string name="call_volume_option_title">Call volume</string>

View File

@@ -22,6 +22,15 @@
settings:keywords="@string/keywords_sounds"
settings:initialExpandedChildrenCount="9">
<!-- Remote volume -->
<com.android.settings.notification.RemoteVolumeSeekBarPreference
android:key="remote_volume"
android:icon="@drawable/ic_volume_remote"
android:title="@string/remote_media_volume_option_title"
android:order="-185"
settings:allowDynamicSummaryInSlice="true"
settings:controller="com.android.settings.notification.RemoteVolumePreferenceController"/>
<!-- Media volume -->
<com.android.settings.notification.VolumeSeekBarPreference
android:key="media_volume"

View File

@@ -0,0 +1,261 @@
/*
* Copyright (C) 2019 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.android.settings.notification;
import android.content.Context;
import android.media.session.MediaController;
import android.media.session.MediaSession;
import android.media.session.MediaSessionManager;
import android.net.Uri;
import android.os.Looper;
import android.text.TextUtils;
import androidx.annotation.VisibleForTesting;
import androidx.lifecycle.OnLifecycleEvent;
import androidx.preference.PreferenceScreen;
import com.android.settings.R;
import com.android.settings.slices.SliceBackgroundWorker;
import com.android.settingslib.core.lifecycle.Lifecycle;
import com.android.settingslib.volume.MediaSessions;
import java.io.IOException;
import java.util.List;
public class RemoteVolumePreferenceController extends
VolumeSeekBarPreferenceController {
private static final String KEY_REMOTE_VOLUME = "remote_volume";
@VisibleForTesting
static final int REMOTE_VOLUME = 100;
private MediaSessionManager mMediaSessionManager;
private MediaSessions mMediaSessions;
@VisibleForTesting
MediaSession.Token mActiveToken;
@VisibleForTesting
MediaController mMediaController;
@VisibleForTesting
MediaSessions.Callbacks mCallbacks = new MediaSessions.Callbacks() {
@Override
public void onRemoteUpdate(MediaSession.Token token, String name,
MediaController.PlaybackInfo pi) {
if (mActiveToken == null) {
updateToken(token);
}
if (mActiveToken == token) {
updatePreference(mPreference, mActiveToken, pi);
}
}
@Override
public void onRemoteRemoved(MediaSession.Token t) {
if (mActiveToken == t) {
updateToken(null);
if (mPreference != null) {
mPreference.setVisible(false);
}
}
}
@Override
public void onRemoteVolumeChanged(MediaSession.Token token, int flags) {
if (mActiveToken == token) {
final MediaController.PlaybackInfo pi = mMediaController.getPlaybackInfo();
if (pi != null) {
setSliderPosition(pi.getCurrentVolume());
}
}
}
};
public RemoteVolumePreferenceController(Context context) {
super(context, KEY_REMOTE_VOLUME);
mMediaSessionManager = context.getSystemService(MediaSessionManager.class);
mMediaSessions = new MediaSessions(context, Looper.getMainLooper(), mCallbacks);
}
@Override
public int getAvailabilityStatus() {
final List<MediaController> controllers = mMediaSessionManager.getActiveSessions(null);
for (MediaController mediaController : controllers) {
final MediaController.PlaybackInfo pi = mediaController.getPlaybackInfo();
if (isRemote(pi)) {
updateToken(mediaController.getSessionToken());
return AVAILABLE;
}
}
// No active remote media at this point
return CONDITIONALLY_UNAVAILABLE;
}
@Override
public void displayPreference(PreferenceScreen screen) {
super.displayPreference(screen);
if (mMediaController != null) {
updatePreference(mPreference, mActiveToken, mMediaController.getPlaybackInfo());
}
}
@OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
public void onResume() {
super.onResume();
//TODO(b/126199571): register callback once b/126890783 is fixed
}
@OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
public void onPause() {
super.onPause();
//TODO(b/126199571): unregister callback once b/126890783 is fixed
}
@Override
public int getSliderPosition() {
if (mPreference != null) {
return mPreference.getProgress();
}
if (mMediaController == null) {
return 0;
}
final MediaController.PlaybackInfo playbackInfo = mMediaController.getPlaybackInfo();
return playbackInfo != null ? playbackInfo.getCurrentVolume() : 0;
}
@Override
public boolean setSliderPosition(int position) {
if (mPreference != null) {
mPreference.setProgress(position);
}
if (mMediaController == null) {
return false;
}
mMediaController.setVolumeTo(position, 0);
return true;
}
@Override
public int getMaxSteps() {
if (mPreference != null) {
return mPreference.getMax();
}
if (mMediaController == null) {
return 0;
}
final MediaController.PlaybackInfo playbackInfo = mMediaController.getPlaybackInfo();
return playbackInfo != null ? playbackInfo.getMaxVolume() : 0;
}
@Override
public boolean isSliceable() {
return TextUtils.equals(getPreferenceKey(), KEY_REMOTE_VOLUME);
}
@Override
public String getPreferenceKey() {
return KEY_REMOTE_VOLUME;
}
@Override
public int getAudioStream() {
// This can be anything because remote volume controller doesn't rely on it.
return REMOTE_VOLUME;
}
@Override
public int getMuteIcon() {
return R.drawable.ic_volume_remote_mute;
}
public static boolean isRemote(MediaController.PlaybackInfo pi) {
return pi != null
&& pi.getPlaybackType() == MediaController.PlaybackInfo.PLAYBACK_TYPE_REMOTE;
}
@Override
public Class<? extends SliceBackgroundWorker> getBackgroundWorkerClass() {
//TODO(b/126199571): return RemoteVolumeSliceWorker once b/126890783 is fixed
return null;
}
private void updatePreference(VolumeSeekBarPreference seekBarPreference,
MediaSession.Token token, MediaController.PlaybackInfo playbackInfo) {
if (seekBarPreference == null || token == null || playbackInfo == null) {
return;
}
seekBarPreference.setMax(playbackInfo.getMaxVolume());
seekBarPreference.setVisible(true);
setSliderPosition(playbackInfo.getCurrentVolume());
}
private void updateToken(MediaSession.Token token) {
mActiveToken = token;
if (token != null) {
mMediaController = new MediaController(mContext, mActiveToken);
} else {
mMediaController = null;
}
}
/**
* Listener for background change to remote volume, which listens callback
* from {@code MediaSessions}
*/
public static class RemoteVolumeSliceWorker extends SliceBackgroundWorker<Void> implements
MediaSessions.Callbacks {
private MediaSessions mMediaSessions;
public RemoteVolumeSliceWorker(Context context, Uri uri) {
super(context, uri);
mMediaSessions = new MediaSessions(context, Looper.getMainLooper(), this);
}
@Override
protected void onSlicePinned() {
mMediaSessions.init();
}
@Override
protected void onSliceUnpinned() {
mMediaSessions.destroy();
}
@Override
public void close() throws IOException {
mMediaSessions = null;
}
@Override
public void onRemoteUpdate(MediaSession.Token token, String name,
MediaController.PlaybackInfo pi) {
notifySliceChange();
}
@Override
public void onRemoteRemoved(MediaSession.Token t) {
notifySliceChange();
}
@Override
public void onRemoteVolumeChanged(MediaSession.Token token, int flags) {
notifySliceChange();
}
}
}

View File

@@ -0,0 +1,56 @@
/*
* Copyright (C) 2019 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.android.settings.notification;
import android.content.Context;
import android.util.AttributeSet;
/**
* A slider preference that controls remote volume, which doesn't go through
* {@link android.media.AudioManager}
**/
public class RemoteVolumeSeekBarPreference extends VolumeSeekBarPreference {
public RemoteVolumeSeekBarPreference(Context context, AttributeSet attrs, int defStyleAttr,
int defStyleRes) {
super(context, attrs, defStyleAttr, defStyleRes);
}
public RemoteVolumeSeekBarPreference(Context context, AttributeSet attrs, int defStyleAttr) {
super(context, attrs, defStyleAttr);
}
public RemoteVolumeSeekBarPreference(Context context, AttributeSet attrs) {
super(context, attrs);
}
public RemoteVolumeSeekBarPreference(Context context) {
super(context);
}
@Override
public void setStream(int stream) {
// Do nothing here, volume is not controlled by AudioManager
}
@Override
protected void init() {
if (mSeekBar == null) return;
updateIconView();
updateSuppressionText();
}
}

View File

@@ -184,6 +184,7 @@ public class SoundSettings extends DashboardFragment implements OnActivityResult
volumeControllers.add(use(RingVolumePreferenceController.class));
volumeControllers.add(use(NotificationVolumePreferenceController.class));
volumeControllers.add(use(CallVolumePreferenceController.class));
volumeControllers.add(use(RemoteVolumePreferenceController.class));
use(MediaOutputPreferenceController.class).setCallback(listPreference ->
onPreferenceDataChanged(listPreference));

View File

@@ -40,8 +40,8 @@ import java.util.Objects;
public class VolumeSeekBarPreference extends SeekBarPreference {
private static final String TAG = "VolumeSeekBarPreference";
protected SeekBar mSeekBar;
private int mStream;
private SeekBar mSeekBar;
private SeekBarVolumizer mVolumizer;
private Callback mCallback;
private ImageView mIconView;
@@ -121,7 +121,7 @@ public class VolumeSeekBarPreference extends SeekBarPreference {
init();
}
private void init() {
protected void init() {
if (mSeekBar == null) return;
final SeekBarVolumizer.Callback sbvc = new SeekBarVolumizer.Callback() {
@Override
@@ -158,7 +158,7 @@ public class VolumeSeekBarPreference extends SeekBarPreference {
}
}
private void updateIconView() {
protected void updateIconView() {
if (mIconView == null) return;
if (mIconResId != 0) {
mIconView.setImageResource(mIconResId);
@@ -195,7 +195,7 @@ public class VolumeSeekBarPreference extends SeekBarPreference {
updateSuppressionText();
}
private void updateSuppressionText() {
protected void updateSuppressionText() {
if (mSuppressionTextView != null && mSeekBar != null) {
mSuppressionTextView.setText(mSuppressionText);
final boolean showSuppression = !TextUtils.isEmpty(mSuppressionText);

View File

@@ -19,6 +19,7 @@ package com.android.settings.panel;
import static com.android.settings.slices.CustomSliceRegistry.VOLUME_ALARM_URI;
import static com.android.settings.slices.CustomSliceRegistry.VOLUME_CALL_URI;
import static com.android.settings.slices.CustomSliceRegistry.VOLUME_MEDIA_URI;
import static com.android.settings.slices.CustomSliceRegistry.VOLUME_REMOTE_MEDIA_URI;
import static com.android.settings.slices.CustomSliceRegistry.VOLUME_RINGER_URI;
import android.app.settings.SettingsEnums;
@@ -52,6 +53,7 @@ public class VolumePanel implements PanelContent {
@Override
public List<Uri> getSlices() {
final List<Uri> uris = new ArrayList<>();
uris.add(VOLUME_REMOTE_MEDIA_URI);
uris.add(VOLUME_MEDIA_URI);
uris.add(VOLUME_CALL_URI);
uris.add(VOLUME_RINGER_URI);

View File

@@ -219,6 +219,17 @@ public class CustomSliceRegistry {
.appendPath(SettingsSlicesContract.PATH_SETTING_ACTION)
.appendPath("media_volume")
.build();
/**
* Full {@link Uri} for the Remote Media Volume Slice.
*/
public static final Uri VOLUME_REMOTE_MEDIA_URI = new Uri.Builder()
.scheme(ContentResolver.SCHEME_CONTENT)
.authority(SettingsSliceProvider.SLICE_AUTHORITY)
.appendPath(SettingsSlicesContract.PATH_SETTING_ACTION)
.appendPath("remote_volume")
.build();
/**
* Full {@link Uri} for the Ringer volume Slice.
*/

View File

@@ -0,0 +1,197 @@
/*
* Copyright (C) 2019 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.android.settings.notification;
import static com.google.common.truth.Truth.assertThat;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import android.content.Context;
import android.media.session.ControllerLink;
import android.media.session.MediaController;
import android.media.session.MediaSession;
import android.media.session.MediaSessionManager;
import com.android.settings.R;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;
import java.util.ArrayList;
import java.util.List;
@RunWith(RobolectricTestRunner.class)
public class RemoteVolumePreferenceControllerTest {
private static final int CURRENT_POS = 5;
private static final int MAX_POS = 10;
@Mock
private MediaSessionManager mMediaSessionManager;
@Mock
private MediaController mMediaController;
@Mock
private ControllerLink.ControllerStub mStub;
@Mock
private ControllerLink.ControllerStub mStub2;
private MediaSession.Token mToken;
private MediaSession.Token mToken2;
private RemoteVolumePreferenceController mController;
private Context mContext;
private List<MediaController> mActiveSessions;
private MediaController.PlaybackInfo mPlaybackInfo;
@Before
public void setUp() {
MockitoAnnotations.initMocks(this);
mContext = spy(RuntimeEnvironment.application);
when(mContext.getSystemService(MediaSessionManager.class)).thenReturn(mMediaSessionManager);
mActiveSessions = new ArrayList<>();
mActiveSessions.add(mMediaController);
when(mMediaSessionManager.getActiveSessions(null)).thenReturn(
mActiveSessions);
mToken = new MediaSession.Token(new ControllerLink(mStub));
mToken2 = new MediaSession.Token(new ControllerLink(mStub2));
mController = new RemoteVolumePreferenceController(mContext);
mPlaybackInfo = new MediaController.PlaybackInfo(
MediaController.PlaybackInfo.PLAYBACK_TYPE_REMOTE, 0, MAX_POS, CURRENT_POS, null);
when(mMediaController.getPlaybackInfo()).thenReturn(mPlaybackInfo);
}
@Test
public void isAvailable_containRemoteMedia_returnTrue() {
when(mMediaController.getPlaybackInfo()).thenReturn(
new MediaController.PlaybackInfo(MediaController.PlaybackInfo.PLAYBACK_TYPE_REMOTE,
0, 0, 0, null));
assertThat(mController.isAvailable()).isTrue();
}
@Test
public void isAvailable_noRemoteMedia_returnFalse() {
when(mMediaController.getPlaybackInfo()).thenReturn(
new MediaController.PlaybackInfo(MediaController.PlaybackInfo.PLAYBACK_TYPE_LOCAL,
0, 0, 0, null));
assertThat(mController.isAvailable()).isFalse();
}
@Test
public void getMuteIcon_returnMuteIcon() {
assertThat(mController.getMuteIcon()).isEqualTo(R.drawable.ic_volume_remote_mute);
}
@Test
public void getAudioStream_returnRemoteVolume() {
assertThat(mController.getAudioStream()).isEqualTo(
RemoteVolumePreferenceController.REMOTE_VOLUME);
}
@Test
public void getSliderPosition_controllerNull_returnZero() {
mController.mMediaController = null;
assertThat(mController.getSliderPosition()).isEqualTo(0);
}
@Test
public void getSliderPosition_controllerExists_returnValue() {
mController.mMediaController = mMediaController;
assertThat(mController.getSliderPosition()).isEqualTo(CURRENT_POS);
}
@Test
public void getMaxSteps_controllerNull_returnZero() {
mController.mMediaController = null;
assertThat(mController.getMaxSteps()).isEqualTo(0);
}
@Test
public void getMaxSteps_controllerExists_returnValue() {
mController.mMediaController = mMediaController;
assertThat(mController.getMaxSteps()).isEqualTo(MAX_POS);
}
@Test
public void setSliderPosition_controllerNull_returnFalse() {
mController.mMediaController = null;
assertThat(mController.setSliderPosition(CURRENT_POS)).isFalse();
}
@Test
public void setSliderPosition_controllerExists_returnTrue() {
mController.mMediaController = mMediaController;
assertThat(mController.setSliderPosition(CURRENT_POS)).isTrue();
verify(mMediaController).setVolumeTo(CURRENT_POS, 0 /* flags */);
}
@Test
public void onRemoteUpdate_firstToken_updateTokenAndPreference() {
mController.mPreference = new VolumeSeekBarPreference(mContext);
mController.mActiveToken = null;
mController.mCallbacks.onRemoteUpdate(mToken, "token", mPlaybackInfo);
assertThat(mController.mActiveToken).isEqualTo(mToken);
assertThat(mController.mPreference.isVisible()).isTrue();
assertThat(mController.mPreference.getMax()).isEqualTo(MAX_POS);
assertThat(mController.mPreference.getProgress()).isEqualTo(CURRENT_POS);
}
@Test
public void onRemoteUpdate_differentToken_doNothing() {
mController.mActiveToken = mToken;
mController.mCallbacks.onRemoteUpdate(mToken2, "token2", mPlaybackInfo);
assertThat(mController.mActiveToken).isEqualTo(mToken);
}
@Test
public void onRemoteRemoved_tokenRemoved_setInvisible() {
mController.mPreference = new VolumeSeekBarPreference(mContext);
mController.mActiveToken = mToken;
mController.mCallbacks.onRemoteRemoved(mToken);
assertThat(mController.mActiveToken).isNull();
assertThat(mController.mPreference.isVisible()).isFalse();
}
@Test
public void onRemoteVolumeChanged_volumeChanged_updateIt() {
mController.mPreference = new VolumeSeekBarPreference(mContext);
mController.mPreference.setMax(MAX_POS);
mController.mActiveToken = mToken;
mController.mMediaController = mMediaController;
mController.mCallbacks.onRemoteVolumeChanged(mToken, 0 /* flags */);
assertThat(mController.mPreference.getProgress()).isEqualTo(CURRENT_POS);
}
}