Merge "MediaSession2: Create VolumeProvider2" (6847147c) · Commits · e / os / android_frameworks_base

media/java/android/media/VolumeProvider2.java

0 → 100644

+151 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright 2018 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 android.media;

		import android.annotation.IntDef;
		import android.annotation.NonNull;
		import android.annotation.SystemApi;
		import android.content.Context;
		import android.media.update.ApiLoader;
		import android.media.update.VolumeProvider2Provider;

		import java.lang.annotation.Retention;
		import java.lang.annotation.RetentionPolicy;

		/**
		* Handles requests to adjust or set the volume on a session. This is also used
		* to push volume updates back to the session. The provider must call
		* {@link #setCurrentVolume(int)} each time the volume being provided changes.
		* <p>
		* You can set a volume provider on a session by calling
		* {@link MediaSession2#setPlayer(MediaPlayerInterface, VolumeProvider)}.
		*
		* @hide
		*/
		public abstract class VolumeProvider2 {

		/**
		* @hide
		*/
		@IntDef({VOLUME_CONTROL_FIXED, VOLUME_CONTROL_RELATIVE, VOLUME_CONTROL_ABSOLUTE})
		@Retention(RetentionPolicy.SOURCE)
		public @interface ControlType {}

		/**
		* The volume is fixed and can not be modified. Requests to change volume
		* should be ignored.
		*/
		public static final int VOLUME_CONTROL_FIXED = 0;

		/**
		* The volume control uses relative adjustment via
		* {@link #onAdjustVolume(int)}. Attempts to set the volume to a specific
		* value should be ignored.
		*/
		public static final int VOLUME_CONTROL_RELATIVE = 1;

		/**
		* The volume control uses an absolute value. It may be adjusted using
		* {@link #onAdjustVolume(int)} or set directly using
		* {@link #onSetVolumeTo(int)}.
		*/
		public static final int VOLUME_CONTROL_ABSOLUTE = 2;

		private final VolumeProvider2Provider mProvider;

		/**
		* Create a new volume provider for handling volume events. You must specify
		* the type of volume control, the maximum volume that can be used, and the
		* current volume on the output.
		*
		* @param controlType The method for controlling volume that is used by this provider.
		* @param maxVolume The maximum allowed volume.
		* @param currentVolume The current volume on the output.
		*/
		public VolumeProvider2(@NonNull Context context, @ControlType int controlType,
		int maxVolume, int currentVolume) {
		mProvider = ApiLoader.getProvider(context).createVolumeProvider2(
		context, this, controlType, maxVolume, currentVolume);
		}

		/**
		* @hide
		*/
		@SystemApi
		public VolumeProvider2Provider getProvider() {
		return mProvider;
		}

		/**
		* Get the volume control type that this volume provider uses.
		*
		* @return The volume control type for this volume provider
		*/
		@ControlType
		public final int getControlType() {
		return mProvider.getControlType_impl();
		}

		/**
		* Get the maximum volume this provider allows.
		*
		* @return The max allowed volume.
		*/
		public final int getMaxVolume() {
		return mProvider.getMaxVolume_impl();
		}

		/**
		* Gets the current volume. This will be the last value set by
		* {@link #setCurrentVolume(int)}.
		*
		* @return The current volume.
		*/
		public final int getCurrentVolume() {
		return mProvider.getCurrentVolume_impl();
		}

		/**
		* Notify the system that the current volume has been changed. This must be
		* called every time the volume changes to ensure it is displayed properly.
		*
		* @param currentVolume The current volume on the output.
		*/
		public final void setCurrentVolume(int currentVolume) {
		mProvider.setCurrentVolume_impl(currentVolume);
		}

		/**
		* Override to handle requests to set the volume of the current output.
		* After the volume has been modified {@link #setCurrentVolume} must be
		* called to notify the system.
		*
		* @param volume The volume to set the output to.
		*/
		public void onSetVolumeTo(int volume) { }

		/**
		* Override to handle requests to adjust the volume of the current output.
		* Direction will be one of {@link AudioManager#ADJUST_LOWER},
		* {@link AudioManager#ADJUST_RAISE}, {@link AudioManager#ADJUST_SAME}.
		* After the volume has been modified {@link #setCurrentVolume} must be
		* called to notify the system.
		*
		* @param direction The direction to change the volume in.
		*/
		public void onAdjustVolume(int direction) { }
		}

media/java/android/media/update/StaticProvider.java

+4 −3

Original line number	Diff line number	Diff line
		@@ -17,7 +17,6 @@
		package android.media.update;

		import android.annotation.Nullable;
		import android.app.PendingIntent;
		import android.content.Context;
		import android.media.DataSourceDesc;
		import android.media.MediaBrowser2;
		@@ -38,8 +37,7 @@ import android.media.MediaSessionService2;
		import android.media.Rating2;
		import android.media.SessionPlayer2;
		import android.media.SessionToken2;
		import android.media.VolumeProvider;
		import android.media.update.MediaLibraryService2Provider.MediaLibrarySessionProvider;
		import android.media.VolumeProvider2;
		import android.media.update.MediaSession2Provider.BuilderBaseProvider;
		import android.media.update.MediaSession2Provider.CommandGroupProvider;
		import android.media.update.MediaSession2Provider.CommandProvider;
		@@ -107,6 +105,9 @@ public interface StaticProvider {
		String mediaId, DataSourceDesc dsd, MediaMetadata2 metadata, int flags);
		MediaItem2 fromBundle_MediaItem2(Context context, Bundle bundle);

		VolumeProvider2Provider createVolumeProvider2(Context context, VolumeProvider2 instance,
		int controlType, int maxVolume, int currentVolume);

		MediaMetadata2 fromBundle_MediaMetadata2(Context context, Bundle bundle);
		MediaMetadata2Provider.BuilderProvider createMediaMetadata2Builder(
		Context context, MediaMetadata2.Builder builder);

media/java/android/media/update/VolumeProvider2Provider.java

0 → 100644

+27 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright 2018 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 android.media.update;

		/**
		* @hide
		*/
		// TODO(jaewan): @SystemApi
		public interface VolumeProvider2Provider {
		int getControlType_impl();
		int getMaxVolume_impl();
		int getCurrentVolume_impl();
		void setCurrentVolume_impl(int currentVolume);
		}