1 /*
2  * Copyright (C) 2021 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 android.hardware.input;
18 
19 import android.annotation.NonNull;
20 import android.annotation.RequiresPermission;
21 import android.annotation.SystemApi;
22 import android.companion.virtual.IVirtualDevice;
23 import android.os.IBinder;
24 import android.os.RemoteException;
25 import android.view.KeyEvent;
26 
27 /**
28  * A virtual keyboard representing a key input mechanism on a remote device, such as a built-in
29  * keyboard on a laptop, a software keyboard on a tablet, or a keypad on a TV remote control.
30  *
31  * This registers an InputDevice that is interpreted like a physically-connected device and
32  * dispatches received events to it.
33  *
34  * @hide
35  */
36 @SystemApi
37 public class VirtualKeyboard extends VirtualInputDevice {
38 
39     private final int mUnsupportedKeyCode = KeyEvent.KEYCODE_DPAD_CENTER;
40 
41     /** @hide */
VirtualKeyboard(IVirtualDevice virtualDevice, IBinder token)42     public VirtualKeyboard(IVirtualDevice virtualDevice, IBinder token) {
43         super(virtualDevice, token);
44     }
45 
46     /**
47      * Sends a key event to the system.
48      *
49      * @param event the event to send
50      */
51     @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)
sendKeyEvent(@onNull VirtualKeyEvent event)52     public void sendKeyEvent(@NonNull VirtualKeyEvent event) {
53         try {
54             if (mUnsupportedKeyCode == event.getKeyCode()) {
55                 throw new IllegalArgumentException(
56                     "Unsupported key code " + event.getKeyCode()
57                         + " sent to a VirtualKeyboard input device.");
58             }
59             mVirtualDevice.sendKeyEvent(mToken, event);
60         } catch (RemoteException e) {
61             throw e.rethrowFromSystemServer();
62         }
63     }
64 }
65