/**
 * Copyright (c) 2020, 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.os;

import android.os.CombinedVibration;
import android.os.ICancellationSignal;
import android.os.IVibratorStateListener;
import android.os.VibrationAttributes;
import android.os.VibratorInfo;
import android.os.vibrator.IVibrationSession;
import android.os.vibrator.IVibrationSessionCallback;

/** @hide */
interface IVibratorManagerService {
    int[] getVibratorIds();
    int getCapabilities();
    VibratorInfo getVibratorInfo(int vibratorId);
    @EnforcePermission("ACCESS_VIBRATOR_STATE")
    boolean isVibrating(int vibratorId);
    @EnforcePermission("ACCESS_VIBRATOR_STATE")
    boolean registerVibratorStateListener(int vibratorId, in IVibratorStateListener listener);
    @EnforcePermission("ACCESS_VIBRATOR_STATE")
    boolean unregisterVibratorStateListener(int vibratorId, in IVibratorStateListener listener);
    boolean setAlwaysOnEffect(int uid, String opPkg, int alwaysOnId,
            in CombinedVibration vibration, in VibrationAttributes attributes);
    void vibrate(int uid, int deviceId, String opPkg, in CombinedVibration vibration,
            in VibrationAttributes attributes, String reason, IBinder token);
    void cancelVibrate(int usageFilter, IBinder token);

    // Async oneway APIs.
    // There is no order guarantee with respect to the two-way APIs above like
    // vibrate/isVibrating/cancel.
    oneway void performHapticFeedback(int uid, int deviceId, String opPkg, int constant,
            int usage, String reason, int flags, int privFlags);

    // Similar to performHapticFeedback but the effect is customized to the input device. The
    // customization for each constant is defined on a device basis, and the behavior will be the
    // same as performHapticFeedback when no customization is provided for a given constant and
    // device.
    oneway void performHapticFeedbackForInputDevice(int uid, int deviceId, String opPkg,
            int constant, int inputDeviceId, int inputSource, String reason, int flags,
            int privFlags);

    @EnforcePermission(allOf={"VIBRATE", "VIBRATE_VENDOR_EFFECTS", "START_VIBRATION_SESSIONS"})
    ICancellationSignal startVendorVibrationSession(int uid, int deviceId, String opPkg,
            in int[] vibratorIds, in VibrationAttributes attributes, String reason,
            in IVibrationSessionCallback callback);
}