Create CombinedVibrationEffect.aidl (6d062393) · Commits · e / os / android_frameworks_base

core/java/android/os/CombinedVibrationEffect.aidl

0 → 100644

+19 −0

Original line number	Diff line number	Diff line
		/*
		* 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;

		parcelable CombinedVibrationEffect;

core/java/android/os/CombinedVibrationEffect.java

0 → 100644

+150 −0

Original line number	Diff line number	Diff line
		/*
		* 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.annotation.NonNull;

		import java.util.Objects;

		/**
		* A CombinedVibrationEffect describes a haptic effect to be performed by one or more {@link
		* Vibrator Vibrators}.
		*
		* These effects may be any number of things, from single shot vibrations to complex waveforms.
		*
		* @hide
		* @see VibrationEffect
		*/
		public abstract class CombinedVibrationEffect implements Parcelable {
		private static final int PARCEL_TOKEN_MONO = 1;

		/** @hide to prevent subclassing from outside of the framework */
		public CombinedVibrationEffect() {
		}

		/**
		* Create a synced vibration effect.
		*
		* A synced vibration effect should be performed by multiple vibrators at the same time.
		*
		* @param effect The {@link VibrationEffect} to perform
		* @return The desired combined effect.
		*/
		@NonNull
		public static CombinedVibrationEffect createSynced(@NonNull VibrationEffect effect) {
		CombinedVibrationEffect combined = new Mono(effect);
		combined.validate();
		return combined;
		}

		@Override
		public int describeContents() {
		return 0;
		}

		/** @hide */
		public abstract void validate();

		/**
		* Represents a single {@link VibrationEffect} that should be executed in all vibrators in sync.
		*
		* @hide
		*/
		public static final class Mono extends CombinedVibrationEffect {
		private final VibrationEffect mEffect;

		public Mono(Parcel in) {
		mEffect = VibrationEffect.CREATOR.createFromParcel(in);
		}

		public Mono(@NonNull VibrationEffect effect) {
		mEffect = effect;
		}

		public VibrationEffect getEffect() {
		return mEffect;
		}

		/** @hide */
		@Override
		public void validate() {
		mEffect.validate();
		}

		@Override
		public boolean equals(Object o) {
		if (!(o instanceof CombinedVibrationEffect.Mono)) {
		return false;
		}
		CombinedVibrationEffect.Mono other = (CombinedVibrationEffect.Mono) o;
		return other.mEffect.equals(other.mEffect);
		}

		@Override
		public int hashCode() {
		return Objects.hash(mEffect);
		}

		@Override
		public String toString() {
		return "Mono{mEffect=" + mEffect + '}';
		}

		@Override
		public void writeToParcel(Parcel out, int flags) {
		out.writeInt(PARCEL_TOKEN_MONO);
		mEffect.writeToParcel(out, flags);
		}

		@NonNull
		public static final Parcelable.Creator<Mono> CREATOR =
		new Parcelable.Creator<Mono>() {
		@Override
		public Mono createFromParcel(@NonNull Parcel in) {
		// Skip the type token
		in.readInt();
		return new Mono(in);
		}

		@Override
		@NonNull
		public Mono[] newArray(int size) {
		return new Mono[size];
		}
		};
		}

		@NonNull
		public static final Parcelable.Creator<CombinedVibrationEffect> CREATOR =
		new Parcelable.Creator<CombinedVibrationEffect>() {
		@Override
		public CombinedVibrationEffect createFromParcel(Parcel in) {
		int token = in.readInt();
		if (token == PARCEL_TOKEN_MONO) {
		return new CombinedVibrationEffect.Mono(in);
		} else {
		throw new IllegalStateException(
		"Unexpected combined vibration event type token in parcel.");
		}
		}

		@Override
		public CombinedVibrationEffect[] newArray(int size) {
		return new CombinedVibrationEffect[size];
		}
		};
		}

core/java/android/os/IVibratorManagerService.aidl

+4 −0

Original line number	Diff line number	Diff line
		@@ -16,9 +16,13 @@

		package android.os;

		import android.os.CombinedVibrationEffect;
		import android.os.VibrationAttributes;

		/** {@hide} */
		interface IVibratorManagerService {
		int[] getVibratorIds();
		void vibrate(int uid, String opPkg, in CombinedVibrationEffect effect,
		in VibrationAttributes attributes, String reason, IBinder token);
		void cancelVibrate(IBinder token);
		}

core/java/android/os/VibrationEffect.java

+2 −0

Original line number	Diff line number	Diff line
		@@ -983,6 +983,8 @@ public abstract class VibrationEffect implements Parcelable {
		Composition.checkPrimitive(effect.id);
		Preconditions.checkArgumentInRange(
		effect.scale, 0.0f, 1.0f, "scale");
		Preconditions.checkArgumentNonNegative(effect.delay,
		"Primitive delay must be zero or positive");
		}
		}

core/tests/coretests/src/android/os/CombinedVibrationEffectTest.java

0 → 100644

+52 −0

Original line number	Diff line number	Diff line
		/*
		* 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 static junit.framework.Assert.assertEquals;

		import static org.testng.Assert.assertThrows;

		import android.platform.test.annotations.Presubmit;

		import org.junit.Test;
		import org.junit.runner.RunWith;
		import org.junit.runners.JUnit4;

		@Presubmit
		@RunWith(JUnit4.class)
		public class CombinedVibrationEffectTest {

		@Test
		public void testValidateMono() {
		CombinedVibrationEffect.createSynced(VibrationEffect.get(VibrationEffect.EFFECT_CLICK));

		assertThrows(IllegalArgumentException.class,
		() -> CombinedVibrationEffect.createSynced(new VibrationEffect.OneShot(-1, -1)));
		}

		@Test
		public void testSerializationMono() {
		CombinedVibrationEffect original = CombinedVibrationEffect.createSynced(
		VibrationEffect.get(VibrationEffect.EFFECT_CLICK));

		Parcel parcel = Parcel.obtain();
		original.writeToParcel(parcel, 0);
		parcel.setDataPosition(0);
		CombinedVibrationEffect restored = CombinedVibrationEffect.CREATOR.createFromParcel(parcel);
		assertEquals(original, restored);
		}
		}