1 /*
2  * Copyright (C) 2023 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 com.android.server.vibrator;
18 
19 import android.os.VibrationEffect;
20 import android.os.VibratorInfo;
21 import android.os.vibrator.VibrationEffectSegment;
22 
23 import java.util.List;
24 
25 /** Adapts a sequence of {@link VibrationEffectSegment} to a vibrator. */
26 interface VibrationSegmentsAdapter {
27 
28     /**
29      * Add and/or remove segments to the given {@link VibrationEffectSegment} list based on the
30      * given {@link VibratorInfo}.
31      *
32      * <p>This returns the new {@code repeatIndex} to be used together with the updated list to
33      * specify an equivalent {@link VibrationEffect}.
34      *
35      * @param info        The vibrator info to be applied to the sequence of segments.
36      * @param segments    List of {@link VibrationEffectSegment} to be modified.
37      * @param repeatIndex Repeat index on the current segment list.
38      * @return The new repeat index on the modifies list.
39      */
adaptToVibrator(VibratorInfo info, List<VibrationEffectSegment> segments, int repeatIndex)40     int adaptToVibrator(VibratorInfo info, List<VibrationEffectSegment> segments, int repeatIndex);
41 }
42