f5e6b8092a
By default, only the left click is forwarded to the device, and secondary clicks trigger shortcuts (the behavior can be configured by --mouse-bind=xxxx). But when the mouse mode is relative (AOA and UHID modes), forward all clicks by default. This makes more sense since the cursor is handled on the device side, the user expects all mouse buttons to be forwarded. Refs <https://github.com/Genymobile/scrcpy/issues/4727#issuecomment-2069869750> PR #5022 <https://github.com/Genymobile/scrcpy/pull/5022>
111 lines
3.1 KiB
Markdown
111 lines
3.1 KiB
Markdown
# Mouse
|
|
|
|
Several mouse input modes are available:
|
|
|
|
- `--mouse=sdk` (default)
|
|
- `--mouse=uhid` (or `-M`): simulates a physical HID mouse using the UHID
|
|
kernel module on the device
|
|
- `--mouse=aoa`: simulates a physical HID mouse using the AOAv2 protocol
|
|
- `--mouse=disabled`
|
|
|
|
|
|
## SDK mouse
|
|
|
|
In this mode (`--mouse=sdk`, or if the parameter is omitted), mouse input events
|
|
are injected at the Android API level with absolute coordinates.
|
|
|
|
Note that on some devices, an additional option must be enabled in developer
|
|
options for this mouse mode to work. See
|
|
[prerequisites](/README.md#prerequisites).
|
|
|
|
|
|
## Physical mouse simulation
|
|
|
|
Two modes allow to simulate a physical HID mouse on the device.
|
|
|
|
In these modes, the computer mouse is "captured": the mouse pointer disappears
|
|
from the computer and appears on the Android device instead.
|
|
|
|
Special capture keys, either <kbd>Alt</kbd> or <kbd>Super</kbd>, toggle
|
|
(disable or enable) the mouse capture. Use one of them to give the control of
|
|
the mouse back to the computer.
|
|
|
|
|
|
### UHID
|
|
|
|
This mode simulates a physical HID mouse using the [UHID] kernel module on the
|
|
device.
|
|
|
|
[UHID]: https://kernel.org/doc/Documentation/hid/uhid.txt
|
|
|
|
To enable UHID mouse, use:
|
|
|
|
```bash
|
|
scrcpy --mouse=uhid
|
|
scrcpy -M # short version
|
|
```
|
|
|
|
|
|
### AOA
|
|
|
|
This mode simulates a physical HID mouse using the [AOAv2] protocol.
|
|
|
|
[AOAv2]: https://source.android.com/devices/accessories/aoa2#hid-support
|
|
|
|
To enable AOA mouse, use:
|
|
|
|
```bash
|
|
scrcpy --mouse=aoa
|
|
```
|
|
|
|
Contrary to the other modes, it works at the USB level directly (so it only
|
|
works over USB).
|
|
|
|
It does not use the scrcpy server, and does not require `adb` (USB debugging).
|
|
Therefore, it is possible to control the device (but not mirror) even with USB
|
|
debugging disabled (see [OTG](otg.md)).
|
|
|
|
Note: On Windows, it may only work in [OTG mode](otg.md), not while mirroring
|
|
(it is not possible to open a USB device if it is already open by another
|
|
process like the _adb daemon_).
|
|
|
|
|
|
## Mouse bindings
|
|
|
|
By default, with SDK mouse, right-click triggers BACK (or POWER on) and
|
|
middle-click triggers HOME. In addition, the 4th click triggers APP_SWITCH and
|
|
the 5th click expands the notification panel.
|
|
|
|
In AOA and UHID mouse modes, all clicks are forwarded by default.
|
|
|
|
The shortcuts can be configured using `--mouse-bind=xxxx` for any mouse mode.
|
|
The argument must be exactly 4 characters, one for each secondary click:
|
|
|
|
```
|
|
--mouse-bind=xxxx
|
|
^^^^
|
|
||||
|
|
||| `- 5th click
|
|
|| `-- 4th click
|
|
| `--- middle click
|
|
`---- right click
|
|
```
|
|
|
|
Each character must be one of the following:
|
|
|
|
- `+`: forward the click to the device
|
|
- `-`: ignore the click
|
|
- `b`: trigger shortcut BACK (or turn screen on if off)
|
|
- `h`: trigger shortcut HOME
|
|
- `s`: trigger shortcut APP_SWITCH
|
|
- `n`: trigger shortcut "expand notification panel"
|
|
|
|
For example:
|
|
|
|
```bash
|
|
scrcpy --mouse-bind=bhsn # the default mode with SDK mouse
|
|
scrcpy --mouse-bind=++++ # forward all clicks (default for AOA/UHID)
|
|
scrcpy --mouse-bind=++bh # forward right and middle clicks,
|
|
# use 4th and 5th for BACK and HOME
|
|
```
|