2021-06-20 20:04:52 +00:00
|
|
|
|
# scrcpy (v1.18)
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2020-07-27 14:24:04 +00:00
|
|
|
|
[Read in another language](#translations)
|
|
|
|
|
|
2018-03-08 08:25:02 +00:00
|
|
|
|
This application provides display and control of Android devices connected on
|
2018-05-28 18:31:01 +00:00
|
|
|
|
USB (or [over TCP/IP][article-tcpip]). It does not require any _root_ access.
|
2019-07-21 08:08:27 +00:00
|
|
|
|
It works on _GNU/Linux_, _Windows_ and _macOS_.
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
![screenshot](assets/screenshot-debian-600.jpg)
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2019-08-04 12:43:08 +00:00
|
|
|
|
It focuses on:
|
|
|
|
|
|
|
|
|
|
- **lightness** (native, displays only the device screen)
|
|
|
|
|
- **performance** (30~60fps)
|
|
|
|
|
- **quality** (1920×1080 or above)
|
|
|
|
|
- **low latency** ([35~70ms][lowlatency])
|
|
|
|
|
- **low startup time** (~1 second to display the first image)
|
|
|
|
|
- **non-intrusiveness** (nothing is left installed on the device)
|
|
|
|
|
|
|
|
|
|
[lowlatency]: https://github.com/Genymobile/scrcpy/pull/646
|
|
|
|
|
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
## Requirements
|
|
|
|
|
|
2019-07-21 08:08:27 +00:00
|
|
|
|
The Android device requires at least API 21 (Android 5.0).
|
2018-02-13 18:31:44 +00:00
|
|
|
|
|
|
|
|
|
Make sure you [enabled adb debugging][enable-adb] on your device(s).
|
|
|
|
|
|
|
|
|
|
[enable-adb]: https://developer.android.com/studio/command-line/adb.html#Enabling
|
|
|
|
|
|
2018-11-25 10:29:27 +00:00
|
|
|
|
On some devices, you also need to enable [an additional option][control] to
|
|
|
|
|
control it using keyboard and mouse.
|
|
|
|
|
|
|
|
|
|
[control]: https://github.com/Genymobile/scrcpy/issues/70#issuecomment-373286323
|
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
|
2018-08-17 15:49:13 +00:00
|
|
|
|
## Get the app
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2020-08-08 11:03:08 +00:00
|
|
|
|
<a href="https://repology.org/project/scrcpy/versions"><img src="https://repology.org/badge/vertical-allrepos/scrcpy.svg" alt="Packaging status" align="right"></a>
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2021-03-16 20:38:12 +00:00
|
|
|
|
### Summary
|
|
|
|
|
|
|
|
|
|
- Linux: `apt install scrcpy`
|
|
|
|
|
- Windows: [download][direct-win64]
|
|
|
|
|
- macOS: `brew install scrcpy`
|
|
|
|
|
|
2021-03-29 07:16:42 +00:00
|
|
|
|
Build from sources: [BUILD] ([simplified process][BUILD_simple])
|
|
|
|
|
|
|
|
|
|
[BUILD]: BUILD.md
|
|
|
|
|
[BUILD_simple]: BUILD.md#simple
|
2021-03-16 20:38:12 +00:00
|
|
|
|
|
|
|
|
|
|
2018-08-17 15:49:13 +00:00
|
|
|
|
### Linux
|
2018-03-11 21:01:59 +00:00
|
|
|
|
|
2020-04-23 14:36:48 +00:00
|
|
|
|
On Debian (_testing_ and _sid_ for now) and Ubuntu (20.04):
|
2020-01-19 15:16:05 +00:00
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
apt install scrcpy
|
|
|
|
|
```
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2019-06-11 21:41:00 +00:00
|
|
|
|
A [Snap] package is available: [`scrcpy`][snap-link].
|
|
|
|
|
|
|
|
|
|
[snap-link]: https://snapstats.org/snaps/scrcpy
|
|
|
|
|
|
|
|
|
|
[snap]: https://en.wikipedia.org/wiki/Snappy_(package_manager)
|
|
|
|
|
|
2020-06-27 10:16:27 +00:00
|
|
|
|
For Fedora, a [COPR] package is available: [`scrcpy`][copr-link].
|
|
|
|
|
|
|
|
|
|
[COPR]: https://fedoraproject.org/wiki/Category:Copr
|
|
|
|
|
[copr-link]: https://copr.fedorainfracloud.org/coprs/zeno/scrcpy/
|
|
|
|
|
|
2019-03-10 22:00:55 +00:00
|
|
|
|
For Arch Linux, an [AUR] package is available: [`scrcpy`][aur-link].
|
2018-03-12 15:00:12 +00:00
|
|
|
|
|
|
|
|
|
[AUR]: https://wiki.archlinux.org/index.php/Arch_User_Repository
|
2019-03-10 22:00:55 +00:00
|
|
|
|
[aur-link]: https://aur.archlinux.org/packages/scrcpy/
|
2018-03-12 15:00:12 +00:00
|
|
|
|
|
2018-09-19 20:08:32 +00:00
|
|
|
|
For Gentoo, an [Ebuild] is available: [`scrcpy/`][ebuild-link].
|
|
|
|
|
|
|
|
|
|
[Ebuild]: https://wiki.gentoo.org/wiki/Ebuild
|
|
|
|
|
[ebuild-link]: https://github.com/maggu2810/maggu2810-overlay/tree/master/app-mobilephone/scrcpy
|
2018-03-12 15:00:12 +00:00
|
|
|
|
|
2021-03-29 07:16:42 +00:00
|
|
|
|
You could also [build the app manually][BUILD] ([simplified
|
|
|
|
|
process][BUILD_simple]).
|
2020-01-19 15:16:05 +00:00
|
|
|
|
|
2018-03-12 15:00:12 +00:00
|
|
|
|
|
2018-08-17 15:49:13 +00:00
|
|
|
|
### Windows
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2020-03-03 20:39:27 +00:00
|
|
|
|
For Windows, for simplicity, a prebuilt archive with all the dependencies
|
|
|
|
|
(including `adb`) is available:
|
2018-03-08 08:25:02 +00:00
|
|
|
|
|
2021-06-20 20:04:52 +00:00
|
|
|
|
- [`scrcpy-win64-v1.18.zip`][direct-win64]
|
|
|
|
|
_(SHA-256: 37212f5087fe6f3e258f1d44fa5c02207496b30e1d7ec442cbcf8358910a5c63)_
|
2018-03-08 08:25:02 +00:00
|
|
|
|
|
2021-06-20 20:04:52 +00:00
|
|
|
|
[direct-win64]: https://github.com/Genymobile/scrcpy/releases/download/v1.18/scrcpy-win64-v1.18.zip
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2020-02-12 16:31:10 +00:00
|
|
|
|
It is also available in [Chocolatey]:
|
|
|
|
|
|
|
|
|
|
[Chocolatey]: https://chocolatey.org/
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
choco install scrcpy
|
2020-03-14 16:07:20 +00:00
|
|
|
|
choco install adb # if you don't have it yet
|
2020-02-12 16:31:10 +00:00
|
|
|
|
```
|
|
|
|
|
|
2020-03-08 08:31:29 +00:00
|
|
|
|
And in [Scoop]:
|
2020-02-12 16:31:10 +00:00
|
|
|
|
|
|
|
|
|
```bash
|
2020-03-08 08:31:29 +00:00
|
|
|
|
scoop install scrcpy
|
|
|
|
|
scoop install adb # if you don't have it yet
|
2020-02-12 16:31:10 +00:00
|
|
|
|
```
|
|
|
|
|
|
2020-03-08 08:31:29 +00:00
|
|
|
|
[Scoop]: https://scoop.sh
|
|
|
|
|
|
2018-08-17 15:49:13 +00:00
|
|
|
|
You can also [build the app manually][BUILD].
|
2018-05-27 19:53:13 +00:00
|
|
|
|
|
|
|
|
|
|
2019-07-21 08:08:27 +00:00
|
|
|
|
### macOS
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2018-03-28 12:10:55 +00:00
|
|
|
|
The application is available in [Homebrew]. Just install it:
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
[Homebrew]: https://brew.sh/
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2018-03-28 12:10:55 +00:00
|
|
|
|
```bash
|
|
|
|
|
brew install scrcpy
|
|
|
|
|
```
|
|
|
|
|
|
2018-08-17 17:51:25 +00:00
|
|
|
|
You need `adb`, accessible from your `PATH`. If you don't have it yet:
|
2018-03-28 12:10:55 +00:00
|
|
|
|
|
2018-03-10 08:12:47 +00:00
|
|
|
|
```bash
|
2021-04-02 13:47:37 +00:00
|
|
|
|
brew install android-platform-tools
|
2018-03-10 08:12:47 +00:00
|
|
|
|
```
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2021-05-06 16:56:41 +00:00
|
|
|
|
It's also available in [MacPorts], which sets up adb for you:
|
2021-01-02 17:18:23 +00:00
|
|
|
|
|
2021-05-06 16:56:41 +00:00
|
|
|
|
```bash
|
|
|
|
|
sudo port install scrcpy
|
2018-03-10 08:12:47 +00:00
|
|
|
|
```
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2021-05-06 16:56:41 +00:00
|
|
|
|
[MacPorts]: https://www.macports.org/
|
|
|
|
|
|
|
|
|
|
|
2018-08-17 15:49:13 +00:00
|
|
|
|
You can also [build the app manually][BUILD].
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2018-02-04 11:17:34 +00:00
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
## Run
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2018-08-17 15:49:13 +00:00
|
|
|
|
Plug an Android device, and execute:
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2018-03-10 08:12:47 +00:00
|
|
|
|
```bash
|
2018-03-10 14:34:59 +00:00
|
|
|
|
scrcpy
|
2018-03-10 08:12:47 +00:00
|
|
|
|
```
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
It accepts command-line arguments, listed by:
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2018-03-10 08:12:47 +00:00
|
|
|
|
```bash
|
2018-03-10 14:34:59 +00:00
|
|
|
|
scrcpy --help
|
2018-03-10 08:12:47 +00:00
|
|
|
|
```
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2018-11-11 16:27:59 +00:00
|
|
|
|
## Features
|
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
### Capture configuration
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Reduce size
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
|
|
|
|
Sometimes, it is useful to mirror an Android device at a lower definition to
|
2019-07-21 08:08:27 +00:00
|
|
|
|
increase performance.
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-07-21 08:08:27 +00:00
|
|
|
|
To limit both the width and height to some value (e.g. 1024):
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2018-03-10 08:12:47 +00:00
|
|
|
|
```bash
|
2018-11-11 16:27:59 +00:00
|
|
|
|
scrcpy --max-size 1024
|
|
|
|
|
scrcpy -m 1024 # short version
|
2018-03-10 08:12:47 +00:00
|
|
|
|
```
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2019-07-21 08:08:27 +00:00
|
|
|
|
The other dimension is computed to that the device aspect ratio is preserved.
|
2018-11-11 16:27:59 +00:00
|
|
|
|
That way, a device in 1920×1080 will be mirrored at 1024×576.
|
|
|
|
|
|
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Change bit-rate
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-07-21 08:08:27 +00:00
|
|
|
|
The default bit-rate is 8 Mbps. To change the video bitrate (e.g. to 2 Mbps):
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2018-03-10 08:12:47 +00:00
|
|
|
|
```bash
|
2018-11-11 16:27:59 +00:00
|
|
|
|
scrcpy --bit-rate 2M
|
|
|
|
|
scrcpy -b 2M # short version
|
2018-03-10 08:12:47 +00:00
|
|
|
|
```
|
2018-03-10 15:24:03 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Limit frame rate
|
2019-11-17 21:07:19 +00:00
|
|
|
|
|
2019-12-19 10:49:50 +00:00
|
|
|
|
The capture frame rate can be limited:
|
2019-11-17 21:07:19 +00:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --max-fps 15
|
|
|
|
|
```
|
|
|
|
|
|
2019-12-19 10:49:50 +00:00
|
|
|
|
This is officially supported since Android 10, but may work on earlier versions.
|
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Crop
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
|
|
|
|
The device screen may be cropped to mirror only part of the screen.
|
|
|
|
|
|
2019-07-21 08:08:27 +00:00
|
|
|
|
This is useful for example to mirror only one eye of the Oculus Go:
|
2018-08-09 17:12:27 +00:00
|
|
|
|
|
|
|
|
|
```bash
|
2018-11-11 16:27:59 +00:00
|
|
|
|
scrcpy --crop 1224:1440:0:0 # 1224x1440 at offset (0,0)
|
2018-08-09 17:12:27 +00:00
|
|
|
|
```
|
|
|
|
|
|
2018-11-11 16:27:59 +00:00
|
|
|
|
If `--max-size` is also specified, resizing is applied after cropping.
|
|
|
|
|
|
|
|
|
|
|
2020-02-16 11:30:36 +00:00
|
|
|
|
#### Lock video orientation
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
To lock the orientation of the mirroring:
|
|
|
|
|
|
|
|
|
|
```bash
|
2021-04-19 16:40:48 +00:00
|
|
|
|
scrcpy --lock-video-orientation # initial (current) orientation
|
2021-06-11 16:39:23 +00:00
|
|
|
|
scrcpy --lock-video-orientation=0 # natural orientation
|
|
|
|
|
scrcpy --lock-video-orientation=1 # 90° counterclockwise
|
|
|
|
|
scrcpy --lock-video-orientation=2 # 180°
|
|
|
|
|
scrcpy --lock-video-orientation=3 # 90° clockwise
|
2020-02-16 11:30:36 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This affects recording orientation.
|
|
|
|
|
|
2020-12-20 07:24:04 +00:00
|
|
|
|
The [window may also be rotated](#rotation) independently.
|
|
|
|
|
|
2020-02-16 11:30:36 +00:00
|
|
|
|
|
2020-11-08 20:11:12 +00:00
|
|
|
|
#### Encoder
|
|
|
|
|
|
|
|
|
|
Some devices have more than one encoder, and some of them may cause issues or
|
|
|
|
|
crash. It is possible to select a different encoder:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --encoder OMX.qcom.video.encoder.avc
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To list the available encoders, you could pass an invalid encoder name, the
|
|
|
|
|
error will give the available encoders:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --encoder _
|
|
|
|
|
```
|
|
|
|
|
|
2021-04-19 18:12:08 +00:00
|
|
|
|
### Capture
|
|
|
|
|
|
|
|
|
|
#### Recording
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
|
|
|
|
It is possible to record the screen while mirroring:
|
2018-03-25 13:23:00 +00:00
|
|
|
|
|
|
|
|
|
```bash
|
2018-11-11 16:27:59 +00:00
|
|
|
|
scrcpy --record file.mp4
|
2019-02-09 14:20:07 +00:00
|
|
|
|
scrcpy -r file.mkv
|
2018-11-11 16:27:59 +00:00
|
|
|
|
```
|
|
|
|
|
|
2019-03-02 17:33:31 +00:00
|
|
|
|
To disable mirroring while recording:
|
|
|
|
|
|
|
|
|
|
```bash
|
2019-03-02 21:46:46 +00:00
|
|
|
|
scrcpy --no-display --record file.mp4
|
|
|
|
|
scrcpy -Nr file.mkv
|
2019-03-02 17:33:31 +00:00
|
|
|
|
# interrupt recording with Ctrl+C
|
|
|
|
|
```
|
|
|
|
|
|
2018-11-11 16:27:59 +00:00
|
|
|
|
"Skipped frames" are recorded, even if they are not displayed in real time (for
|
|
|
|
|
performance reasons). Frames are _timestamped_ on the device, so [packet delay
|
|
|
|
|
variation] does not impact the recorded file.
|
|
|
|
|
|
|
|
|
|
[packet delay variation]: https://en.wikipedia.org/wiki/Packet_delay_variation
|
|
|
|
|
|
|
|
|
|
|
2021-04-19 18:12:08 +00:00
|
|
|
|
#### v4l2loopback
|
|
|
|
|
|
|
|
|
|
On Linux, it is possible to send the video stream to a v4l2 loopback device, so
|
|
|
|
|
that the Android device can be opened like a webcam by any v4l2-capable tool.
|
|
|
|
|
|
|
|
|
|
The module `v4l2loopback` must be installed:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
sudo apt install v4l2loopback-dkms
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To create a v4l2 device:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
sudo modprobe v4l2loopback
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This will create a new video device in `/dev/videoN`, where `N` is an integer
|
|
|
|
|
(more [options](https://github.com/umlaeute/v4l2loopback#options) are available
|
|
|
|
|
to create several devices or devices with specific IDs).
|
|
|
|
|
|
|
|
|
|
To list the enabled devices:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# requires v4l-utils package
|
|
|
|
|
v4l2-ctl --list-devices
|
|
|
|
|
|
|
|
|
|
# simple but might be sufficient
|
|
|
|
|
ls /dev/video*
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To start scrcpy using a v4l2 sink:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --v4l2-sink=/dev/videoN
|
2021-06-14 06:16:05 +00:00
|
|
|
|
scrcpy --v4l2-sink=/dev/videoN --no-display # disable mirroring window
|
|
|
|
|
scrcpy --v4l2-sink=/dev/videoN -N # short version
|
2021-04-19 18:12:08 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
(replace `N` by the device ID, check with `ls /dev/video*`)
|
|
|
|
|
|
|
|
|
|
Once enabled, you can open your video stream with a v4l2-capable tool:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
ffplay -i /dev/videoN
|
|
|
|
|
vlc v4l2:///dev/videoN # VLC might add some buffering delay
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
For example, you could capture the video within [OBS].
|
|
|
|
|
|
|
|
|
|
[OBS]: https://obsproject.com/fr
|
|
|
|
|
|
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
### Connection
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Wireless
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
_Scrcpy_ uses `adb` to communicate with the device, and `adb` can [connect] to a
|
|
|
|
|
device over TCP/IP:
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
1. Connect the device to the same Wi-Fi as your computer.
|
2020-11-30 09:16:50 +00:00
|
|
|
|
2. Get your device IP address, in Settings → About phone → Status, or by
|
|
|
|
|
executing this command:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
adb shell ip route | awk '{print $9}'
|
|
|
|
|
```
|
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
3. Enable adb over TCP/IP on your device: `adb tcpip 5555`.
|
|
|
|
|
4. Unplug your device.
|
|
|
|
|
5. Connect to your device: `adb connect DEVICE_IP:5555` _(replace `DEVICE_IP`)_.
|
|
|
|
|
6. Run `scrcpy` as usual.
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
It may be useful to decrease the bit-rate and the definition:
|
2018-09-04 16:40:57 +00:00
|
|
|
|
|
2018-11-11 16:27:59 +00:00
|
|
|
|
```bash
|
2019-11-19 17:41:43 +00:00
|
|
|
|
scrcpy --bit-rate 2M --max-size 800
|
|
|
|
|
scrcpy -b2M -m800 # short version
|
2018-09-04 16:40:57 +00:00
|
|
|
|
```
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
[connect]: https://developer.android.com/studio/command-line/adb.html#wireless
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Multi-devices
|
2019-01-27 11:04:22 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
If several devices are listed in `adb devices`, you must specify the _serial_:
|
2019-01-27 11:04:22 +00:00
|
|
|
|
|
|
|
|
|
```bash
|
2019-11-19 17:41:43 +00:00
|
|
|
|
scrcpy --serial 0123456789abcdef
|
|
|
|
|
scrcpy -s 0123456789abcdef # short version
|
2019-01-27 11:04:22 +00:00
|
|
|
|
```
|
|
|
|
|
|
2020-02-06 17:40:59 +00:00
|
|
|
|
If the device is connected over TCP/IP:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --serial 192.168.0.1:5555
|
|
|
|
|
scrcpy -s 192.168.0.1:5555 # short version
|
|
|
|
|
```
|
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
You can start several instances of _scrcpy_ for several devices.
|
2019-01-27 11:04:22 +00:00
|
|
|
|
|
2020-03-19 18:16:08 +00:00
|
|
|
|
#### Autostart on device connection
|
|
|
|
|
|
|
|
|
|
You could use [AutoAdb]:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
autoadb scrcpy -s '{}'
|
|
|
|
|
```
|
|
|
|
|
|
2020-05-01 17:18:23 +00:00
|
|
|
|
[AutoAdb]: https://github.com/rom1v/autoadb
|
2020-03-19 18:16:08 +00:00
|
|
|
|
|
2019-11-19 20:52:46 +00:00
|
|
|
|
#### SSH tunnel
|
|
|
|
|
|
|
|
|
|
To connect to a remote device, it is possible to connect a local `adb` client to
|
|
|
|
|
a remote `adb` server (provided they use the same version of the _adb_
|
|
|
|
|
protocol):
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
adb kill-server # kill the local adb server on 5037
|
|
|
|
|
ssh -CN -L5037:localhost:5037 -R27183:localhost:27183 your_remote_computer
|
|
|
|
|
# keep this open
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
From another terminal:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy
|
|
|
|
|
```
|
|
|
|
|
|
2020-05-24 21:27:34 +00:00
|
|
|
|
To avoid enabling remote port forwarding, you could force a forward connection
|
|
|
|
|
instead (notice the `-L` instead of `-R`):
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
adb kill-server # kill the local adb server on 5037
|
|
|
|
|
ssh -CN -L5037:localhost:5037 -L27183:localhost:27183 your_remote_computer
|
|
|
|
|
# keep this open
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
From another terminal:
|
|
|
|
|
|
|
|
|
|
```bash
|
2020-06-18 18:05:42 +00:00
|
|
|
|
scrcpy --force-adb-forward
|
2020-05-24 21:27:34 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
2019-11-19 20:52:46 +00:00
|
|
|
|
Like for wireless connections, it may be useful to reduce quality:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
scrcpy -b2M -m800 --max-fps 15
|
|
|
|
|
```
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
### Window configuration
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Title
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
By default, the window title is the device model. It can be changed:
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
|
|
|
|
```bash
|
2019-11-19 17:41:43 +00:00
|
|
|
|
scrcpy --window-title 'My device'
|
2018-09-04 16:40:57 +00:00
|
|
|
|
```
|
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Position and size
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
The initial window position and size may be specified:
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
```bash
|
|
|
|
|
scrcpy --window-x 100 --window-y 100 --window-width 800 --window-height 600
|
|
|
|
|
```
|
2018-11-13 19:36:57 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Borderless
|
2018-11-13 19:36:57 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
To disable window decorations:
|
2018-11-13 19:36:57 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
```bash
|
|
|
|
|
scrcpy --window-borderless
|
|
|
|
|
```
|
2018-11-13 19:36:57 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Always on top
|
2018-11-13 19:36:57 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
To keep the scrcpy window always on top:
|
2018-11-13 19:36:57 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
```bash
|
|
|
|
|
scrcpy --always-on-top
|
|
|
|
|
```
|
2018-11-13 19:36:57 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Fullscreen
|
|
|
|
|
|
|
|
|
|
The app may be started directly in fullscreen:
|
2019-07-30 23:48:32 +00:00
|
|
|
|
|
|
|
|
|
```bash
|
2019-11-19 17:41:43 +00:00
|
|
|
|
scrcpy --fullscreen
|
|
|
|
|
scrcpy -f # short version
|
2019-07-30 23:48:32 +00:00
|
|
|
|
```
|
2018-11-13 19:36:57 +00:00
|
|
|
|
|
2020-08-01 14:45:25 +00:00
|
|
|
|
Fullscreen can then be toggled dynamically with <kbd>MOD</kbd>+<kbd>f</kbd>.
|
2019-11-19 17:41:43 +00:00
|
|
|
|
|
2020-04-08 08:17:12 +00:00
|
|
|
|
#### Rotation
|
|
|
|
|
|
|
|
|
|
The window may be rotated:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --rotation 1
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Possibles values are:
|
|
|
|
|
- `0`: no rotation
|
|
|
|
|
- `1`: 90 degrees counterclockwise
|
|
|
|
|
- `2`: 180 degrees
|
|
|
|
|
- `3`: 90 degrees clockwise
|
|
|
|
|
|
2020-08-01 14:45:25 +00:00
|
|
|
|
The rotation can also be changed dynamically with <kbd>MOD</kbd>+<kbd>←</kbd>
|
|
|
|
|
_(left)_ and <kbd>MOD</kbd>+<kbd>→</kbd> _(right)_.
|
2020-04-08 08:17:12 +00:00
|
|
|
|
|
|
|
|
|
Note that _scrcpy_ manages 3 different rotations:
|
2020-09-17 11:03:18 +00:00
|
|
|
|
- <kbd>MOD</kbd>+<kbd>r</kbd> requests the device to switch between portrait
|
2021-03-17 07:52:16 +00:00
|
|
|
|
and landscape (the current running app may refuse, if it does not support the
|
2020-09-17 11:03:18 +00:00
|
|
|
|
requested orientation).
|
2020-12-20 07:24:04 +00:00
|
|
|
|
- [`--lock-video-orientation`](#lock-video-orientation) changes the mirroring
|
|
|
|
|
orientation (the orientation of the video sent from the device to the
|
|
|
|
|
computer). This affects the recording.
|
2020-08-01 14:45:25 +00:00
|
|
|
|
- `--rotation` (or <kbd>MOD</kbd>+<kbd>←</kbd>/<kbd>MOD</kbd>+<kbd>→</kbd>)
|
|
|
|
|
rotates only the window content. This affects only the display, not the
|
|
|
|
|
recording.
|
2020-04-08 08:17:12 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
|
|
|
|
|
### Other mirroring options
|
|
|
|
|
|
|
|
|
|
#### Read-only
|
2019-03-02 21:40:51 +00:00
|
|
|
|
|
|
|
|
|
To disable controls (everything which can interact with the device: input keys,
|
|
|
|
|
mouse events, drag&drop files):
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --no-control
|
|
|
|
|
scrcpy -n
|
|
|
|
|
```
|
|
|
|
|
|
2020-02-24 11:16:38 +00:00
|
|
|
|
#### Display
|
|
|
|
|
|
|
|
|
|
If several displays are available, it is possible to select the display to
|
|
|
|
|
mirror:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --display 1
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The list of display ids can be retrieved by:
|
|
|
|
|
|
2021-05-14 12:57:38 +00:00
|
|
|
|
```bash
|
2020-02-24 11:16:38 +00:00
|
|
|
|
adb shell dumpsys display # search "mDisplayId=" in the output
|
|
|
|
|
```
|
|
|
|
|
|
2020-05-06 20:21:33 +00:00
|
|
|
|
The secondary display may only be controlled if the device runs at least Android
|
|
|
|
|
10 (otherwise it is mirrored in read-only).
|
|
|
|
|
|
|
|
|
|
|
2020-05-01 23:54:48 +00:00
|
|
|
|
#### Stay awake
|
|
|
|
|
|
2020-05-28 21:07:28 +00:00
|
|
|
|
To prevent the device to sleep after some delay when the device is plugged in:
|
2020-05-01 23:54:48 +00:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --stay-awake
|
|
|
|
|
scrcpy -w
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The initial state is restored when scrcpy is closed.
|
|
|
|
|
|
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Turn screen off
|
2019-06-05 17:01:42 +00:00
|
|
|
|
|
|
|
|
|
It is possible to turn the device screen off while mirroring on start with a
|
|
|
|
|
command-line option:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --turn-screen-off
|
|
|
|
|
scrcpy -S
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-01 14:45:25 +00:00
|
|
|
|
Or by pressing <kbd>MOD</kbd>+<kbd>o</kbd> at any time.
|
2019-06-05 17:01:42 +00:00
|
|
|
|
|
2020-07-08 20:49:34 +00:00
|
|
|
|
To turn it back on, press <kbd>MOD</kbd>+<kbd>Shift</kbd>+<kbd>o</kbd>.
|
|
|
|
|
|
|
|
|
|
On Android, the `POWER` button always turns the screen on. For convenience, if
|
2020-08-09 06:47:22 +00:00
|
|
|
|
`POWER` is sent via scrcpy (via right-click or <kbd>MOD</kbd>+<kbd>p</kbd>), it
|
2020-07-08 20:49:34 +00:00
|
|
|
|
will force to turn the screen off after a small delay (on a best effort basis).
|
|
|
|
|
The physical `POWER` button will still cause the screen to be turned on.
|
2019-06-05 17:01:42 +00:00
|
|
|
|
|
2020-06-25 18:38:19 +00:00
|
|
|
|
It can also be useful to prevent the device from sleeping:
|
2020-05-01 23:54:48 +00:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --turn-screen-off --stay-awake
|
|
|
|
|
scrcpy -Sw
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
#### Show touches
|
2019-06-24 19:36:54 +00:00
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
For presentations, it may be useful to show physical touches (on the physical
|
|
|
|
|
device).
|
|
|
|
|
|
|
|
|
|
Android provides this feature in _Developers options_.
|
|
|
|
|
|
2020-05-01 21:49:37 +00:00
|
|
|
|
_Scrcpy_ provides an option to enable this feature on start and restore the
|
|
|
|
|
initial value on exit:
|
2019-06-24 19:36:54 +00:00
|
|
|
|
|
|
|
|
|
```bash
|
2019-11-19 17:41:43 +00:00
|
|
|
|
scrcpy --show-touches
|
|
|
|
|
scrcpy -t
|
2019-06-24 19:36:54 +00:00
|
|
|
|
```
|
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
Note that it only shows _physical_ touches (with the finger on the device).
|
|
|
|
|
|
|
|
|
|
|
2020-06-13 12:10:41 +00:00
|
|
|
|
#### Disable screensaver
|
|
|
|
|
|
|
|
|
|
By default, scrcpy does not prevent the screensaver to run on the computer.
|
|
|
|
|
|
|
|
|
|
To disable it:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --disable-screensaver
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
2019-11-19 18:24:34 +00:00
|
|
|
|
### Input control
|
|
|
|
|
|
2019-12-09 21:50:06 +00:00
|
|
|
|
#### Rotate device screen
|
|
|
|
|
|
2020-08-01 14:45:25 +00:00
|
|
|
|
Press <kbd>MOD</kbd>+<kbd>r</kbd> to switch between portrait and landscape
|
|
|
|
|
modes.
|
2019-12-09 21:50:06 +00:00
|
|
|
|
|
|
|
|
|
Note that it rotates only if the application in foreground supports the
|
|
|
|
|
requested orientation.
|
|
|
|
|
|
2019-11-19 18:24:34 +00:00
|
|
|
|
#### Copy-paste
|
|
|
|
|
|
2020-07-16 22:00:42 +00:00
|
|
|
|
Any time the Android clipboard changes, it is automatically synchronized to the
|
|
|
|
|
computer clipboard.
|
|
|
|
|
|
2020-08-01 14:45:25 +00:00
|
|
|
|
Any <kbd>Ctrl</kbd> shortcut is forwarded to the device. In particular:
|
|
|
|
|
- <kbd>Ctrl</kbd>+<kbd>c</kbd> typically copies
|
|
|
|
|
- <kbd>Ctrl</kbd>+<kbd>x</kbd> typically cuts
|
|
|
|
|
- <kbd>Ctrl</kbd>+<kbd>v</kbd> typically pastes (after computer-to-device
|
|
|
|
|
clipboard synchronization)
|
2020-07-16 22:00:42 +00:00
|
|
|
|
|
|
|
|
|
This typically works as you expect.
|
|
|
|
|
|
|
|
|
|
The actual behavior depends on the active application though. For example,
|
2020-08-01 14:45:25 +00:00
|
|
|
|
_Termux_ sends SIGINT on <kbd>Ctrl</kbd>+<kbd>c</kbd> instead, and _K-9 Mail_
|
|
|
|
|
composes a new message.
|
2020-07-16 22:00:42 +00:00
|
|
|
|
|
|
|
|
|
To copy, cut and paste in such cases (but only supported on Android >= 7):
|
2020-08-01 14:45:25 +00:00
|
|
|
|
- <kbd>MOD</kbd>+<kbd>c</kbd> injects `COPY`
|
|
|
|
|
- <kbd>MOD</kbd>+<kbd>x</kbd> injects `CUT`
|
|
|
|
|
- <kbd>MOD</kbd>+<kbd>v</kbd> injects `PASTE` (after computer-to-device
|
|
|
|
|
clipboard synchronization)
|
|
|
|
|
|
|
|
|
|
In addition, <kbd>MOD</kbd>+<kbd>Shift</kbd>+<kbd>v</kbd> allows to inject the
|
|
|
|
|
computer clipboard text as a sequence of key events. This is useful when the
|
|
|
|
|
component does not accept text pasting (for example in _Termux_), but it can
|
|
|
|
|
break non-ASCII content.
|
|
|
|
|
|
|
|
|
|
**WARNING:** Pasting the computer clipboard to the device (either via
|
|
|
|
|
<kbd>Ctrl</kbd>+<kbd>v</kbd> or <kbd>MOD</kbd>+<kbd>v</kbd>) copies the content
|
|
|
|
|
into the device clipboard. As a consequence, any Android application could read
|
|
|
|
|
its content. You should avoid to paste sensitive content (like passwords) that
|
|
|
|
|
way.
|
2020-05-20 18:05:29 +00:00
|
|
|
|
|
2020-10-06 19:30:10 +00:00
|
|
|
|
Some devices do not behave as expected when setting the device clipboard
|
|
|
|
|
programmatically. An option `--legacy-paste` is provided to change the behavior
|
|
|
|
|
of <kbd>Ctrl</kbd>+<kbd>v</kbd> and <kbd>MOD</kbd>+<kbd>v</kbd> so that they
|
|
|
|
|
also inject the computer clipboard text as a sequence of key events (the same
|
|
|
|
|
way as <kbd>MOD</kbd>+<kbd>Shift</kbd>+<kbd>v</kbd>).
|
2020-08-09 14:04:02 +00:00
|
|
|
|
|
|
|
|
|
#### Pinch-to-zoom
|
|
|
|
|
|
|
|
|
|
To simulate "pinch-to-zoom": <kbd>Ctrl</kbd>+_click-and-move_.
|
|
|
|
|
|
|
|
|
|
More precisely, hold <kbd>Ctrl</kbd> while pressing the left-click button. Until
|
|
|
|
|
the left-click button is released, all mouse movements scale and rotate the
|
|
|
|
|
content (if supported by the app) relative to the center of the screen.
|
|
|
|
|
|
|
|
|
|
Concretely, scrcpy generates additional touch events from a "virtual finger" at
|
|
|
|
|
a location inverted through the center of the screen.
|
|
|
|
|
|
|
|
|
|
|
2019-11-19 18:24:34 +00:00
|
|
|
|
#### Text injection preference
|
|
|
|
|
|
|
|
|
|
There are two kinds of [events][textevents] generated when typing text:
|
|
|
|
|
- _key events_, signaling that a key is pressed or released;
|
|
|
|
|
- _text events_, signaling that a text has been entered.
|
|
|
|
|
|
|
|
|
|
By default, letters are injected using key events, so that the keyboard behaves
|
|
|
|
|
as expected in games (typically for WASD keys).
|
|
|
|
|
|
|
|
|
|
But this may [cause issues][prefertext]. If you encounter such a problem, you
|
|
|
|
|
can avoid it by:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --prefer-text
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
(but this will break keyboard behavior in games)
|
|
|
|
|
|
|
|
|
|
[textevents]: https://blog.rom1v.com/2018/03/introducing-scrcpy/#handle-text-input
|
|
|
|
|
[prefertext]: https://github.com/Genymobile/scrcpy/issues/650#issuecomment-512945343
|
|
|
|
|
|
|
|
|
|
|
2020-07-27 06:26:25 +00:00
|
|
|
|
#### Key repeat
|
|
|
|
|
|
|
|
|
|
By default, holding a key down generates repeated key events. This can cause
|
|
|
|
|
performance problems in some games, where these events are useless anyway.
|
|
|
|
|
|
|
|
|
|
To avoid forwarding repeated key events:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --no-key-repeat
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
2020-10-05 18:45:53 +00:00
|
|
|
|
#### Right-click and middle-click
|
|
|
|
|
|
|
|
|
|
By default, right-click triggers BACK (or POWER on) and middle-click triggers
|
|
|
|
|
HOME. To disable these shortcuts and forward the clicks to the device instead:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
scrcpy --forward-all-clicks
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
2019-11-19 17:41:43 +00:00
|
|
|
|
### File drop
|
|
|
|
|
|
|
|
|
|
#### Install APK
|
|
|
|
|
|
|
|
|
|
To install an APK, drag & drop an APK file (ending with `.apk`) to the _scrcpy_
|
|
|
|
|
window.
|
|
|
|
|
|
|
|
|
|
There is no visual feedback, a log is printed to the console.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Push file to device
|
|
|
|
|
|
2021-06-13 20:47:16 +00:00
|
|
|
|
To push a file to `/sdcard/Download/` on the device, drag & drop a (non-APK)
|
|
|
|
|
file to the _scrcpy_ window.
|
2019-11-19 17:41:43 +00:00
|
|
|
|
|
|
|
|
|
There is no visual feedback, a log is printed to the console.
|
|
|
|
|
|
|
|
|
|
The target directory can be changed on start:
|
|
|
|
|
|
|
|
|
|
```bash
|
2021-06-13 20:47:16 +00:00
|
|
|
|
scrcpy --push-target=/sdcard/Movies/
|
2019-11-19 17:41:43 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Audio forwarding
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2020-06-09 20:08:34 +00:00
|
|
|
|
Audio is not forwarded by _scrcpy_. Use [sndcpy].
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2019-06-20 08:45:52 +00:00
|
|
|
|
Also see [issue #14].
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2020-06-09 20:08:34 +00:00
|
|
|
|
[sndcpy]: https://github.com/rom1v/sndcpy
|
2019-06-20 08:45:52 +00:00
|
|
|
|
[issue #14]: https://github.com/Genymobile/scrcpy/issues/14
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
## Shortcuts
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2020-08-01 14:45:25 +00:00
|
|
|
|
In the following list, <kbd>MOD</kbd> is the shortcut modifier. By default, it's
|
|
|
|
|
(left) <kbd>Alt</kbd> or (left) <kbd>Super</kbd>.
|
2020-07-16 22:00:42 +00:00
|
|
|
|
|
|
|
|
|
It can be changed using `--shortcut-mod`. Possible keys are `lctrl`, `rctrl`,
|
|
|
|
|
`lalt`, `ralt`, `lsuper` and `rsuper`. For example:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# use RCtrl for shortcuts
|
|
|
|
|
scrcpy --shortcut-mod=rctrl
|
|
|
|
|
|
|
|
|
|
# use either LCtrl+LAlt or LSuper for shortcuts
|
|
|
|
|
scrcpy --shortcut-mod=lctrl+lalt,lsuper
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-01 14:45:25 +00:00
|
|
|
|
_<kbd>[Super]</kbd> is typically the <kbd>Windows</kbd> or <kbd>Cmd</kbd> key._
|
2020-07-16 22:00:42 +00:00
|
|
|
|
|
|
|
|
|
[Super]: https://en.wikipedia.org/wiki/Super_key_(keyboard_button)
|
|
|
|
|
|
2020-07-16 22:00:42 +00:00
|
|
|
|
| Action | Shortcut
|
|
|
|
|
| ------------------------------------------- |:-----------------------------
|
2020-08-01 14:45:25 +00:00
|
|
|
|
| Switch fullscreen mode | <kbd>MOD</kbd>+<kbd>f</kbd>
|
|
|
|
|
| Rotate display left | <kbd>MOD</kbd>+<kbd>←</kbd> _(left)_
|
|
|
|
|
| Rotate display right | <kbd>MOD</kbd>+<kbd>→</kbd> _(right)_
|
|
|
|
|
| Resize window to 1:1 (pixel-perfect) | <kbd>MOD</kbd>+<kbd>g</kbd>
|
2021-04-22 20:57:31 +00:00
|
|
|
|
| Resize window to remove black borders | <kbd>MOD</kbd>+<kbd>w</kbd> \| _Double-left-click¹_
|
2020-08-01 14:45:25 +00:00
|
|
|
|
| Click on `HOME` | <kbd>MOD</kbd>+<kbd>h</kbd> \| _Middle-click_
|
|
|
|
|
| Click on `BACK` | <kbd>MOD</kbd>+<kbd>b</kbd> \| _Right-click²_
|
2021-04-22 20:57:31 +00:00
|
|
|
|
| Click on `APP_SWITCH` | <kbd>MOD</kbd>+<kbd>s</kbd> \| _4th-click³_
|
2020-08-01 15:10:09 +00:00
|
|
|
|
| Click on `MENU` (unlock screen) | <kbd>MOD</kbd>+<kbd>m</kbd>
|
2020-08-01 14:45:25 +00:00
|
|
|
|
| Click on `VOLUME_UP` | <kbd>MOD</kbd>+<kbd>↑</kbd> _(up)_
|
|
|
|
|
| Click on `VOLUME_DOWN` | <kbd>MOD</kbd>+<kbd>↓</kbd> _(down)_
|
|
|
|
|
| Click on `POWER` | <kbd>MOD</kbd>+<kbd>p</kbd>
|
2020-07-16 22:00:42 +00:00
|
|
|
|
| Power on | _Right-click²_
|
2020-08-01 14:45:25 +00:00
|
|
|
|
| Turn device screen off (keep mirroring) | <kbd>MOD</kbd>+<kbd>o</kbd>
|
|
|
|
|
| Turn device screen on | <kbd>MOD</kbd>+<kbd>Shift</kbd>+<kbd>o</kbd>
|
|
|
|
|
| Rotate device screen | <kbd>MOD</kbd>+<kbd>r</kbd>
|
2021-04-22 20:57:31 +00:00
|
|
|
|
| Expand notification panel | <kbd>MOD</kbd>+<kbd>n</kbd> \| _5th-click³_
|
|
|
|
|
| Expand settings panel | <kbd>MOD</kbd>+<kbd>n</kbd>+<kbd>n</kbd> \| _Double-5th-click³_
|
|
|
|
|
| Collapse panels | <kbd>MOD</kbd>+<kbd>Shift</kbd>+<kbd>n</kbd>
|
|
|
|
|
| Copy to clipboard⁴ | <kbd>MOD</kbd>+<kbd>c</kbd>
|
|
|
|
|
| Cut to clipboard⁴ | <kbd>MOD</kbd>+<kbd>x</kbd>
|
|
|
|
|
| Synchronize clipboards and paste⁴ | <kbd>MOD</kbd>+<kbd>v</kbd>
|
2020-08-01 14:45:25 +00:00
|
|
|
|
| Inject computer clipboard text | <kbd>MOD</kbd>+<kbd>Shift</kbd>+<kbd>v</kbd>
|
|
|
|
|
| Enable/disable FPS counter (on stdout) | <kbd>MOD</kbd>+<kbd>i</kbd>
|
2020-08-09 14:04:02 +00:00
|
|
|
|
| Pinch-to-zoom | <kbd>Ctrl</kbd>+_click-and-move_
|
2018-03-13 07:32:48 +00:00
|
|
|
|
|
|
|
|
|
_¹Double-click on black borders to remove them._
|
2020-07-16 22:00:42 +00:00
|
|
|
|
_²Right-click turns the screen on if it was off, presses BACK otherwise._
|
2021-04-22 20:57:31 +00:00
|
|
|
|
_³4th and 5th mouse buttons, if your mouse has them._
|
|
|
|
|
_⁴Only on Android >= 7._
|
|
|
|
|
|
|
|
|
|
Shortcuts with repeated keys are executted by releasing and pressing the key a
|
|
|
|
|
second time. For example, to execute "Expand settings panel":
|
|
|
|
|
|
|
|
|
|
1. Press and keep pressing <kbd>MOD</kbd>.
|
|
|
|
|
2. Then double-press <kbd>n</kbd>.
|
|
|
|
|
3. Finally, release <kbd>MOD</kbd>.
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2020-08-01 14:45:25 +00:00
|
|
|
|
All <kbd>Ctrl</kbd>+_key_ shortcuts are forwarded to the device, so they are
|
|
|
|
|
handled by the active application.
|
2020-07-16 22:00:42 +00:00
|
|
|
|
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2019-05-24 11:21:53 +00:00
|
|
|
|
## Custom paths
|
|
|
|
|
|
|
|
|
|
To use a specific _adb_ binary, configure its path in the environment variable
|
|
|
|
|
`ADB`:
|
|
|
|
|
|
2021-05-28 08:05:34 +00:00
|
|
|
|
```bash
|
|
|
|
|
ADB=/path/to/adb scrcpy
|
|
|
|
|
```
|
2019-05-24 11:21:53 +00:00
|
|
|
|
|
2019-10-30 22:40:10 +00:00
|
|
|
|
To override the path of the `scrcpy-server` file, configure its path in
|
2019-06-11 19:37:09 +00:00
|
|
|
|
`SCRCPY_SERVER_PATH`.
|
2019-05-24 11:21:53 +00:00
|
|
|
|
|
|
|
|
|
[useful]: https://github.com/Genymobile/scrcpy/issues/278#issuecomment-429330345
|
|
|
|
|
|
|
|
|
|
|
2018-03-08 08:25:02 +00:00
|
|
|
|
## Why _scrcpy_?
|
|
|
|
|
|
|
|
|
|
A colleague challenged me to find a name as unpronounceable as [gnirehtet].
|
|
|
|
|
|
|
|
|
|
[`strcpy`] copies a **str**ing; `scrcpy` copies a **scr**een.
|
|
|
|
|
|
|
|
|
|
[gnirehtet]: https://github.com/Genymobile/gnirehtet
|
|
|
|
|
[`strcpy`]: http://man7.org/linux/man-pages/man3/strcpy.3.html
|
|
|
|
|
|
|
|
|
|
|
2018-08-17 15:49:13 +00:00
|
|
|
|
## How to build?
|
|
|
|
|
|
|
|
|
|
See [BUILD].
|
|
|
|
|
|
|
|
|
|
|
2018-03-11 09:34:11 +00:00
|
|
|
|
## Common issues
|
|
|
|
|
|
|
|
|
|
See the [FAQ](FAQ.md).
|
|
|
|
|
|
|
|
|
|
|
2018-03-08 08:25:02 +00:00
|
|
|
|
## Developers
|
|
|
|
|
|
|
|
|
|
Read the [developers page].
|
|
|
|
|
|
|
|
|
|
[developers page]: DEVELOP.md
|
|
|
|
|
|
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
## Licence
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
Copyright (C) 2018 Genymobile
|
2021-01-01 16:16:44 +00:00
|
|
|
|
Copyright (C) 2018-2021 Romain Vimont
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
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
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
2018-02-04 11:17:34 +00:00
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
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.
|
2018-03-08 11:31:26 +00:00
|
|
|
|
|
2018-03-14 17:03:34 +00:00
|
|
|
|
## Articles
|
2018-03-08 11:31:26 +00:00
|
|
|
|
|
2018-05-28 18:31:01 +00:00
|
|
|
|
- [Introducing scrcpy][article-intro]
|
|
|
|
|
- [Scrcpy now works wirelessly][article-tcpip]
|
|
|
|
|
|
|
|
|
|
[article-intro]: https://blog.rom1v.com/2018/03/introducing-scrcpy/
|
|
|
|
|
[article-tcpip]: https://www.genymotion.com/blog/open-source-project-scrcpy-now-works-wirelessly/
|
2020-07-27 14:24:04 +00:00
|
|
|
|
|
|
|
|
|
## Translations
|
|
|
|
|
|
|
|
|
|
This README is available in other languages:
|
|
|
|
|
|
2020-10-05 19:22:54 +00:00
|
|
|
|
- [Indonesian (Indonesia, `id`) - v1.16](README.id.md)
|
2021-05-14 22:13:56 +00:00
|
|
|
|
- [Italiano (Italiano, `it`) - v1.17](README.it.md)
|
2021-03-13 15:21:26 +00:00
|
|
|
|
- [日本語 (Japanese, `jp`) - v1.17](README.jp.md)
|
2020-07-27 14:24:04 +00:00
|
|
|
|
- [한국어 (Korean, `ko`) - v1.11](README.ko.md)
|
2021-01-14 04:03:10 +00:00
|
|
|
|
- [português brasileiro (Brazilian Portuguese, `pt-BR`) - v1.17](README.pt-br.md)
|
2021-05-15 07:08:28 +00:00
|
|
|
|
- [Español (Spanish, `sp`) - v1.17](README.sp.md)
|
2021-01-12 05:54:42 +00:00
|
|
|
|
- [简体中文 (Simplified Chinese, `zh-Hans`) - v1.17](README.zh-Hans.md)
|
2020-09-10 04:18:56 +00:00
|
|
|
|
- [繁體中文 (Traditional Chinese, `zh-Hant`) - v1.15](README.zh-Hant.md)
|
2020-07-27 14:24:04 +00:00
|
|
|
|
|
|
|
|
|
Only this README file is guaranteed to be up-to-date.
|