1 /** 2 * Copyright (c) 2018, 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.os; 18 19 /** 20 * ExternalVibrationScale holds the vibration scale level and adaptive haptics scale. These 21 * can be used to scale external vibrations. 22 * 23 * @hide 24 */ 25 parcelable ExternalVibrationScale { 26 @Backing(type="int") 27 enum ScaleLevel { 28 SCALE_MUTE = -100, 29 SCALE_VERY_LOW = -2, 30 SCALE_LOW = -1, 31 SCALE_NONE = 0, 32 SCALE_HIGH = 1, 33 SCALE_VERY_HIGH = 2 34 } 35 36 // TODO(b/345186129): remove this once we finish migrating to scale factor. 37 /** 38 * The scale level that will be applied to external vibrations. 39 */ 40 ScaleLevel scaleLevel = ScaleLevel.SCALE_NONE; 41 42 /** 43 * The scale factor that will be applied to external vibrations. 44 * 45 * Values in (0,1) will scale down the vibrations, values > 1 will scale up vibrations within 46 * hardware limits. A zero scale factor indicates the external vibration should be muted. 47 * 48 * TODO(b/345186129): update this once we finish migrating, negative should not be expected. 49 * Negative values should be ignored in favour of the legacy ScaleLevel. 50 */ 51 float scaleFactor = -1f; // undefined 52 53 /** 54 * The adaptive haptics scale that will be applied to external vibrations. 55 */ 56 float adaptiveHapticsScale = 1f; 57 } 58