1 /* 2 * Copyright (C) 2016 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package android.car.settings; 18 19 import android.annotation.SystemApi; 20 import android.car.annotation.AddedInOrBefore; 21 import android.car.annotation.ApiRequirements; 22 import android.car.annotation.ApiRequirements.CarVersion; 23 import android.car.annotation.ApiRequirements.PlatformVersion; 24 25 /** 26 * System-level, car-related settings. 27 * 28 * @hide 29 */ 30 @SystemApi 31 public class CarSettings { 32 CarSettings()33 private CarSettings() { 34 throw new UnsupportedOperationException("this class only provide constants"); 35 } 36 37 /** 38 * Global car settings, containing preferences that always apply identically 39 * to all defined users. Applications can read these but are not allowed to write; 40 * like the "Secure" settings, these are for preferences that the user must 41 * explicitly modify through the system UI or specialized APIs for those values. 42 * 43 * <p>To read/write the global car settings, use {@link android.provider.Settings.Global} 44 * with the keys defined here. 45 * 46 * @hide 47 */ 48 @SystemApi 49 @AddedInOrBefore(majorVersion = 33) 50 public static final class Global { 51 Global()52 private Global() { 53 throw new UnsupportedOperationException("this class only provide constants"); 54 } 55 56 /** 57 * Whether default restrictions for users have been set. 58 * 59 * @hide 60 */ 61 @AddedInOrBefore(majorVersion = 33) 62 public static final String DEFAULT_USER_RESTRICTIONS_SET = 63 "android.car.DEFAULT_USER_RESTRICTIONS_SET"; 64 65 /** 66 * Developer settings String used to explicitly disable the instrumentation service (when 67 * set to {@code "true"}. 68 * 69 * @hide 70 */ 71 @AddedInOrBefore(majorVersion = 33) 72 public static final String DISABLE_INSTRUMENTATION_SERVICE = 73 "android.car.DISABLE_INSTRUMENTATION_SERVICE"; 74 75 /** 76 * Developer settings String used to explicitly enable the user switch message when 77 * set to {@code "true"}. 78 * 79 * @hide 80 */ 81 @AddedInOrBefore(majorVersion = 33) 82 public static final String ENABLE_USER_SWITCH_DEVELOPER_MESSAGE = 83 "android.car.ENABLE_USER_SWITCH_DEVELOPER_MESSAGE"; 84 85 /** 86 * User id of the last foreground user 87 * 88 * @hide 89 */ 90 @AddedInOrBefore(majorVersion = 33) 91 public static final String LAST_ACTIVE_USER_ID = 92 "android.car.LAST_ACTIVE_USER_ID"; 93 94 /** 95 * User id of the last persistent (i.e, not counting ephemeral guests) foreground user 96 * 97 * @hide 98 */ 99 @AddedInOrBefore(majorVersion = 33) 100 public static final String LAST_ACTIVE_PERSISTENT_USER_ID = 101 "android.car.LAST_ACTIVE_PERSISTENT_USER_ID"; 102 103 /** 104 * Defines global runtime overrides to system bar policy. 105 * <p> 106 * See {@link com.android.systemui.wm.BarControlPolicy} for value format. 107 * 108 * @hide 109 */ 110 @AddedInOrBefore(majorVersion = 33) 111 public static final String SYSTEM_BAR_VISIBILITY_OVERRIDE = 112 "android.car.SYSTEM_BAR_VISIBILITY_OVERRIDE"; 113 114 /** 115 * Defines non-current visible users to assign per each occupant zone. 116 * 117 * <p>The value of this will be a ',' separated list of zoneId:userId. zoneId and userId 118 * should be a string of decimal integer. Example can be "1:10,2:11" where zone 1 has 119 * user 10 and zone 2 has user 11 allocated. 120 * 121 * <p>When system boots up, car service will allocate those users to the specified zones. 122 * If any entry in the value is invalid or if there are duplicate entries, the value will be 123 * ignored and no user will be assigned. 124 * 125 * @hide 126 */ 127 @SystemApi 128 @ApiRequirements(minCarVersion = ApiRequirements.CarVersion.UPSIDE_DOWN_CAKE_0, 129 minPlatformVersion = ApiRequirements.PlatformVersion.UPSIDE_DOWN_CAKE_0) 130 public static final String GLOBAL_VISIBLE_USER_ALLOCATION_PER_ZONE = 131 "android.car.GLOBAL_VISIBLE_USER_ALLOCATION_PER_ZONE"; 132 133 /** 134 * Defines passenger displays to lock their touch input. 135 * 136 * <p> The value of this will be a ',' separated list of display's unique id. For example, 137 * "local:4630946674560563248,local:4630946674560563349" with input lock enabled for both 138 * displays. 139 * 140 * <p> Input lock will be applied to those passenger displays. If any entry in the value 141 * is invalid, then the invalid entry is ignored. If there are duplicate entries, then 142 * only one entry is valid and the other duplicates are ignored. 143 * 144 * @hide 145 */ 146 @SystemApi 147 @ApiRequirements(minCarVersion = ApiRequirements.CarVersion.UPSIDE_DOWN_CAKE_0, 148 minPlatformVersion = ApiRequirements.PlatformVersion.UPSIDE_DOWN_CAKE_0) 149 public static final String DISPLAY_INPUT_LOCK = 150 "android.car.DISPLAY_INPUT_LOCK"; 151 152 /** 153 * Defines display power mode to assign per each display. 154 * 155 * <p>The value of this will be a ',' separated list of displayPort:mode. 156 * display port and mode should be a string of decimal integer. 157 * Example can be "0:2,1:0,2:1" where display 0 set mode 2, display 1 set mode 0 158 * and display 2 set mode 1 allocated. 159 * 160 * <p>When system boots up, car service will set those modes to the specified displays. 161 * If any entry in the value is invalid, the value will be ignored and no mode will be set. 162 * If there are duplicate entries, the last entry will be applied. 163 * 164 * <p>The mode is an integer (0, 1 or 2) where: 165 * <ul> 166 * <li>0 indicates OFF should applied to intentionally turn off the display and not be 167 * allowed to manually turn on the display 168 * <li>1 indicates ON should be applied to screen off timeout and allowed to manually turn 169 * off the display. 170 * <li>2 indicates ALWAYS ON should be applied to keep the display on and allowed to 171 * manually turn off the display 172 * </ul> 173 * 174 * @hide 175 */ 176 @SystemApi 177 @ApiRequirements(minCarVersion = ApiRequirements.CarVersion.UPSIDE_DOWN_CAKE_0, 178 minPlatformVersion = ApiRequirements.PlatformVersion.UPSIDE_DOWN_CAKE_0) 179 public static final String DISPLAY_POWER_MODE = "android.car.DISPLAY_POWER_MODE"; 180 } 181 182 /** 183 * Default garage mode wake up time 00:00 184 * 185 * @hide 186 */ 187 @AddedInOrBefore(majorVersion = 33) 188 public static final int[] DEFAULT_GARAGE_MODE_WAKE_UP_TIME = {0, 0}; 189 190 /** 191 * Default garage mode maintenance window 10 mins. 192 * 193 * @hide 194 */ 195 @AddedInOrBefore(majorVersion = 33) 196 public static final int DEFAULT_GARAGE_MODE_MAINTENANCE_WINDOW = 10 * 60 * 1000; // 10 mins 197 198 /** 199 * @hide 200 */ 201 @SystemApi 202 public static final class Secure { 203 Secure()204 private Secure() { 205 throw new UnsupportedOperationException("this class only provide constants"); 206 } 207 208 /** 209 * Key to indicate whether audio focus requests for 210 * {@link android.hardware.automotive.audiocontrol.V1_0.ContextNumber.NAVIGATION} should 211 * be rejected if focus is currently held by 212 * {@link android.hardware.automotive.audiocontrol.V1_0.ContextNumber.CALL}. 213 * <p>The value is a boolean (1 or 0) where: 214 * <ul> 215 * <li>1 indicates {@code NAVIGATION} should be rejected when a {@code CALL} is in progress. 216 * <li>0 indicates {@code NAVIGATION} and {@code CALL} should be allowed to hold focus 217 * concurrently. 218 * </ul> 219 * 220 * <p>Recommended {@code false} as default value. 221 * 222 * @hide 223 */ 224 @SystemApi 225 @AddedInOrBefore(majorVersion = 33) 226 public static final String KEY_AUDIO_FOCUS_NAVIGATION_REJECTED_DURING_CALL = 227 "android.car.KEY_AUDIO_FOCUS_NAVIGATION_REJECTED_DURING_CALL"; 228 229 /** 230 * Key to indicate if mute state should be persisted across boot cycles. 231 * <p>The value is a boolean (1 or 0) where: 232 * <ul> 233 * <li>1 indicates volume group mute states should be persisted across boot cycles. 234 * <li>0 indicates volume group mute states should not be persisted across boot cycles. 235 * </ul> 236 * 237 * @hide 238 */ 239 @SystemApi 240 @AddedInOrBefore(majorVersion = 33) 241 public static final String KEY_AUDIO_PERSIST_VOLUME_GROUP_MUTE_STATES = 242 "android.car.KEY_AUDIO_PERSIST_VOLUME_GROUP_MUTE_STATES"; 243 244 /** 245 * Key for a list of devices to automatically connect on Bluetooth. 246 * Written to and read by {@link com.android.car.BluetoothDeviceManager} 247 * 248 * @hide 249 */ 250 @AddedInOrBefore(majorVersion = 33) 251 public static final String KEY_BLUETOOTH_DEVICES = 252 "android.car.KEY_BLUETOOTH_DEVICES"; 253 254 /** 255 * Key for storing temporarily-disconnected devices and profiles. 256 * Read and written by {@link com.android.car.BluetoothProfileInhibitManager}. 257 * 258 * @hide 259 */ 260 @AddedInOrBefore(majorVersion = 33) 261 public static final String KEY_BLUETOOTH_PROFILES_INHIBITED = 262 "android.car.BLUETOOTH_PROFILES_INHIBITED"; 263 264 /** 265 * Key to enable / disable rotary key event filtering. When enabled, a USB keyboard can be 266 * used as a stand-in for a rotary controller. 267 * The value is boolean (1 or 0). 268 * 269 * @hide 270 */ 271 @SystemApi 272 @AddedInOrBefore(majorVersion = 33) 273 public static final String KEY_ROTARY_KEY_EVENT_FILTER = 274 "android.car.ROTARY_KEY_EVENT_FILTER"; 275 276 /** 277 * Key to enable / disable initial notice screen that will be shown for all user-starting 278 * moments including cold boot, wake up from suspend, and user switching. 279 * The value is boolean (1 or 0). 280 * 281 * @hide 282 */ 283 @SystemApi 284 @AddedInOrBefore(majorVersion = 33) 285 public static final String KEY_ENABLE_INITIAL_NOTICE_SCREEN_TO_USER = 286 "android.car.ENABLE_INITIAL_NOTICE_SCREEN_TO_USER"; 287 288 /** 289 * Key to indicate Setup Wizard is in progress. It differs from USER_SETUP_COMPLETE in 290 * that this flag can be reset to 0 in deferred Setup Wizard flow. 291 * The value is boolean (1 or 0). 292 * 293 * @hide 294 */ 295 @SystemApi 296 @AddedInOrBefore(majorVersion = 33) 297 public static final String KEY_SETUP_WIZARD_IN_PROGRESS = 298 "android.car.SETUP_WIZARD_IN_PROGRESS"; 299 300 /** 301 * Key for a {@code ;} separated list of packages disabled on resource overuse. 302 * 303 * <p>The value is written by {@link com.android.car.watchdog.CarWatchdogService}. 304 * 305 * <p>The value is read by user interfaces (such as launcher) that show applications 306 * disabled on resource overuse. When a user selects any application from this list, 307 * the user interface should either enable the application immediately or provide user 308 * affordance to enable the application when the driving conditions are safe. 309 * 310 * <p>When an application (which is on this list) is enabled, CarService will immediately 311 * remove the application's package name form the list. 312 * 313 * @hide 314 */ 315 @SystemApi 316 @AddedInOrBefore(majorVersion = 33) 317 public static final String KEY_PACKAGES_DISABLED_ON_RESOURCE_OVERUSE = 318 "android.car.KEY_PACKAGES_DISABLED_ON_RESOURCE_OVERUSE"; 319 320 /** 321 * Key for an int value to indicate whether the user has accepted the Terms of 322 * Service. 323 * 324 * <p>The value is an int value where: 325 * <ul> 326 * <li>0 - the acceptance value is unknown. In this case, functionality 327 * should not be restricted. 328 * <li>1 - the acceptance value is {@code false}. In this case, some system 329 * functionality is restricted. 330 * <li>2 - the acceptance value is {@code true}. In this case, system functionality is 331 * not restricted. 332 * </ul> 333 * 334 * <p>Recommended 0 as default value. 335 * 336 * @hide 337 */ 338 @SystemApi 339 @ApiRequirements(minCarVersion = CarVersion.UPSIDE_DOWN_CAKE_0, 340 minPlatformVersion = PlatformVersion.UPSIDE_DOWN_CAKE_0) 341 public static final String KEY_USER_TOS_ACCEPTED = "android.car.KEY_USER_TOS_ACCEPTED"; 342 343 344 /** 345 * Key for a string value to indicate which apps are disabled because the 346 * user has not accepted the Terms of Service. 347 * 348 * <p>The value is a string value of comma-separated package names. For example, 349 * {@code "com.company.maps,com.company.voiceassistant,com.company.appstore"} 350 * 351 * <p>Recommended "" as default value. 352 * 353 * @hide 354 */ 355 @SystemApi 356 @ApiRequirements(minCarVersion = CarVersion.UPSIDE_DOWN_CAKE_0, 357 minPlatformVersion = PlatformVersion.UPSIDE_DOWN_CAKE_0) 358 public static final String KEY_UNACCEPTED_TOS_DISABLED_APPS = 359 "android.car.KEY_UNACCEPTED_TOS_DISABLED_APPS"; 360 361 /** 362 * Defines non-current visible users to assign per each occupant zone. 363 * 364 * <p>For the format of the value, check {@link Global#VISIBLE_USER_ALLOCATION_PER_ZONE}. 365 * This is per user setting and system will apply this when this user is the 366 * current user during the boot up. 367 * 368 * <p>If both {@link Global#VISIBLE_USER_ALLOCATION_PER_ZONE} and this value is 369 * set, this value will be used and {@link Global#VISIBLE_USER_ALLOCATION_PER_ZONE} will 370 * be ignored. 371 * 372 * @hide 373 */ 374 @SystemApi 375 @ApiRequirements(minCarVersion = ApiRequirements.CarVersion.UPSIDE_DOWN_CAKE_0, 376 minPlatformVersion = ApiRequirements.PlatformVersion.UPSIDE_DOWN_CAKE_0) 377 public static final String VISIBLE_USER_ALLOCATION_PER_ZONE = 378 "android.car.VISIBLE_USER_ALLOCATION_PER_ZONE"; 379 380 /** 381 * Key to indicate whether to allow the driver user to allow controlling media sessions of 382 * a passenger user. 383 * 384 * <p>This is per user setting and the drvier's Media Control Center app will query this 385 * to check whether it can connect/control other user's media session. 386 * The value type is boolean (1 for true, or 0 for false. false by default). 387 * 388 * @hide 389 */ 390 @SystemApi 391 @ApiRequirements(minCarVersion = ApiRequirements.CarVersion.UPSIDE_DOWN_CAKE_0, 392 minPlatformVersion = ApiRequirements.PlatformVersion.UPSIDE_DOWN_CAKE_0) 393 public static final String KEY_DRIVER_ALLOWED_TO_CONTROL_MEDIA = 394 "android.car.DRIVER_ALLOWED_TO_CONTROL_MEDIA"; 395 } 396 }