1 /*
2  * Copyright 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  * {@hide}
21  */
22 
23 interface IExternalVibrationController {
24     /**
25      * A method to ask a currently playing vibration to mute (i.e. not vibrate).
26      *
27      * This method is only valid from the time that
28      * {@link IExternalVibratorService#onExternalVibrationStart} returns until
29      * {@link IExternalVibratorService#onExternalVibrationStop} returns.
30      *
31      * @return whether the mute operation was successful
32      */
mute()33     boolean mute();
34 
35     /**
36      * A method to ask a currently playing vibration to unmute (i.e. start vibrating).
37      *
38      * This method is only valid from the time that
39      * {@link IExternalVibratorService#onExternalVibrationStart} returns until
40      * {@link IExternalVibratorService#onExternalVibrationStop} returns.
41      *
42      * @return whether the unmute operation was successful
43      */
unmute()44     boolean unmute();
45 }
46