Romain Vimont 035d60cf5d Add option to configure mouse bindings

Add a new option --mouse-bind=xxxx.

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"

This deprecates --forward-all-clicks (use --mouse-bind=++++ instead).

Refs <https://github.com/Genymobile/scrcpy/pull/2258#issuecomment-2182394460>
PR #5022 <https://github.com/Genymobile/scrcpy/pull/5022>

2024-06-24 23:17:23 +02:00

2.9 KiB

Raw Blame History

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.

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 Alt or Super, 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.

To enable UHID mouse, use:

scrcpy --mouse=uhid
scrcpy -M  # short version

AOA

This mode simulates a physical HID mouse using the AOAv2 protocol.

To enable AOA mouse, use:

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).

Note: On Windows, it may only work in OTG mode, 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, 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.

The shortcuts can be configured using --mouse-bind=xxxx. 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:

scrcpy --mouse-bind=bhsn  # the default mode
scrcpy --mouse-bind=++++  # forward all clicks
scrcpy --mouse-bind=++bh  # forward right and middle clicks,
                          # use 4th and 5th for BACK and HOME

2.9 KiB Raw Blame History