vibrator/1.2/types.hal

/*
 * Copyright (C) 2018 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.hardware.vibrator@1.2;

import @1.1::Effect_1_1;

// Note that while the previous type had a version suffix, this type does not. This is because the
// versions are already present in the namespace and thus don't need to also be embedded in the
// name of the type.
enum Effect : @1.1::Effect_1_1 {
     /**
      * A thud effect.
      *
      * This effect should solid feeling bump, like the depression of a heavy mechanical button.
      */
     THUD,
     /**
      * A pop effect.
      *
      * A short, quick burst effect.
      */
     POP,

     /**
      * A heavy click effect.
      *
      * This should produce a sharp striking sensation, like a click but stronger.
      */
     HEAVY_CLICK,

     /**
      * Ringtone patterns. They may correspond with the device's ringtone audio, or may just be a
      * pattern that can be played as a ringtone with any audio, depending on the device.
      */
     RINGTONE_1,
     RINGTONE_2,
     RINGTONE_3,
     RINGTONE_4,
     RINGTONE_5,
     RINGTONE_6,
     RINGTONE_7,
     RINGTONE_8,
     RINGTONE_9,
     RINGTONE_10,
     RINGTONE_11,
     RINGTONE_12,
     RINGTONE_13,
     RINGTONE_14,
     RINGTONE_15,
};