| /* |
| * Copyright (C) 2010 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.app; |
| |
| import static android.app.Flags.enableNightModeBinderCache; |
| |
| import android.annotation.CallbackExecutor; |
| import android.annotation.FlaggedApi; |
| import android.annotation.FloatRange; |
| import android.annotation.IntDef; |
| import android.annotation.IntRange; |
| import android.annotation.NonNull; |
| import android.annotation.Nullable; |
| import android.annotation.RequiresPermission; |
| import android.annotation.SystemApi; |
| import android.annotation.SystemService; |
| import android.annotation.TestApi; |
| import android.compat.annotation.UnsupportedAppUsage; |
| import android.content.Context; |
| import android.content.res.Configuration; |
| import android.os.Binder; |
| import android.os.IpcDataCache; |
| import android.os.RemoteException; |
| import android.os.ServiceManager; |
| import android.os.ServiceManager.ServiceNotFoundException; |
| import android.util.ArrayMap; |
| import android.util.ArraySet; |
| import android.util.Log; |
| import android.util.Slog; |
| |
| import com.android.internal.annotations.GuardedBy; |
| import com.android.internal.util.function.pooled.PooledLambda; |
| |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| import java.lang.ref.WeakReference; |
| import java.time.LocalTime; |
| import java.util.Comparator; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Objects; |
| import java.util.Set; |
| import java.util.concurrent.Executor; |
| import java.util.stream.Stream; |
| |
| /** |
| * This class provides access to the system uimode services. These services |
| * allow applications to control UI modes of the device. |
| * It provides functionality to disable the car mode and it gives access to the |
| * night mode settings. |
| * |
| * <p>These facilities are built on top of the underlying |
| * {@link android.content.Intent#ACTION_DOCK_EVENT} broadcasts that are sent when the user |
| * physical places the device into and out of a dock. When that happens, |
| * the UiModeManager switches the system {@link android.content.res.Configuration} |
| * to the appropriate UI mode, sends broadcasts about the mode switch, and |
| * starts the corresponding mode activity if appropriate. See the |
| * broadcasts {@link #ACTION_ENTER_CAR_MODE} and |
| * {@link #ACTION_ENTER_DESK_MODE} for more information. |
| * |
| * <p>In addition, the user may manually switch the system to car mode without |
| * physically being in a dock. While in car mode -- whether by manual action |
| * from the user or being physically placed in a dock -- a notification is |
| * displayed allowing the user to exit dock mode. Thus the dock mode |
| * represented here may be different than the current state of the underlying |
| * dock event broadcast. |
| */ |
| @SystemService(Context.UI_MODE_SERVICE) |
| public class UiModeManager { |
| |
| private static final String TAG = "UiModeManager"; |
| |
| |
| /** |
| * A listener with a single method that is invoked whenever the packages projecting using the |
| * {@link ProjectionType}s for which it is registered change. |
| * |
| * @hide |
| */ |
| @SystemApi |
| public interface OnProjectionStateChangedListener { |
| /** |
| * Callback invoked when projection state changes for a {@link ProjectionType} for which |
| * this listener was added. |
| * @param projectionType the listened-for {@link ProjectionType}s that have changed |
| * @param packageNames the {@link Set} of package names that have currently set those |
| * {@link ProjectionType}s. |
| */ |
| void onProjectionStateChanged(@ProjectionType int projectionType, |
| @NonNull Set<String> packageNames); |
| } |
| |
| /** |
| * Listener for the UI contrast. To listen for changes to |
| * the UI contrast on the device, implement this interface and |
| * register it with the system by calling {@link #addContrastChangeListener}. |
| */ |
| public interface ContrastChangeListener { |
| |
| /** |
| * Called when the color contrast enabled state changes. |
| * |
| * @param contrast The color contrast as in {@link #getContrast} |
| */ |
| void onContrastChanged(@FloatRange(from = -1.0f, to = 1.0f) float contrast); |
| } |
| |
| /** |
| * Broadcast sent when the device's UI has switched to car mode, either |
| * by being placed in a car dock or explicit action of the user. After |
| * sending the broadcast, the system will start the intent |
| * {@link android.content.Intent#ACTION_MAIN} with category |
| * {@link android.content.Intent#CATEGORY_CAR_DOCK} |
| * to display the car UI, which typically what an application would |
| * implement to provide their own interface. However, applications can |
| * also monitor this Intent in order to be informed of mode changes or |
| * prevent the normal car UI from being displayed by setting the result |
| * of the broadcast to {@link Activity#RESULT_CANCELED}. |
| * <p> |
| * This intent is broadcast when {@link #getCurrentModeType()} transitions to |
| * {@link Configuration#UI_MODE_TYPE_CAR} from some other ui mode. |
| */ |
| public static String ACTION_ENTER_CAR_MODE = "android.app.action.ENTER_CAR_MODE"; |
| |
| /** |
| * Broadcast sent when an app has entered car mode using either {@link #enableCarMode(int)} or |
| * {@link #enableCarMode(int, int)}. |
| * <p> |
| * Unlike {@link #ACTION_ENTER_CAR_MODE}, which is only sent when the global car mode state |
| * (i.e. {@link #getCurrentModeType()}) transitions to {@link Configuration#UI_MODE_TYPE_CAR}, |
| * this intent is sent any time an app declares it has entered car mode. Thus, this intent is |
| * intended for use by a component which needs to know not only when the global car mode state |
| * changed, but also when the highest priority app declaring car mode has changed. |
| * <p> |
| * This broadcast includes the package name of the app which requested to enter car mode in |
| * {@link #EXTRA_CALLING_PACKAGE}. The priority the app entered car mode at is specified in |
| * {@link #EXTRA_PRIORITY}. |
| * <p> |
| * This is primarily intended to be received by other components of the Android OS. |
| * <p> |
| * Receiver requires permission: {@link android.Manifest.permission.HANDLE_CAR_MODE_CHANGES} |
| * @hide |
| */ |
| @SystemApi |
| public static final String ACTION_ENTER_CAR_MODE_PRIORITIZED = |
| "android.app.action.ENTER_CAR_MODE_PRIORITIZED"; |
| |
| /** |
| * Broadcast sent when the device's UI has switch away from car mode back |
| * to normal mode. Typically used by a car mode app, to dismiss itself |
| * when the user exits car mode. |
| * <p> |
| * This intent is broadcast when {@link #getCurrentModeType()} transitions from |
| * {@link Configuration#UI_MODE_TYPE_CAR} to some other ui mode. |
| */ |
| public static String ACTION_EXIT_CAR_MODE = "android.app.action.EXIT_CAR_MODE"; |
| |
| /** |
| * Broadcast sent when an app has exited car mode using {@link #disableCarMode(int)}. |
| * <p> |
| * Unlike {@link #ACTION_EXIT_CAR_MODE}, which is only sent when the global car mode state |
| * (i.e. {@link #getCurrentModeType()}) transitions to a non-car mode state such as |
| * {@link Configuration#UI_MODE_TYPE_NORMAL}, this intent is sent any time an app declares it |
| * has exited car mode. Thus, this intent is intended for use by a component which needs to |
| * know not only when the global car mode state changed, but also when the highest priority app |
| * declaring car mode has changed. |
| * <p> |
| * This broadcast includes the package name of the app which requested to exit car mode in |
| * {@link #EXTRA_CALLING_PACKAGE}. The priority the app originally entered car mode at is |
| * specified in {@link #EXTRA_PRIORITY}. |
| * <p> |
| * If {@link #DISABLE_CAR_MODE_ALL_PRIORITIES} is used when disabling car mode (i.e. this is |
| * initiated by the user via the persistent car mode notification), this broadcast is sent once |
| * for each priority level for which car mode is being disabled. |
| * <p> |
| * This is primarily intended to be received by other components of the Android OS. |
| * <p> |
| * Receiver requires permission: {@link android.Manifest.permission.HANDLE_CAR_MODE_CHANGES} |
| * @hide |
| */ |
| @SystemApi |
| public static final String ACTION_EXIT_CAR_MODE_PRIORITIZED = |
| "android.app.action.EXIT_CAR_MODE_PRIORITIZED"; |
| |
| /** |
| * Broadcast sent when the device's UI has switched to desk mode, |
| * by being placed in a desk dock. After |
| * sending the broadcast, the system will start the intent |
| * {@link android.content.Intent#ACTION_MAIN} with category |
| * {@link android.content.Intent#CATEGORY_DESK_DOCK} |
| * to display the desk UI, which typically what an application would |
| * implement to provide their own interface. However, applications can |
| * also monitor this Intent in order to be informed of mode changes or |
| * prevent the normal desk UI from being displayed by setting the result |
| * of the broadcast to {@link Activity#RESULT_CANCELED}. |
| */ |
| public static String ACTION_ENTER_DESK_MODE = "android.app.action.ENTER_DESK_MODE"; |
| |
| /** |
| * Broadcast sent when the device's UI has switched away from desk mode back |
| * to normal mode. Typically used by a desk mode app, to dismiss itself |
| * when the user exits desk mode. |
| */ |
| public static String ACTION_EXIT_DESK_MODE = "android.app.action.EXIT_DESK_MODE"; |
| |
| /** |
| * String extra used with {@link #ACTION_ENTER_CAR_MODE_PRIORITIZED} and |
| * {@link #ACTION_EXIT_CAR_MODE_PRIORITIZED} to indicate the package name of the app which |
| * requested to enter or exit car mode. |
| * @hide |
| */ |
| @SystemApi |
| public static final String EXTRA_CALLING_PACKAGE = "android.app.extra.CALLING_PACKAGE"; |
| |
| /** |
| * Integer extra used with {@link #ACTION_ENTER_CAR_MODE_PRIORITIZED} and |
| * {@link #ACTION_EXIT_CAR_MODE_PRIORITIZED} to indicate the priority level at which car mode |
| * is being disabled. |
| * @hide |
| */ |
| @SystemApi |
| public static final String EXTRA_PRIORITY = "android.app.extra.PRIORITY"; |
| |
| /** @hide */ |
| @IntDef(prefix = { "MODE_" }, value = { |
| MODE_NIGHT_AUTO, |
| MODE_NIGHT_CUSTOM, |
| MODE_NIGHT_NO, |
| MODE_NIGHT_YES |
| }) |
| @Retention(RetentionPolicy.SOURCE) |
| public @interface NightMode {} |
| |
| /** |
| * Constant for {@link #setNightMode(int)} and {@link #getNightMode()}: |
| * automatically switch night mode on and off based on the time. |
| */ |
| public static final int MODE_NIGHT_AUTO = 0; |
| |
| /** |
| * Constant for {@link #setNightMode(int)} and {@link #getNightMode()}: |
| * automatically switch night mode on and off based on the time. |
| */ |
| public static final int MODE_NIGHT_CUSTOM = 3; |
| |
| /** |
| * Constant for {@link #setNightMode(int)} and {@link #getNightMode()}: |
| * never run in night mode. |
| */ |
| public static final int MODE_NIGHT_NO = 1; |
| |
| /** |
| * Constant for {@link #setNightMode(int)} and {@link #getNightMode()}: |
| * always run in night mode. |
| */ |
| public static final int MODE_NIGHT_YES = 2; |
| |
| /** @hide */ |
| @IntDef(prefix = { "MODE_ATTENTION_THEME_OVERLAY_" }, value = { |
| MODE_ATTENTION_THEME_OVERLAY_OFF, |
| MODE_ATTENTION_THEME_OVERLAY_NIGHT, |
| MODE_ATTENTION_THEME_OVERLAY_DAY |
| }) |
| @Retention(RetentionPolicy.SOURCE) |
| public @interface AttentionModeThemeOverlayType {} |
| |
| /** @hide */ |
| @IntDef(prefix = { "MODE_ATTENTION_THEME_OVERLAY_" }, value = { |
| MODE_ATTENTION_THEME_OVERLAY_OFF, |
| MODE_ATTENTION_THEME_OVERLAY_NIGHT, |
| MODE_ATTENTION_THEME_OVERLAY_DAY, |
| MODE_ATTENTION_THEME_OVERLAY_UNKNOWN |
| }) |
| @Retention(RetentionPolicy.SOURCE) |
| public @interface AttentionModeThemeOverlayReturnType {} |
| |
| /** |
| * Constant for {@link #setAttentionModeThemeOverlay(int)} (int)} and {@link |
| * #getAttentionModeThemeOverlay()}: Keeps night mode as set by {@link #setNightMode(int)}. |
| * @hide |
| */ |
| @FlaggedApi(Flags.FLAG_MODES_API) |
| @TestApi |
| public static final int MODE_ATTENTION_THEME_OVERLAY_OFF = 1000; |
| |
| /** |
| * Constant for {@link #setAttentionModeThemeOverlay(int)} (int)} and {@link |
| * #getAttentionModeThemeOverlay()}: Maintains night mode always on. |
| * @hide |
| */ |
| @FlaggedApi(Flags.FLAG_MODES_API) |
| @TestApi |
| public static final int MODE_ATTENTION_THEME_OVERLAY_NIGHT = 1001; |
| |
| /** |
| * Constant for {@link #setAttentionModeThemeOverlay(int)} (int)} and {@link |
| * #getAttentionModeThemeOverlay()}: Maintains night mode always off (Light). |
| * @hide |
| */ |
| @FlaggedApi(Flags.FLAG_MODES_API) |
| @TestApi |
| public static final int MODE_ATTENTION_THEME_OVERLAY_DAY = 1002; |
| |
| /** |
| * Constant for {@link #getAttentionModeThemeOverlay()}: Error communication with server. |
| * @hide |
| */ |
| @FlaggedApi(Flags.FLAG_MODES_API) |
| @TestApi |
| public static final int MODE_ATTENTION_THEME_OVERLAY_UNKNOWN = -1; |
| |
| /** |
| * Granular types for {@link #setNightModeCustomType(int)} |
| * @hide |
| */ |
| @IntDef(prefix = { "MODE_NIGHT_CUSTOM_TYPE_" }, value = { |
| MODE_NIGHT_CUSTOM_TYPE_SCHEDULE, |
| MODE_NIGHT_CUSTOM_TYPE_BEDTIME, |
| }) |
| @Retention(RetentionPolicy.SOURCE) |
| public @interface NightModeCustomType {} |
| |
| /** |
| * Granular types for {@link #getNightModeCustomType()} |
| * @hide |
| */ |
| @IntDef(prefix = { "MODE_NIGHT_CUSTOM_TYPE_" }, value = { |
| MODE_NIGHT_CUSTOM_TYPE_UNKNOWN, |
| MODE_NIGHT_CUSTOM_TYPE_SCHEDULE, |
| MODE_NIGHT_CUSTOM_TYPE_BEDTIME, |
| }) |
| @Retention(RetentionPolicy.SOURCE) |
| public @interface NightModeCustomReturnType {} |
| |
| /** |
| * A granular type for {@link #MODE_NIGHT_CUSTOM} which is unknown. |
| * <p> |
| * This is the default value when the night mode is set to value other than |
| * {@link #MODE_NIGHT_CUSTOM}. |
| * @hide |
| */ |
| @SystemApi |
| public static final int MODE_NIGHT_CUSTOM_TYPE_UNKNOWN = -1; |
| |
| /** |
| * A granular type for {@link #MODE_NIGHT_CUSTOM} which is based on a custom schedule. |
| * <p> |
| * This is the default value when night mode is set to {@link #MODE_NIGHT_CUSTOM} unless the |
| * the night mode custom type is specified by calling {@link #setNightModeCustomType(int)}. |
| * @hide |
| */ |
| @SystemApi |
| public static final int MODE_NIGHT_CUSTOM_TYPE_SCHEDULE = 0; |
| |
| /** |
| * A granular type for {@link #MODE_NIGHT_CUSTOM} which is based on the bedtime schedule. |
| * @hide |
| */ |
| @SystemApi |
| public static final int MODE_NIGHT_CUSTOM_TYPE_BEDTIME = 1; |
| |
| private static Globals sGlobals; |
| |
| /** |
| * Context required for getting the opPackageName of API caller; maybe be {@code null} if the |
| * old constructor marked with UnSupportedAppUsage is used. |
| */ |
| private @Nullable Context mContext; |
| |
| private final Object mLock = new Object(); |
| /** |
| * Map that stores internally created {@link InnerListener} objects keyed by their corresponding |
| * externally provided callback objects. |
| */ |
| @GuardedBy("mLock") |
| private final Map<OnProjectionStateChangedListener, InnerListener> |
| mProjectionStateListenerMap = new ArrayMap<>(); |
| |
| /** |
| * Resource manager that prevents memory leakage of Contexts via binder objects if clients |
| * fail to remove listeners. |
| */ |
| @GuardedBy("mLock") |
| private final OnProjectionStateChangedListenerResourceManager |
| mOnProjectionStateChangedListenerResourceManager = |
| new OnProjectionStateChangedListenerResourceManager(); |
| |
| private static class Globals extends IUiModeManagerCallback.Stub { |
| |
| private final IUiModeManager mService; |
| private final Object mGlobalsLock = new Object(); |
| |
| private float mContrast = ContrastUtils.CONTRAST_DEFAULT_VALUE; |
| |
| /** |
| * Map that stores user provided {@link ContrastChangeListener} callbacks, |
| * and the executors on which these callbacks should be called. |
| */ |
| private final ArrayMap<ContrastChangeListener, Executor> |
| mContrastChangeListeners = new ArrayMap<>(); |
| |
| Globals(IUiModeManager service) { |
| mService = service; |
| try { |
| mService.addCallback(this); |
| mContrast = mService.getContrast(); |
| } catch (RemoteException e) { |
| Log.e(TAG, "Setup failed: UiModeManagerService is dead", e); |
| } |
| } |
| |
| private float getContrast() { |
| synchronized (mGlobalsLock) { |
| return mContrast; |
| } |
| } |
| |
| private void addContrastChangeListener(ContrastChangeListener listener, Executor executor) { |
| synchronized (mGlobalsLock) { |
| mContrastChangeListeners.put(listener, executor); |
| } |
| } |
| |
| private void removeContrastChangeListener(ContrastChangeListener listener) { |
| synchronized (mGlobalsLock) { |
| mContrastChangeListeners.remove(listener); |
| } |
| } |
| |
| @Override |
| public void notifyContrastChanged(float contrast) { |
| synchronized (mGlobalsLock) { |
| // if value changed in the settings, update the cached value and notify listeners |
| if (Math.abs(mContrast - contrast) < 1e-10) return; |
| mContrast = contrast; |
| mContrastChangeListeners.forEach((listener, executor) -> executor.execute( |
| () -> listener.onContrastChanged(contrast))); |
| } |
| } |
| } |
| |
| /** |
| * Define constants and conversions between {@link ContrastLevel}s and contrast values. |
| * <p> |
| * Contrast values are floats defined in [-1, 1], as defined in {@link #getContrast}. |
| * This is the official data type for contrast; |
| * all methods from the public API return contrast values. |
| * </p> |
| * <p> |
| * {@code ContrastLevel}, on the other hand, is an internal-only enumeration of contrasts that |
| * can be set from the system ui. Each {@code ContrastLevel} has an associated contrast value. |
| * </p> |
| * <p> |
| * Currently, a user chan chose from three contrast levels: |
| * <ul> |
| * <li>{@link #CONTRAST_LEVEL_STANDARD}, corresponding to the default contrast value 0f</li> |
| * <li>{@link #CONTRAST_LEVEL_MEDIUM}, corresponding to the contrast value 0.5f</li> |
| * <li>{@link #CONTRAST_LEVEL_HIGH}, corresponding to the maximum contrast value 1f</li> |
| * </ul> |
| * </p> |
| * |
| * @hide |
| */ |
| public static class ContrastUtils { |
| |
| private static final float CONTRAST_MIN_VALUE = -1f; |
| private static final float CONTRAST_MAX_VALUE = 1f; |
| public static final float CONTRAST_DEFAULT_VALUE = 0f; |
| |
| @IntDef(flag = true, prefix = { "CONTRAST_LEVEL_" }, value = { |
| CONTRAST_LEVEL_STANDARD, |
| CONTRAST_LEVEL_MEDIUM, |
| CONTRAST_LEVEL_HIGH |
| }) |
| @Retention(RetentionPolicy.SOURCE) |
| public @interface ContrastLevel {} |
| |
| public static final int CONTRAST_LEVEL_STANDARD = 0; |
| public static final int CONTRAST_LEVEL_MEDIUM = 1; |
| public static final int CONTRAST_LEVEL_HIGH = 2; |
| |
| private static Stream<Integer> allContrastLevels() { |
| return Stream.of(CONTRAST_LEVEL_STANDARD, CONTRAST_LEVEL_MEDIUM, CONTRAST_LEVEL_HIGH); |
| } |
| |
| /** |
| * Convert a contrast value in [-1, 1] to its associated {@link ContrastLevel} |
| */ |
| public static @ContrastLevel int toContrastLevel(float contrast) { |
| if (contrast < CONTRAST_MIN_VALUE || contrast > CONTRAST_MAX_VALUE) { |
| throw new IllegalArgumentException("contrast values should be in [-1, 1]"); |
| } |
| return allContrastLevels().min(Comparator.comparingDouble(contrastLevel -> |
| Math.abs(contrastLevel - 2 * contrast))).orElseThrow(); |
| } |
| |
| /** |
| * Convert a {@link ContrastLevel} to its associated contrast value in [-1, 1] |
| */ |
| public static float fromContrastLevel(@ContrastLevel int contrastLevel) { |
| if (allContrastLevels().noneMatch(level -> level == contrastLevel)) { |
| throw new IllegalArgumentException("unrecognized contrast level: " + contrastLevel); |
| } |
| return contrastLevel / 2f; |
| } |
| } |
| |
| @UnsupportedAppUsage |
| /*package*/ UiModeManager() throws ServiceNotFoundException { |
| this(null /* context */); |
| } |
| |
| /*package*/ UiModeManager(Context context) throws ServiceNotFoundException { |
| IUiModeManager service = IUiModeManager.Stub.asInterface( |
| ServiceManager.getServiceOrThrow(Context.UI_MODE_SERVICE)); |
| mContext = context; |
| if (service == null) return; |
| synchronized (mLock) { |
| if (sGlobals == null) sGlobals = new Globals(service); |
| } |
| } |
| |
| /** |
| * Flag for use with {@link #enableCarMode(int)}: go to the car |
| * home activity as part of the enable. Enabling this way ensures |
| * a clean transition between the current activity (in non-car-mode) and |
| * the car home activity that will serve as home while in car mode. This |
| * will switch to the car home activity even if we are already in car mode. |
| */ |
| public static final int ENABLE_CAR_MODE_GO_CAR_HOME = 0x0001; |
| |
| /** |
| * Flag for use with {@link #enableCarMode(int)}: allow sleep mode while in car mode. |
| * By default, when this flag is not set, the system may hold a full wake lock to keep the |
| * screen turned on and prevent the system from entering sleep mode while in car mode. |
| * Setting this flag disables such behavior and the system may enter sleep mode |
| * if there is no other user activity and no other wake lock held. |
| * Setting this flag can be relevant for a car dock application that does not require the |
| * screen kept on. |
| */ |
| public static final int ENABLE_CAR_MODE_ALLOW_SLEEP = 0x0002; |
| |
| /** @hide */ |
| @IntDef(prefix = {"ENABLE_CAR_MODE_"}, value = { |
| ENABLE_CAR_MODE_GO_CAR_HOME, |
| ENABLE_CAR_MODE_ALLOW_SLEEP |
| }) |
| @Retention(RetentionPolicy.SOURCE) |
| public @interface EnableCarMode {} |
| |
| /** |
| * Force device into car mode, like it had been placed in the car dock. |
| * This will cause the device to switch to the car home UI as part of |
| * the mode switch. |
| * @param flags Must be 0. |
| */ |
| public void enableCarMode(int flags) { |
| enableCarMode(DEFAULT_PRIORITY, flags); |
| } |
| |
| /** |
| * Force device into car mode, like it had been placed in the car dock. This will cause the |
| * device to switch to the car home UI as part of the mode switch. |
| * <p> |
| * An app may request to enter car mode when the system is already in car mode. The app may |
| * specify a "priority" when entering car mode. The device will remain in car mode |
| * (i.e. {@link #getCurrentModeType()} is {@link Configuration#UI_MODE_TYPE_CAR}) as long as |
| * there is a priority level at which car mode have been enabled. |
| * <p> |
| * Specifying a priority level when entering car mode is important in cases where multiple apps |
| * on a device implement a car-mode {@link android.telecom.InCallService} (see |
| * {@link android.telecom.TelecomManager#METADATA_IN_CALL_SERVICE_CAR_MODE_UI}). The |
| * {@link android.telecom.InCallService} associated with the highest priority app which entered |
| * car mode will be bound to by Telecom and provided with information about ongoing calls on |
| * the device. |
| * <p> |
| * System apps holding the required permission can enable car mode when the app determines the |
| * correct conditions exist for that app to be in car mode. The device maker should ensure that |
| * where multiple apps exist on the device which can potentially enter car mode, appropriate |
| * priorities are used to ensure that calls delivered by the |
| * {@link android.telecom.InCallService} API are sent to the highest priority app given the |
| * desired behavior of the car mode experience on the device. |
| * <p> |
| * If app A and app B both meet their own criteria to enable car mode, and it is desired that |
| * app B should be the one which should receive call information in that scenario, the priority |
| * for app B should be higher than the one for app A. The higher priority of app B compared to |
| * A means it will be bound to during calls and app A will not. When app B no longer meets its |
| * criteria for providing a car mode experience it uses {@link #disableCarMode(int)} to disable |
| * car mode at its priority level. The system will then unbind from app B and bind to app A as |
| * it has the next highest priority. |
| * <p> |
| * When an app enables car mode at a certain priority, it can disable car mode at the specified |
| * priority level using {@link #disableCarMode(int)}. An app may only enable car mode at a |
| * single priority. |
| * <p> |
| * Public apps are assumed to enter/exit car mode at the lowest priority, |
| * {@link #DEFAULT_PRIORITY}. |
| * |
| * @param priority The declared priority for the caller, where {@link #DEFAULT_PRIORITY} (0) is |
| * the lowest priority and higher numbers represent a higher priority. |
| * The priorities apps declare when entering car mode is determined by the |
| * device manufacturer based on the desired car mode experience. |
| * @param flags Car mode flags. |
| * @hide |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.ENTER_CAR_MODE_PRIORITIZED) |
| public void enableCarMode(@IntRange(from = 0) int priority, @EnableCarMode int flags) { |
| if (sGlobals != null) { |
| try { |
| sGlobals.mService.enableCarMode(flags, priority, |
| mContext == null ? null : mContext.getOpPackageName()); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| } |
| |
| /** |
| * Flag for use with {@link #disableCarMode(int)}: go to the normal |
| * home activity as part of the disable. Disabling this way ensures |
| * a clean transition between the current activity (in car mode) and |
| * the original home activity (which was typically last running without |
| * being in car mode). |
| */ |
| public static final int DISABLE_CAR_MODE_GO_HOME = 0x0001; |
| |
| /** |
| * Flag for use with {@link #disableCarMode(int)}: Disables car mode at ALL priority levels. |
| * Primarily intended for use from {@link com.android.internal.app.DisableCarModeActivity} to |
| * provide the user with a means to exit car mode at all priority levels. |
| * @hide |
| */ |
| public static final int DISABLE_CAR_MODE_ALL_PRIORITIES = 0x0002; |
| |
| /** @hide */ |
| @IntDef(prefix = { "DISABLE_CAR_MODE_" }, value = { |
| DISABLE_CAR_MODE_GO_HOME |
| }) |
| @Retention(RetentionPolicy.SOURCE) |
| public @interface DisableCarMode {} |
| |
| /** |
| * The default priority used for entering car mode. |
| * <p> |
| * Callers of the {@link #enableCarMode(int)} priority will be assigned the default priority. |
| * This is considered the lowest possible priority for enabling car mode. |
| * <p> |
| * System apps can specify a priority other than the default priority when using |
| * {@link #enableCarMode(int, int)} to enable car mode. |
| * @hide |
| */ |
| @SystemApi |
| public static final int DEFAULT_PRIORITY = 0; |
| |
| /** |
| * Turn off special mode if currently in car mode. |
| * @param flags One of the disable car mode flags. |
| */ |
| public void disableCarMode(@DisableCarMode int flags) { |
| if (sGlobals != null) { |
| try { |
| sGlobals.mService.disableCarModeByCallingPackage(flags, |
| mContext == null ? null : mContext.getOpPackageName()); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| } |
| |
| /** |
| * Return the current running mode type. May be one of |
| * {@link Configuration#UI_MODE_TYPE_NORMAL Configuration.UI_MODE_TYPE_NORMAL}, |
| * {@link Configuration#UI_MODE_TYPE_DESK Configuration.UI_MODE_TYPE_DESK}, |
| * {@link Configuration#UI_MODE_TYPE_CAR Configuration.UI_MODE_TYPE_CAR}, |
| * {@link Configuration#UI_MODE_TYPE_TELEVISION Configuration.UI_MODE_TYPE_TELEVISION}, |
| * {@link Configuration#UI_MODE_TYPE_APPLIANCE Configuration.UI_MODE_TYPE_APPLIANCE}, |
| * {@link Configuration#UI_MODE_TYPE_WATCH Configuration.UI_MODE_TYPE_WATCH}, or |
| * {@link Configuration#UI_MODE_TYPE_VR_HEADSET Configuration.UI_MODE_TYPE_VR_HEADSET}. |
| */ |
| public int getCurrentModeType() { |
| if (sGlobals != null) { |
| try { |
| return sGlobals.mService.getCurrentModeType(); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return Configuration.UI_MODE_TYPE_NORMAL; |
| } |
| |
| /** |
| * Sets the system-wide night mode. |
| * <p> |
| * The mode can be one of: |
| * <ul> |
| * <li><em>{@link #MODE_NIGHT_NO}<em> sets the device into |
| * {@code notnight} mode</li> |
| * <li><em>{@link #MODE_NIGHT_YES}</em> sets the device into |
| * {@code night} mode</li> |
| * <li><em>{@link #MODE_NIGHT_CUSTOM}</em> automatically switches between |
| * {@code night} and {@code notnight} based on the custom time set (or default)</li> |
| * <li><em>{@link #MODE_NIGHT_AUTO}</em> automatically switches between |
| * {@code night} and {@code notnight} based on the device's current |
| * location and certain other sensors</li> |
| * </ul> |
| * <p> |
| * <strong>Note:</strong> On API 22 and below, changes to the night mode |
| * are only effective when the {@link Configuration#UI_MODE_TYPE_CAR car} |
| * or {@link Configuration#UI_MODE_TYPE_DESK desk} mode is enabled on a |
| * device. On API 23 through API 28, changes to night mode are always effective. |
| * <p> |
| * Starting in API 29, when the device is in car mode and this method is called, night mode |
| * will change, but the new setting is not persisted and the previously persisted setting |
| * will be restored when the device exits car mode. |
| * <p> |
| * Changes to night mode take effect globally and will result in a configuration change |
| * (and potentially an Activity lifecycle event) being applied to all running apps. |
| * Developers interested in an app-local implementation of night mode should consider using |
| * {@link #setApplicationNightMode(int)} to set and persist the -night qualifier locally or |
| * {@link androidx.appcompat.app.AppCompatDelegate#setDefaultNightMode(int)} for the |
| * backward compatible implementation. |
| * |
| * @param mode the night mode to set |
| * @see #getNightMode() |
| * @see #setApplicationNightMode(int) |
| */ |
| public void setNightMode(@NightMode int mode) { |
| if (sGlobals != null) { |
| try { |
| sGlobals.mService.setNightMode(mode); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| } |
| |
| /** |
| * Sets the current night mode to {@link #MODE_NIGHT_CUSTOM} with the custom night mode type |
| * {@code nightModeCustomType}. |
| * |
| * @param nightModeCustomType |
| * @throws IllegalArgumentException if passed an unsupported type to |
| * {@code nightModeCustomType}. |
| * @hide |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.MODIFY_DAY_NIGHT_MODE) |
| public void setNightModeCustomType(@NightModeCustomType int nightModeCustomType) { |
| if (sGlobals != null) { |
| try { |
| sGlobals.mService.setNightModeCustomType(nightModeCustomType); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| } |
| |
| /** |
| * Returns the custom night mode type. |
| * <p> |
| * If the current night mode is not {@link #MODE_NIGHT_CUSTOM}, returns |
| * {@link #MODE_NIGHT_CUSTOM_TYPE_UNKNOWN}. |
| * @hide |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.MODIFY_DAY_NIGHT_MODE) |
| public @NightModeCustomReturnType int getNightModeCustomType() { |
| if (sGlobals != null) { |
| try { |
| return sGlobals.mService.getNightModeCustomType(); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return MODE_NIGHT_CUSTOM_TYPE_UNKNOWN; |
| } |
| |
| /** |
| * Overlays current Attention mode Night Mode overlay. |
| * {@code attentionModeThemeOverlayType}. |
| * |
| * @throws IllegalArgumentException if passed an unsupported type to |
| * {@code AttentionModeThemeOverlayType}. |
| * @hide |
| */ |
| @FlaggedApi(Flags.FLAG_MODES_API) |
| @RequiresPermission(android.Manifest.permission.MODIFY_DAY_NIGHT_MODE) |
| public void setAttentionModeThemeOverlay( |
| @AttentionModeThemeOverlayType int attentionModeThemeOverlayType) { |
| if (sGlobals != null) { |
| try { |
| sGlobals.mService.setAttentionModeThemeOverlay(attentionModeThemeOverlayType); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| } |
| |
| /** |
| * Returns the currently configured Attention Mode theme overlay. |
| * <p> |
| * May be one of: |
| * <ul> |
| * <li>{@link #MODE_ATTENTION_THEME_OVERLAY_OFF}</li> |
| * <li>{@link #MODE_ATTENTION_THEME_OVERLAY_NIGHT}</li> |
| * <li>{@link #MODE_ATTENTION_THEME_OVERLAY_DAY}</li> |
| * <li>{@link #MODE_ATTENTION_THEME_OVERLAY_UNKNOWN}</li> |
| * </ul> |
| * </p> |
| * |
| * @hide |
| */ |
| @FlaggedApi(Flags.FLAG_MODES_API) |
| @TestApi |
| @RequiresPermission(android.Manifest.permission.MODIFY_DAY_NIGHT_MODE) |
| public @AttentionModeThemeOverlayReturnType int getAttentionModeThemeOverlay() { |
| if (sGlobals != null) { |
| try { |
| return sGlobals.mService.getAttentionModeThemeOverlay(); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return MODE_ATTENTION_THEME_OVERLAY_UNKNOWN; |
| } |
| |
| /** |
| * Sets and persist the night mode for this application. |
| * <p> |
| * The mode can be one of: |
| * <ul> |
| * <li><em>{@link #MODE_NIGHT_NO}<em> sets the device into |
| * {@code notnight} mode</li> |
| * <li><em>{@link #MODE_NIGHT_YES}</em> sets the device into |
| * {@code night} mode</li> |
| * <li><em>{@link #MODE_NIGHT_CUSTOM}</em> automatically switches between |
| * {@code night} and {@code notnight} based on the custom time set (or default)</li> |
| * <li><em>{@link #MODE_NIGHT_AUTO}</em> automatically switches between |
| * {@code night} and {@code notnight} based on the device's current |
| * location and certain other sensors</li> |
| * </ul> |
| * <p> |
| * Changes to night mode take effect locally and will result in a configuration change |
| * (and potentially an Activity lifecycle event) being applied to this application. The mode |
| * is persisted for this application until it is either modified by the application, the |
| * user clears the data for the application, or this application is uninstalled. |
| * <p> |
| * Developers interested in a non-persistent app-local implementation of night mode should |
| * consider using {@link androidx.appcompat.app.AppCompatDelegate#setDefaultNightMode(int)} |
| * to manage the -night qualifier locally. |
| * |
| * @param mode the night mode to set |
| * @see #setNightMode(int) |
| */ |
| public void setApplicationNightMode(@NightMode int mode) { |
| if (sGlobals != null) { |
| try { |
| sGlobals.mService.setApplicationNightMode(mode); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| } |
| |
| private Integer getNightModeFromServer() { |
| try { |
| if (sGlobals != null) { |
| return sGlobals.mService.getNightMode(); |
| } |
| return -1; |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| |
| |
| /** |
| * Retrieve the night mode for the user. |
| */ |
| private final IpcDataCache.QueryHandler<Void, Integer> mNightModeQuery = |
| new IpcDataCache.QueryHandler<>() { |
| |
| @Override |
| @NonNull |
| public Integer apply(Void query) { |
| return getNightModeFromServer(); |
| } |
| }; |
| |
| private static final String NIGHT_MODE_API = "getNightMode"; |
| |
| /** |
| * Cache the night mode for a user. |
| */ |
| private final IpcDataCache<Void, Integer> mNightModeCache = |
| new IpcDataCache<>(1, IpcDataCache.MODULE_SYSTEM, |
| NIGHT_MODE_API, /* cacheName= */ "NightModeCache", mNightModeQuery); |
| |
| /** |
| * Invalidate the night mode cache. |
| * |
| * @hide |
| */ |
| @FlaggedApi(Flags.FLAG_ENABLE_NIGHT_MODE_BINDER_CACHE) |
| public static void invalidateNightModeCache() { |
| IpcDataCache.invalidateCache(IpcDataCache.MODULE_SYSTEM, |
| NIGHT_MODE_API); |
| } |
| |
| /** |
| * Returns the currently configured night mode. |
| * <p> |
| * May be one of: |
| * <ul> |
| * <li>{@link #MODE_NIGHT_NO}</li> |
| * <li>{@link #MODE_NIGHT_YES}</li> |
| * <li>{@link #MODE_NIGHT_AUTO}</li> |
| * <li>{@link #MODE_NIGHT_CUSTOM}</li> |
| * <li>{@code -1} on error</li> |
| * </ul> |
| * |
| * @return the current night mode, or {@code -1} on error |
| * @see #setNightMode(int) |
| */ |
| public @NightMode int getNightMode() { |
| if (enableNightModeBinderCache()) { |
| return mNightModeCache.query(null); |
| } else { |
| return getNightModeFromServer(); |
| } |
| } |
| |
| /** |
| * @return If UI mode is locked or not. When UI mode is locked, calls to change UI mode |
| * like {@link #enableCarMode(int)} will silently fail. |
| * @hide |
| */ |
| @TestApi |
| public boolean isUiModeLocked() { |
| if (sGlobals != null) { |
| try { |
| return sGlobals.mService.isUiModeLocked(); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return true; |
| } |
| |
| /** |
| * Returns whether night mode is locked or not. |
| * <p> |
| * When night mode is locked, only privileged system components may change |
| * night mode and calls from non-privileged applications to change night |
| * mode will fail silently. |
| * |
| * @return {@code true} if night mode is locked or {@code false} otherwise |
| * @hide |
| */ |
| @TestApi |
| public boolean isNightModeLocked() { |
| if (sGlobals != null) { |
| try { |
| return sGlobals.mService.isNightModeLocked(); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return true; |
| } |
| |
| /** |
| * [De]activating night mode for the current user if the current night mode is custom and the |
| * custom type matches {@code nightModeCustomType}. |
| * |
| * @param nightModeCustomType the specify type of custom mode |
| * @param active {@code true} to activate night mode. Otherwise, deactivate night mode |
| * @return {@code true} if night mode has successfully activated for the requested |
| * {@code nightModeCustomType}. |
| * @hide |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.MODIFY_DAY_NIGHT_MODE) |
| public boolean setNightModeActivatedForCustomMode(@NightModeCustomType int nightModeCustomType, |
| boolean active) { |
| if (sGlobals != null) { |
| try { |
| return sGlobals.mService.setNightModeActivatedForCustomMode( |
| nightModeCustomType, active); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return false; |
| } |
| |
| /** |
| * Activating night mode for the current user |
| * |
| * @return {@code true} if the change is successful |
| * @hide |
| */ |
| @RequiresPermission(android.Manifest.permission.MODIFY_DAY_NIGHT_MODE) |
| public boolean setNightModeActivated(boolean active) { |
| if (sGlobals != null) { |
| try { |
| return sGlobals.mService.setNightModeActivated(active); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return false; |
| } |
| |
| /** |
| * Returns the time of the day Dark theme activates |
| * <p> |
| * When night mode is {@link #MODE_NIGHT_CUSTOM}, the system uses |
| * this time set to activate it automatically. |
| */ |
| @NonNull |
| public LocalTime getCustomNightModeStart() { |
| if (sGlobals != null) { |
| try { |
| return LocalTime.ofNanoOfDay(sGlobals.mService.getCustomNightModeStart() * 1000); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return LocalTime.MIDNIGHT; |
| } |
| |
| /** |
| * Sets the time of the day Dark theme activates |
| * <p> |
| * When night mode is {@link #MODE_NIGHT_CUSTOM}, the system uses |
| * this time set to activate it automatically |
| * @param time The time of the day Dark theme should activate |
| */ |
| public void setCustomNightModeStart(@NonNull LocalTime time) { |
| if (sGlobals != null) { |
| try { |
| sGlobals.mService.setCustomNightModeStart(time.toNanoOfDay() / 1000); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| } |
| |
| /** |
| * Returns the time of the day Dark theme deactivates |
| * <p> |
| * When night mode is {@link #MODE_NIGHT_CUSTOM}, the system uses |
| * this time set to deactivate it automatically. |
| */ |
| @NonNull |
| public LocalTime getCustomNightModeEnd() { |
| if (sGlobals != null) { |
| try { |
| return LocalTime.ofNanoOfDay(sGlobals.mService.getCustomNightModeEnd() * 1000); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return LocalTime.MIDNIGHT; |
| } |
| |
| /** |
| * Sets the time of the day Dark theme deactivates |
| * <p> |
| * When night mode is {@link #MODE_NIGHT_CUSTOM}, the system uses |
| * this time set to deactivate it automatically. |
| * @param time The time of the day Dark theme should deactivate |
| */ |
| public void setCustomNightModeEnd(@NonNull LocalTime time) { |
| if (sGlobals != null) { |
| try { |
| sGlobals.mService.setCustomNightModeEnd(time.toNanoOfDay() / 1000); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| } |
| |
| /** |
| * Indicates no projection type. Can be used to compare with the {@link ProjectionType} in |
| * {@link OnProjectionStateChangedListener#onProjectionStateChanged(int, Set)}. |
| * |
| * @hide |
| */ |
| @SystemApi |
| @TestApi |
| public static final int PROJECTION_TYPE_NONE = 0x0000; |
| /** |
| * Automotive projection prevents degradation of GPS to save battery, routes incoming calls to |
| * the automotive role holder, etc. For use with {@link #requestProjection(int)} and |
| * {@link #clearProjectionState(int)}. |
| * |
| * @hide |
| */ |
| @SystemApi |
| @TestApi |
| public static final int PROJECTION_TYPE_AUTOMOTIVE = 0x0001; |
| /** |
| * Indicates all projection types. For use with |
| * {@link #addOnProjectionStateChangedListener(int, Executor, OnProjectionStateChangedListener)} |
| * and {@link #getProjectingPackages(int)}. |
| * |
| * @hide |
| */ |
| @SystemApi |
| @TestApi |
| public static final int PROJECTION_TYPE_ALL = -1; // All bits on |
| |
| /** @hide */ |
| @IntDef(prefix = {"PROJECTION_TYPE_"}, value = { |
| PROJECTION_TYPE_NONE, |
| PROJECTION_TYPE_AUTOMOTIVE, |
| PROJECTION_TYPE_ALL, |
| }) |
| @Retention(RetentionPolicy.SOURCE) |
| public @interface ProjectionType { |
| } |
| |
| /** |
| * Sets the given {@link ProjectionType}. |
| * |
| * Caller must have {@link android.Manifest.permission.TOGGLE_AUTOMOTIVE_PROJECTION} if |
| * argument is {@link #PROJECTION_TYPE_AUTOMOTIVE}. |
| * @param projectionType the type of projection to request. This must be a single |
| * {@link ProjectionType} and cannot be a bitmask. |
| * @return true if the projection was successfully set |
| * @throws IllegalArgumentException if passed {@link #PROJECTION_TYPE_NONE}, |
| * {@link #PROJECTION_TYPE_ALL}, or any combination of more than one {@link ProjectionType}. |
| * |
| * @hide |
| */ |
| @SystemApi |
| @TestApi |
| @RequiresPermission(value = android.Manifest.permission.TOGGLE_AUTOMOTIVE_PROJECTION, |
| conditional = true) |
| public boolean requestProjection(@ProjectionType int projectionType) { |
| if (sGlobals != null) { |
| try { |
| return sGlobals.mService.requestProjection(new Binder(), projectionType, |
| mContext.getOpPackageName()); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return false; |
| } |
| |
| /** |
| * Releases the given {@link ProjectionType}. |
| * |
| * Caller must have {@link android.Manifest.permission.TOGGLE_AUTOMOTIVE_PROJECTION} if |
| * argument is {@link #PROJECTION_TYPE_AUTOMOTIVE}. |
| * @param projectionType the type of projection to release. This must be a single |
| * {@link ProjectionType} and cannot be a bitmask. |
| * @return true if the package had set projection and it was successfully released |
| * @throws IllegalArgumentException if passed {@link #PROJECTION_TYPE_NONE}, |
| * {@link #PROJECTION_TYPE_ALL}, or any combination of more than one {@link ProjectionType}. |
| * |
| * @hide |
| */ |
| @SystemApi |
| @TestApi |
| @RequiresPermission(value = android.Manifest.permission.TOGGLE_AUTOMOTIVE_PROJECTION, |
| conditional = true) |
| public boolean releaseProjection(@ProjectionType int projectionType) { |
| if (sGlobals != null) { |
| try { |
| return sGlobals.mService.releaseProjection( |
| projectionType, mContext.getOpPackageName()); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return false; |
| } |
| |
| /** |
| * Gets the packages that are currently projecting. |
| * |
| * @param projectionType the {@link ProjectionType}s to consider when computing which packages |
| * are projecting. Use {@link #PROJECTION_TYPE_ALL} to get all projecting |
| * packages. |
| * |
| * @hide |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.READ_PROJECTION_STATE) |
| @NonNull |
| public Set<String> getProjectingPackages(@ProjectionType int projectionType) { |
| if (sGlobals != null) { |
| try { |
| return new ArraySet<>(sGlobals.mService.getProjectingPackages(projectionType)); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return Set.of(); |
| } |
| |
| /** |
| * Gets the {@link ProjectionType}s that are currently active. |
| * |
| * @hide |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.READ_PROJECTION_STATE) |
| public @ProjectionType int getActiveProjectionTypes() { |
| if (sGlobals != null) { |
| try { |
| return sGlobals.mService.getActiveProjectionTypes(); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| return PROJECTION_TYPE_NONE; |
| } |
| |
| /** |
| * Configures the listener to receive callbacks when the packages projecting using the given |
| * {@link ProjectionType}s change. |
| * |
| * @param projectionType one or more {@link ProjectionType}s to listen for changes regarding |
| * @param executor an {@link Executor} on which to invoke the callbacks |
| * @param listener the {@link OnProjectionStateChangedListener} to add |
| * |
| * @hide |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.READ_PROJECTION_STATE) |
| public void addOnProjectionStateChangedListener(@ProjectionType int projectionType, |
| @NonNull @CallbackExecutor Executor executor, |
| @NonNull OnProjectionStateChangedListener listener) { |
| synchronized (mLock) { |
| if (mProjectionStateListenerMap.containsKey(listener)) { |
| Slog.i(TAG, "Attempted to add listener that was already added."); |
| return; |
| } |
| if (sGlobals != null) { |
| InnerListener innerListener = new InnerListener(executor, listener, |
| mOnProjectionStateChangedListenerResourceManager); |
| try { |
| sGlobals.mService.addOnProjectionStateChangedListener( |
| innerListener, projectionType); |
| mProjectionStateListenerMap.put(listener, innerListener); |
| } catch (RemoteException e) { |
| mOnProjectionStateChangedListenerResourceManager.remove(innerListener); |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| } |
| } |
| |
| /** |
| * Removes the listener so it stops receiving updates for all {@link ProjectionType}s. |
| * |
| * @param listener the {@link OnProjectionStateChangedListener} to remove |
| * |
| * @hide |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.READ_PROJECTION_STATE) |
| public void removeOnProjectionStateChangedListener( |
| @NonNull OnProjectionStateChangedListener listener) { |
| synchronized (mLock) { |
| InnerListener innerListener = mProjectionStateListenerMap.get(listener); |
| if (innerListener == null) { |
| Slog.i(TAG, "Attempted to remove listener that was not added."); |
| return; |
| } |
| if (sGlobals != null) { |
| try { |
| sGlobals.mService.removeOnProjectionStateChangedListener(innerListener); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| mProjectionStateListenerMap.remove(listener); |
| mOnProjectionStateChangedListenerResourceManager.remove(innerListener); |
| } |
| } |
| |
| private static class InnerListener extends IOnProjectionStateChangedListener.Stub { |
| private final WeakReference<OnProjectionStateChangedListenerResourceManager> |
| mResourceManager; |
| |
| private InnerListener(@NonNull Executor executor, |
| @NonNull OnProjectionStateChangedListener outerListener, |
| @NonNull OnProjectionStateChangedListenerResourceManager resourceManager) { |
| resourceManager.put(this, executor, outerListener); |
| mResourceManager = new WeakReference<>(resourceManager); |
| } |
| |
| @Override |
| public void onProjectionStateChanged(int activeProjectionTypes, |
| List<String> projectingPackages) { |
| OnProjectionStateChangedListenerResourceManager resourceManager = |
| mResourceManager.get(); |
| if (resourceManager == null) { |
| Slog.w(TAG, "Can't execute onProjectionStateChanged, resource manager is gone."); |
| return; |
| } |
| |
| OnProjectionStateChangedListener outerListener = resourceManager.getOuterListener(this); |
| Executor executor = resourceManager.getExecutor(this); |
| if (outerListener == null || executor == null) { |
| Slog.w(TAG, "Can't execute onProjectionStatechanged, references are null."); |
| return; |
| } |
| |
| executor.execute(PooledLambda.obtainRunnable( |
| OnProjectionStateChangedListener::onProjectionStateChanged, |
| outerListener, |
| activeProjectionTypes, |
| new ArraySet<>(projectingPackages)).recycleOnUse()); |
| } |
| } |
| |
| /** |
| * Wrapper class that ensures we don't leak {@link Activity} or other large {@link Context} in |
| * which this {@link UiModeManager} resides if/when it ends without unregistering associated |
| * callback objects. |
| */ |
| private static class OnProjectionStateChangedListenerResourceManager { |
| private final Map<InnerListener, OnProjectionStateChangedListener> mOuterListenerMap = |
| new ArrayMap<>(1); |
| private final Map<InnerListener, Executor> mExecutorMap = new ArrayMap<>(1); |
| |
| void put(@NonNull InnerListener innerListener, @NonNull Executor executor, |
| OnProjectionStateChangedListener outerListener) { |
| mOuterListenerMap.put(innerListener, outerListener); |
| mExecutorMap.put(innerListener, executor); |
| } |
| |
| void remove(InnerListener innerListener) { |
| mOuterListenerMap.remove(innerListener); |
| mExecutorMap.remove(innerListener); |
| } |
| |
| OnProjectionStateChangedListener getOuterListener(@NonNull InnerListener innerListener) { |
| return mOuterListenerMap.get(innerListener); |
| } |
| |
| Executor getExecutor(@NonNull InnerListener innerListener) { |
| return mExecutorMap.get(innerListener); |
| } |
| } |
| |
| /** |
| * Returns the color contrast for the user. |
| * <p> |
| * <strong>Note:</strong> You need to query this only if your application is |
| * doing its own rendering and does not rely on the material rendering pipeline. |
| * </p> |
| * @return The color contrast, float in [-1, 1] where |
| * <ul> |
| * <li> 0 corresponds to the default contrast </li> |
| * <li> -1 corresponds to the minimum contrast </li> |
| * <li> 1 corresponds to the maximum contrast </li> |
| * </ul> |
| */ |
| @FloatRange(from = -1.0f, to = 1.0f) |
| public float getContrast() { |
| return sGlobals.getContrast(); |
| } |
| |
| /** |
| * Registers a {@link ContrastChangeListener} for the current user. |
| * |
| * @param executor The executor on which the listener should be called back. |
| * @param listener The listener. |
| */ |
| public void addContrastChangeListener( |
| @NonNull @CallbackExecutor Executor executor, |
| @NonNull ContrastChangeListener listener) { |
| Objects.requireNonNull(executor); |
| Objects.requireNonNull(listener); |
| sGlobals.addContrastChangeListener(listener, executor); |
| } |
| |
| /** |
| * Unregisters a {@link ContrastChangeListener} for the current user. |
| * If the listener was not registered, does nothing and returns. |
| * |
| * @param listener The listener to unregister. |
| */ |
| public void removeContrastChangeListener(@NonNull ContrastChangeListener listener) { |
| Objects.requireNonNull(listener); |
| sGlobals.removeContrastChangeListener(listener); |
| } |
| } |
