Merge "Use VirtualInputDeviceConfig subclasses to create virtual input devices." (8d4b0389) · Commits · e / os / android_frameworks_base

core/api/system-current.txt

+72 −4

Original line number	Diff line number	Diff line
		@@ -2988,10 +2988,13 @@ package android.companion.virtual {
		method @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.companion.virtual.audio.VirtualAudioDevice createVirtualAudioDevice(@NonNull android.hardware.display.VirtualDisplay, @Nullable java.util.concurrent.Executor, @Nullable android.companion.virtual.audio.VirtualAudioDevice.AudioConfigurationChangeCallback);
		method @Nullable public android.hardware.display.VirtualDisplay createVirtualDisplay(@IntRange(from=1) int, @IntRange(from=1) int, @IntRange(from=1) int, @Nullable android.view.Surface, int, @Nullable java.util.concurrent.Executor, @Nullable android.hardware.display.VirtualDisplay.Callback);
		method @Nullable public android.hardware.display.VirtualDisplay createVirtualDisplay(@IntRange(from=1) int, @IntRange(from=1) int, @IntRange(from=1) int, @NonNull java.util.List<java.lang.String>, @Nullable android.view.Surface, int, @Nullable java.util.concurrent.Executor, @Nullable android.hardware.display.VirtualDisplay.Callback);
		method @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.hardware.input.VirtualDpad createVirtualDpad(@NonNull android.hardware.display.VirtualDisplay, @NonNull String, int, int);
		method @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.hardware.input.VirtualKeyboard createVirtualKeyboard(@NonNull android.hardware.display.VirtualDisplay, @NonNull String, int, int);
		method @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.hardware.input.VirtualMouse createVirtualMouse(@NonNull android.hardware.display.VirtualDisplay, @NonNull String, int, int);
		method @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.hardware.input.VirtualTouchscreen createVirtualTouchscreen(@NonNull android.hardware.display.VirtualDisplay, @NonNull String, int, int);
		method @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.hardware.input.VirtualDpad createVirtualDpad(@NonNull android.hardware.input.VirtualDpadConfig);
		method @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.hardware.input.VirtualKeyboard createVirtualKeyboard(@NonNull android.hardware.input.VirtualKeyboardConfig);
		method @Deprecated @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.hardware.input.VirtualKeyboard createVirtualKeyboard(@NonNull android.hardware.display.VirtualDisplay, @NonNull String, int, int);
		method @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.hardware.input.VirtualMouse createVirtualMouse(@NonNull android.hardware.input.VirtualMouseConfig);
		method @Deprecated @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.hardware.input.VirtualMouse createVirtualMouse(@NonNull android.hardware.display.VirtualDisplay, @NonNull String, int, int);
		method @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.hardware.input.VirtualTouchscreen createVirtualTouchscreen(@NonNull android.hardware.input.VirtualTouchscreenConfig);
		method @Deprecated @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.hardware.input.VirtualTouchscreen createVirtualTouchscreen(@NonNull android.hardware.display.VirtualDisplay, @NonNull String, int, int);
		method public int getDeviceId();
		method @Nullable public android.companion.virtual.sensor.VirtualSensor getVirtualSensor(int, @NonNull String);
		method public void launchPendingIntent(int, @NonNull android.app.PendingIntent, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.IntConsumer);
		@@ -4638,6 +4641,34 @@ package android.hardware.input {
		method @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void sendKeyEvent(@NonNull android.hardware.input.VirtualKeyEvent);
		}

		public final class VirtualDpadConfig extends android.hardware.input.VirtualInputDeviceConfig implements android.os.Parcelable {
		method public int describeContents();
		method public void writeToParcel(@NonNull android.os.Parcel, int);
		field @NonNull public static final android.os.Parcelable.Creator<android.hardware.input.VirtualDpadConfig> CREATOR;
		}

		public static final class VirtualDpadConfig.Builder extends android.hardware.input.VirtualInputDeviceConfig.Builder<android.hardware.input.VirtualDpadConfig.Builder> {
		ctor public VirtualDpadConfig.Builder();
		method @NonNull public android.hardware.input.VirtualDpadConfig build();
		}

		public abstract class VirtualInputDeviceConfig {
		ctor protected VirtualInputDeviceConfig(@NonNull android.hardware.input.VirtualInputDeviceConfig.Builder<? extends android.hardware.input.VirtualInputDeviceConfig.Builder<?>>);
		ctor protected VirtualInputDeviceConfig(@NonNull android.os.Parcel);
		method public int getAssociatedDisplayId();
		method @NonNull public String getInputDeviceName();
		method public int getProductId();
		method public int getVendorId();
		}

		public abstract static class VirtualInputDeviceConfig.Builder<T extends android.hardware.input.VirtualInputDeviceConfig.Builder<T>> {
		ctor public VirtualInputDeviceConfig.Builder();
		method @NonNull public T setAssociatedDisplayId(int);
		method @NonNull public T setInputDeviceName(@NonNull String);
		method @NonNull public T setProductId(int);
		method @NonNull public T setVendorId(int);
		}

		public final class VirtualKeyEvent implements android.os.Parcelable {
		method public int describeContents();
		method public int getAction();
		@@ -4660,6 +4691,17 @@ package android.hardware.input {
		method @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void sendKeyEvent(@NonNull android.hardware.input.VirtualKeyEvent);
		}

		public final class VirtualKeyboardConfig extends android.hardware.input.VirtualInputDeviceConfig implements android.os.Parcelable {
		method public int describeContents();
		method public void writeToParcel(@NonNull android.os.Parcel, int);
		field @NonNull public static final android.os.Parcelable.Creator<android.hardware.input.VirtualKeyboardConfig> CREATOR;
		}

		public static final class VirtualKeyboardConfig.Builder extends android.hardware.input.VirtualInputDeviceConfig.Builder<android.hardware.input.VirtualKeyboardConfig.Builder> {
		ctor public VirtualKeyboardConfig.Builder();
		method @NonNull public android.hardware.input.VirtualKeyboardConfig build();
		}

		public class VirtualMouse implements java.io.Closeable {
		method @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void close();
		method @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.graphics.PointF getCursorPosition();
		@@ -4690,6 +4732,17 @@ package android.hardware.input {
		method @NonNull public android.hardware.input.VirtualMouseButtonEvent.Builder setButtonCode(int);
		}

		public final class VirtualMouseConfig extends android.hardware.input.VirtualInputDeviceConfig implements android.os.Parcelable {
		method public int describeContents();
		method public void writeToParcel(@NonNull android.os.Parcel, int);
		field @NonNull public static final android.os.Parcelable.Creator<android.hardware.input.VirtualMouseConfig> CREATOR;
		}

		public static final class VirtualMouseConfig.Builder extends android.hardware.input.VirtualInputDeviceConfig.Builder<android.hardware.input.VirtualMouseConfig.Builder> {
		ctor public VirtualMouseConfig.Builder();
		method @NonNull public android.hardware.input.VirtualMouseConfig build();
		}

		public final class VirtualMouseRelativeEvent implements android.os.Parcelable {
		method public int describeContents();
		method public float getRelativeX();
		@@ -4756,6 +4809,21 @@ package android.hardware.input {
		method @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void sendTouchEvent(@NonNull android.hardware.input.VirtualTouchEvent);
		}

		public final class VirtualTouchscreenConfig extends android.hardware.input.VirtualInputDeviceConfig implements android.os.Parcelable {
		method public int describeContents();
		method public int getHeightInPixels();
		method public int getWidthInPixels();
		method public void writeToParcel(@NonNull android.os.Parcel, int);
		field @NonNull public static final android.os.Parcelable.Creator<android.hardware.input.VirtualTouchscreenConfig> CREATOR;
		}

		public static final class VirtualTouchscreenConfig.Builder extends android.hardware.input.VirtualInputDeviceConfig.Builder<android.hardware.input.VirtualTouchscreenConfig.Builder> {
		ctor public VirtualTouchscreenConfig.Builder();
		method @NonNull public android.hardware.input.VirtualTouchscreenConfig build();
		method @NonNull public android.hardware.input.VirtualTouchscreenConfig.Builder setHeightInPixels(int);
		method @NonNull public android.hardware.input.VirtualTouchscreenConfig.Builder setWidthInPixels(int);
		}

		}

		package android.hardware.lights {

core/java/android/companion/virtual/IVirtualDevice.aidl

+13 −19

Original line number	Diff line number	Diff line
		@@ -24,11 +24,15 @@ import android.companion.virtual.sensor.VirtualSensorConfig;
		import android.companion.virtual.sensor.VirtualSensorEvent;
		import android.graphics.Point;
		import android.graphics.PointF;
		import android.hardware.input.VirtualDpadConfig;
		import android.hardware.input.VirtualKeyboardConfig;
		import android.hardware.input.VirtualKeyEvent;
		import android.hardware.input.VirtualMouseButtonEvent;
		import android.hardware.input.VirtualMouseConfig;
		import android.hardware.input.VirtualMouseRelativeEvent;
		import android.hardware.input.VirtualMouseScrollEvent;
		import android.hardware.input.VirtualTouchEvent;
		import android.hardware.input.VirtualTouchscreenConfig;
		import android.os.ResultReceiver;

		/**
		@@ -64,32 +68,22 @@ interface IVirtualDevice {
		IAudioConfigChangedCallback configChangedCallback);

		void onAudioSessionEnded();

		@JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)")
		void createVirtualDpad(
		int displayId,
		String inputDeviceName,
		int vendorId,
		int productId,
		in VirtualDpadConfig config,
		IBinder token);
		@JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)")
		void createVirtualKeyboard(
		int displayId,
		String inputDeviceName,
		int vendorId,
		int productId,
		in VirtualKeyboardConfig config,
		IBinder token);
		@JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)")
		void createVirtualMouse(
		int displayId,
		String inputDeviceName,
		int vendorId,
		int productId,
		in VirtualMouseConfig config,
		IBinder token);
		@JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)")
		void createVirtualTouchscreen(
		int displayId,
		String inputDeviceName,
		int vendorId,
		int productId,
		IBinder token,
		in Point screenSize);
		in VirtualTouchscreenConfig config,
		IBinder token);
		void unregisterInputDevice(IBinder token);
		int getInputDeviceId(IBinder token);
		boolean sendDpadKeyEvent(IBinder token, in VirtualKeyEvent event);

core/java/android/companion/virtual/VirtualDeviceManager.java

+104 −49

Original line number	Diff line number	Diff line
		@@ -41,9 +41,13 @@ import android.hardware.display.IVirtualDisplayCallback;
		import android.hardware.display.VirtualDisplay;
		import android.hardware.display.VirtualDisplayConfig;
		import android.hardware.input.VirtualDpad;
		import android.hardware.input.VirtualDpadConfig;
		import android.hardware.input.VirtualKeyboard;
		import android.hardware.input.VirtualKeyboardConfig;
		import android.hardware.input.VirtualMouse;
		import android.hardware.input.VirtualMouseConfig;
		import android.hardware.input.VirtualTouchscreen;
		import android.hardware.input.VirtualTouchscreenConfig;
		import android.os.Binder;
		import android.os.Bundle;
		import android.os.Handler;
		@@ -512,23 +516,15 @@ public final class VirtualDeviceManager {
		/**
		* Creates a virtual dpad.
		*
		* @param display the display that the events inputted through this device should target
		* @param inputDeviceName the name to call this input device
		* @param vendorId the PCI vendor id
		* @param productId the product id, as defined by the vendor
		* @param config the configurations of the virtual Dpad.
		*/
		@RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)
		@NonNull
		public VirtualDpad createVirtualDpad(
		@NonNull VirtualDisplay display,
		@NonNull String inputDeviceName,
		int vendorId,
		int productId) {
		public VirtualDpad createVirtualDpad(@NonNull VirtualDpadConfig config) {
		try {
		final IBinder token = new Binder(
		"android.hardware.input.VirtualDpad:" + inputDeviceName);
		mVirtualDevice.createVirtualDpad(display.getDisplay().getDisplayId(),
		inputDeviceName, vendorId, productId, token);
		"android.hardware.input.VirtualDpad:" + config.getInputDeviceName());
		mVirtualDevice.createVirtualDpad(config, token);
		return new VirtualDpad(mVirtualDevice, token);
		} catch (RemoteException e) {
		throw e.rethrowFromSystemServer();
		@@ -538,23 +534,15 @@ public final class VirtualDeviceManager {
		/**
		* Creates a virtual keyboard.
		*
		* @param display the display that the events inputted through this device should target
		* @param inputDeviceName the name to call this input device
		* @param vendorId the PCI vendor id
		* @param productId the product id, as defined by the vendor
		* @param config the configurations of the virtual keyboard.
		*/
		@RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)
		@NonNull
		public VirtualKeyboard createVirtualKeyboard(
		@NonNull VirtualDisplay display,
		@NonNull String inputDeviceName,
		int vendorId,
		int productId) {
		public VirtualKeyboard createVirtualKeyboard(@NonNull VirtualKeyboardConfig config) {
		try {
		final IBinder token = new Binder(
		"android.hardware.input.VirtualKeyboard:" + inputDeviceName);
		mVirtualDevice.createVirtualKeyboard(display.getDisplay().getDisplayId(),
		inputDeviceName, vendorId, productId, token);
		"android.hardware.input.VirtualKeyboard:" + config.getInputDeviceName());
		mVirtualDevice.createVirtualKeyboard(config, token);
		return new VirtualKeyboard(mVirtualDevice, token);
		} catch (RemoteException e) {
		throw e.rethrowFromSystemServer();
		@@ -562,25 +550,43 @@ public final class VirtualDeviceManager {
		}

		/**
		* Creates a virtual mouse.
		* Creates a virtual keyboard.
		*
		* @param display the display that the events inputted through this device should target
		* @param display the display that the events inputted through this device should
		* target
		* @param inputDeviceName the name to call this input device
		* @param vendorId the PCI vendor id
		* @param productId the product id, as defined by the vendor
		* @see #createVirtualKeyboard(VirtualKeyboardConfig config)
		* @deprecated Use {@link #createVirtualKeyboard(VirtualKeyboardConfig config)} instead
		*/
		@Deprecated
		@RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)
		@NonNull
		public VirtualMouse createVirtualMouse(
		@NonNull VirtualDisplay display,
		@NonNull String inputDeviceName,
		int vendorId,
		int productId) {
		public VirtualKeyboard createVirtualKeyboard(@NonNull VirtualDisplay display,
		@NonNull String inputDeviceName, int vendorId, int productId) {
		VirtualKeyboardConfig keyboardConfig =
		new VirtualKeyboardConfig.Builder()
		.setVendorId(vendorId)
		.setProductId(productId)
		.setInputDeviceName(inputDeviceName)
		.setAssociatedDisplayId(display.getDisplay().getDisplayId())
		.build();
		return createVirtualKeyboard(keyboardConfig);
		}

		/**
		* Creates a virtual mouse.
		*
		* @param config the configurations of the virtual mouse.
		*/
		@RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)
		@NonNull
		public VirtualMouse createVirtualMouse(@NonNull VirtualMouseConfig config) {
		try {
		final IBinder token = new Binder(
		"android.hardware.input.VirtualMouse:" + inputDeviceName);
		mVirtualDevice.createVirtualMouse(display.getDisplay().getDisplayId(),
		inputDeviceName, vendorId, productId, token);
		"android.hardware.input.VirtualMouse:" + config.getInputDeviceName());
		mVirtualDevice.createVirtualMouse(config, token);
		return new VirtualMouse(mVirtualDevice, token);
		} catch (RemoteException e) {
		throw e.rethrowFromSystemServer();
		@@ -588,33 +594,82 @@ public final class VirtualDeviceManager {
		}

		/**
		* Creates a virtual touchscreen.
		* Creates a virtual mouse.
		*
		* @param display the display that the events inputted through this device should target
		* @param display the display that the events inputted through this device should
		* target
		* @param inputDeviceName the name to call this input device
		* @param vendorId the PCI vendor id
		* @param productId the product id, as defined by the vendor
		* @see #createVirtualMouse(VirtualMouseConfig config)
		* @deprecated Use {@link #createVirtualMouse(VirtualMouseConfig config)} instead
		* *
		*/
		@Deprecated
		@RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)
		@NonNull
		public VirtualMouse createVirtualMouse(@NonNull VirtualDisplay display,
		@NonNull String inputDeviceName, int vendorId, int productId) {
		VirtualMouseConfig mouseConfig =
		new VirtualMouseConfig.Builder()
		.setVendorId(vendorId)
		.setProductId(productId)
		.setInputDeviceName(inputDeviceName)
		.setAssociatedDisplayId(display.getDisplay().getDisplayId())
		.build();
		return createVirtualMouse(mouseConfig);
		}

		/**
		* Creates a virtual touchscreen.
		*
		* @param config the configurations of the virtual touchscreen.
		*/
		@RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)
		@NonNull
		public VirtualTouchscreen createVirtualTouchscreen(
		@NonNull VirtualDisplay display,
		@NonNull String inputDeviceName,
		int vendorId,
		int productId) {
		@NonNull VirtualTouchscreenConfig config) {
		try {
		final IBinder token = new Binder(
		"android.hardware.input.VirtualTouchscreen:" + inputDeviceName);
		final Point size = new Point();
		display.getDisplay().getSize(size);
		mVirtualDevice.createVirtualTouchscreen(display.getDisplay().getDisplayId(),
		inputDeviceName, vendorId, productId, token, size);
		"android.hardware.input.VirtualTouchscreen:" + config.getInputDeviceName());
		mVirtualDevice.createVirtualTouchscreen(config, token);
		return new VirtualTouchscreen(mVirtualDevice, token);
		} catch (RemoteException e) {
		throw e.rethrowFromSystemServer();
		}
		}

		/**
		* Creates a virtual touchscreen.
		*
		* @param display the display that the events inputted through this device should
		* target
		* @param inputDeviceName the name to call this input device
		* @param vendorId the PCI vendor id
		* @param productId the product id, as defined by the vendor
		* @see #createVirtualTouchscreen(VirtualTouchscreenConfig config)
		* @deprecated Use {@link #createVirtualTouchscreen(VirtualTouchscreenConfig config)}
		* instead
		*/
		@Deprecated
		@RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)
		@NonNull
		public VirtualTouchscreen createVirtualTouchscreen(@NonNull VirtualDisplay display,
		@NonNull String inputDeviceName, int vendorId, int productId) {
		final Point size = new Point();
		display.getDisplay().getSize(size);
		VirtualTouchscreenConfig touchscreenConfig =
		new VirtualTouchscreenConfig.Builder()
		.setVendorId(vendorId)
		.setProductId(productId)
		.setInputDeviceName(inputDeviceName)
		.setAssociatedDisplayId(display.getDisplay().getDisplayId())
		.setWidthInPixels(size.x)
		.setHeightInPixels(size.y)
		.build();
		return createVirtualTouchscreen(touchscreenConfig);
		}

		/**
		* Creates a VirtualAudioDevice, capable of recording audio emanating from this device,
		* or injecting audio from another device.

core/java/android/hardware/input/VirtualDpadConfig.aidl

0 → 100644

+19 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2022 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.input;

		parcelable VirtualDpadConfig;

core/java/android/hardware/input/VirtualDpadConfig.java

0 → 100644

+75 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2022 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.input;

		import android.annotation.NonNull;
		import android.annotation.SystemApi;
		import android.os.Parcel;
		import android.os.Parcelable;

		/**
		* Configurations to create virtual Dpad.
		*
		* @hide
		*/
		@SystemApi
		public final class VirtualDpadConfig extends VirtualInputDeviceConfig implements Parcelable {
		@NonNull
		public static final Creator<VirtualDpadConfig> CREATOR = new Creator<VirtualDpadConfig>() {
		@Override
		public VirtualDpadConfig createFromParcel(Parcel in) {
		return new VirtualDpadConfig(in);
		}

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

		private VirtualDpadConfig(@NonNull VirtualDpadConfig.Builder builder) {
		super(builder);
		}

		private VirtualDpadConfig(@NonNull Parcel in) {
		super(in);
		}

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

		@Override
		public void writeToParcel(@NonNull Parcel dest, int flags) {
		super.writeToParcel(dest, flags);
		}

		/**
		* Builder for creating a {@link VirtualDpadConfig}.
		*/
		public static final class Builder extends VirtualInputDeviceConfig.Builder<Builder> {

		/**
		* Builds the {@link VirtualDpadConfig} instance.
		*/
		@NonNull
		public VirtualDpadConfig build() {
		return new VirtualDpadConfig(this);
		}
		}
		}