github.com-Genymobile-scrcpy_-_2021-11-17_21-00-29
Item Preview
Share or Embed This Item
- Publication date
- 2021-11-17
Display and control your Android device
scrcpy (v1.20)
This application provides display and control of Android devices connected viaUSB (or over TCP/IP). It does not require any root access.It works on GNU/Linux, Windows and macOS.
It focuses on:
- lightness: native, displays only the device screen
- performance: 30~120fps, depending on the device
- quality: 1920×1080 or above
- low latency: 35~70ms
- low startup time: ~1 second to display the first image
- non-intrusiveness: nothing is left installed on the device
- user benefits: no account, no ads, no internet required
- freedom: free and open source software
Its features include: - recording - mirroring with device screen off - copy-paste in both directions - configurable quality - device screen as a webcam (V4L2) (Linux-only) - physical keyboard simulation (HID) (Linux-only) - and more…
Requirements
The Android device requires at least API 21 (Android 5.0).
Make sure you enabled adb debugging on your device(s).
On some devices, you also need to enable an additional option tocontrol it using keyboard and mouse.
Get the app
Summary
- Linux:
apt install scrcpy
- Windows: download
- macOS:
brew install scrcpy
Build from sources: [BUILD] (simplified process)
Linux
On Debian (testing and sid for now) and Ubuntu (20.04):
apt install scrcpy
A [Snap] package is available: scrcpy
.
For Fedora, a [COPR] package is available: scrcpy
.
For Arch Linux, an [AUR] package is available: scrcpy
.
For Gentoo, an [Ebuild] is available: scrcpy/
.
You could also build the app manually (simplifiedprocess).
Windows
For Windows, for simplicity, a prebuilt archive with all the dependencies(including adb
) is available:
scrcpy-win64-v1.20.zip
(SHA-256: 548532b616288bcaeceff6881ad5e6f0928e5ae2b48c380385f03627401cfdba)
It is also available in [Chocolatey]:
bashchoco install scrcpychoco install adb # if you don't have it yet
And in [Scoop]:
bashscoop install scrcpyscoop install adb # if you don't have it yet
You can also build the app manually.
macOS
The application is available in [Homebrew]. Just install it:
bashbrew install scrcpy
You need adb
, accessible from your PATH
. If you don't have it yet:
bashbrew install android-platform-tools
It's also available in [MacPorts], which sets up adb for you:
bashsudo port install scrcpy
You can also build the app manually.
Run
Plug an Android device, and execute:
bashscrcpy
It accepts command-line arguments, listed by:
bashscrcpy --help
Features
Capture configuration
Reduce size
Sometimes, it is useful to mirror an Android device at a lower definition toincrease performance.
To limit both the width and height to some value (e.g. 1024):
bashscrcpy --max-size 1024scrcpy -m 1024 # short version
The other dimension is computed to that the device aspect ratio is preserved.That way, a device in 1920×1080 will be mirrored at 1024×576.
Change bit-rate
The default bit-rate is 8 Mbps. To change the video bitrate (e.g. to 2 Mbps):
bashscrcpy --bit-rate 2Mscrcpy -b 2M # short version
Limit frame rate
The capture frame rate can be limited:
bashscrcpy --max-fps 15
This is officially supported since Android 10, but may work on earlier versions.
Crop
The device screen may be cropped to mirror only part of the screen.
This is useful for example to mirror only one eye of the Oculus Go:
bashscrcpy --crop 1224:1440:0:0 # 1224x1440 at offset (0,0)
If --max-size
is also specified, resizing is applied after cropping.
Lock video orientation
To lock the orientation of the mirroring:
bashscrcpy --lock-video-orientation # initial (current) orientationscrcpy --lock-video-orientation=0 # natural orientationscrcpy --lock-video-orientation=1 # 90° counterclockwisescrcpy --lock-video-orientation=2 # 180°scrcpy --lock-video-orientation=3 # 90° clockwise
This affects recording orientation.
The window may also be rotated independently.
Encoder
Some devices have more than one encoder, and some of them may cause issues orcrash. It is possible to select a different encoder:
bashscrcpy --encoder OMX.qcom.video.encoder.avc
To list the available encoders, you could pass an invalid encoder name, theerror will give the available encoders:
bashscrcpy --encoder _
Capture
Recording
It is possible to record the screen while mirroring:
bashscrcpy --record file.mp4scrcpy -r file.mkv
To disable mirroring while recording:
```bashscrcpy --no-display --record file.mp4scrcpy -Nr file.mkv
interrupt recording with Ctrl+C
```
"Skipped frames" are recorded, even if they are not displayed in real time (forperformance reasons). Frames are timestamped on the device, so [packet delayvariation] does not impact the recorded file.
v4l2loopback
On Linux, it is possible to send the video stream to a v4l2 loopback device, sothat the Android device can be opened like a webcam by any v4l2-capable tool.
The module v4l2loopback
must be installed:
bashsudo apt install v4l2loopback-dkms
To create a v4l2 device:
bashsudo modprobe v4l2loopback
This will create a new video device in /dev/videoN
, where N
is an integer(more options are availableto 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:
bashscrcpy --v4l2-sink=/dev/videoNscrcpy --v4l2-sink=/dev/videoN --no-display # disable mirroring windowscrcpy --v4l2-sink=/dev/videoN -N # short version
(replace N
by the device ID, check with ls /dev/video*
)
Once enabled, you can open your video stream with a v4l2-capable tool:
bashffplay -i /dev/videoNvlc v4l2:///dev/videoN # VLC might add some buffering delay
For example, you could capture the video within [OBS].
Buffering
It is possible to add buffering. This increases latency but reduces jitter (see[#2464]).
The option is available for display buffering:
bashscrcpy --display-buffer=50 # add 50 ms buffering for display
and V4L2 sink:
bashscrcpy --v4l2-buffer=500 # add 500 ms buffering for v4l2 sink
Connection
Wireless
Scrcpy uses adb
to communicate with the device, and adb
can [connect] to adevice over TCP/IP:
- Connect the device to the same Wi-Fi as your computer.
Get your device IP address, in Settings → About phone → Status, or byexecuting this command:
bashadb shell ip route | awk '{print $9}'
Enable adb over TCP/IP on your device:
adb tcpip 5555
.- Unplug your device.
- Connect to your device:
adb connect DEVICE_IP:5555
(replaceDEVICE_IP
). - Run
scrcpy
as usual.
It may be useful to decrease the bit-rate and the definition:
bashscrcpy --bit-rate 2M --max-size 800scrcpy -b2M -m800 # short version
Multi-devices
If several devices are listed in adb devices
, you must specify the serial:
bashscrcpy --serial 0123456789abcdefscrcpy -s 0123456789abcdef # short version
If the device is connected over TCP/IP:
bashscrcpy --serial 192.168.0.1:5555scrcpy -s 192.168.0.1:5555 # short version
You can start several instances of scrcpy for several devices.
Autostart on device connection
You could use [AutoAdb]:
bashautoadb scrcpy -s '{}'
SSH tunnel
To connect to a remote device, it is possible to connect a local adb
client toa remote adb
server (provided they use the same version of the adbprotocol):
```bashadb kill-server # kill the local adb server on 5037ssh -CN -L5037:localhost:5037 -R27183:localhost:27183 yourremotecomputer
keep this open
```
From another terminal:
bashscrcpy
To avoid enabling remote port forwarding, you could force a forward connectioninstead (notice the -L
instead of -R
):
```bashadb kill-server # kill the local adb server on 5037ssh -CN -L5037:localhost:5037 -L27183:localhost:27183 yourremotecomputer
keep this open
```
From another terminal:
bashscrcpy --force-adb-forward
Like for wireless connections, it may be useful to reduce quality:
scrcpy -b2M -m800 --max-fps 15
Window configuration
Title
By default, the window title is the device model. It can be changed:
bashscrcpy --window-title 'My device'
Position and size
The initial window position and size may be specified:
bashscrcpy --window-x 100 --window-y 100 --window-width 800 --window-height 600
Borderless
To disable window decorations:
bashscrcpy --window-borderless
Always on top
To keep the scrcpy window always on top:
bashscrcpy --always-on-top
Fullscreen
The app may be started directly in fullscreen:
bashscrcpy --fullscreenscrcpy -f # short version
Fullscreen can then be toggled dynamically with MOD+f.
Rotation
The window may be rotated:
bashscrcpy --rotation 1
Possibles values are: - 0
: no rotation - 1
: 90 degrees counterclockwise - 2
: 180 degrees - 3
: 90 degrees clockwise
The rotation can also be changed dynamically with MOD+←(left) and MOD+→ (right).
Note that scrcpy manages 3 different rotations: - MOD+r requests the device to switch between portrait and landscape (the current running app may refuse, if it does not support the requested orientation). - --lock-video-orientation
changes the mirroring orientation (the orientation of the video sent from the device to the computer). This affects the recording. - --rotation
(or MOD+←/MOD+→) rotates only the window content. This affects only the display, not the recording.
Other mirroring options
Read-only
To disable controls (everything which can interact with the device: input keys,mouse events, drag&drop files):
bashscrcpy --no-controlscrcpy -n
Display
If several displays are available, it is possible to select the display tomirror:
bashscrcpy --display 1
The list of display ids can be retrieved by:
bashadb shell dumpsys display # search "mDisplayId=" in the output
The secondary display may only be controlled if the device runs at least Android10 (otherwise it is mirrored in read-only).
Stay awake
To prevent the device to sleep after some delay when the device is plugged in:
bashscrcpy --stay-awakescrcpy -w
The initial state is restored when scrcpy is closed.
Turn screen off
It is possible to turn the device screen off while mirroring on start with acommand-line option:
bashscrcpy --turn-screen-offscrcpy -S
Or by pressing MOD+o at any time.
To turn it back on, press MOD+Shift+o.
On Android, the POWER
button always turns the screen on. For convenience, ifPOWER
is sent via scrcpy (via right-click or MOD+p), itwill 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.
It can also be useful to prevent the device from sleeping:
bashscrcpy --turn-screen-off --stay-awakescrcpy -Sw
Power off on close
To turn the device screen off when closing scrcpy:
bashscrcpy --power-off-on-close
Show touches
For presentations, it may be useful to show physical touches (on the physicaldevice).
Android provides this feature in Developers options.
Scrcpy provides an option to enable this feature on start and restore theinitial value on exit:
bashscrcpy --show-touchesscrcpy -t
Note that it only shows physical touches (with the finger on the device).
Disable screensaver
By default, scrcpy does not prevent the screensaver to run on the computer.
To disable it:
bashscrcpy --disable-screensaver
Input control
Rotate device screen
Press MOD+r to switch between portrait and landscapemodes.
Note that it rotates only if the application in foreground supports therequested orientation.
Copy-paste
Any time the Android clipboard changes, it is automatically synchronized to thecomputer clipboard.
Any Ctrl shortcut is forwarded to the device. In particular: - Ctrl+c typically copies - Ctrl+x typically cuts - Ctrl+v typically pastes (after computer-to-device clipboard synchronization)
This typically works as you expect.
The actual behavior depends on the active application though. For example,Termux sends SIGINT on Ctrl+c instead, and K-9 Mailcomposes a new message.
To copy, cut and paste in such cases (but only supported on Android >= 7): - MOD+c injects COPY
- MOD+x injects CUT
- MOD+v injects PASTE
(after computer-to-device clipboard synchronization)
In addition, MOD+Shift+v allows to inject thecomputer clipboard text as a sequence of key events. This is useful when thecomponent does not accept text pasting (for example in Termux), but it canbreak non-ASCII content.
WARNING: Pasting the computer clipboard to the device (either viaCtrl+v or MOD+v) copies the contentinto the device clipboard. As a consequence, any Android application could readits content. You should avoid to paste sensitive content (like passwords) thatway.
Some devices do not behave as expected when setting the device clipboardprogrammatically. An option --legacy-paste
is provided to change the behaviorof Ctrl+v and MOD+v so that theyalso inject the computer clipboard text as a sequence of key events (the sameway as MOD+Shift+v).
Pinch-to-zoom
To simulate "pinch-to-zoom": Ctrl+click-and-move.
More precisely, hold Ctrl while pressing the left-click button. Untilthe left-click button is released, all mouse movements scale and rotate thecontent (if supported by the app) relative to the center of the screen.
Concretely, scrcpy generates additional touch events from a "virtual finger" ata location inverted through the center of the screen.
Physical keyboard simulation (HID)
By default, scrcpy uses Android key or text injection: it works everywhere, butis limited to ASCII.
On Linux, scrcpy can simulate a physical USB keyboard on Android to provide abetter input experience (using USB HID over AOAv2): the virtualkeyboard is disabled and it works for all characters and IME.
However, it only works if the device is connected by USB, and is currently onlysupported on Linux.
To enable this mode:
bashscrcpy --hid-keyboardscrcpy -K # short version
If it fails for some reason (for example because the device is not connected viaUSB), it automatically fallbacks to the default mode (with a log in theconsole). This allows to use the same command line options when connected overUSB and TCP/IP.
In this mode, raw key events (scancodes) are sent to the device, independentlyof the host key mapping. Therefore, if your keyboard layout does not match, itmust be configured on the Android device, in Settings → System → Languages andinput → [Physical keyboard].
Text injection preference
There are two kinds of events 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 behavesas expected in games (typically for WASD keys).
But this may cause issues. If you encounter such a problem, youcan avoid it by:
bashscrcpy --prefer-text
(but this will break keyboard behavior in games)
This option has no effect on HID keyboard (all key events are sent asscancodes in this mode).
Key repeat
By default, holding a key down generates repeated key events. This can causeperformance problems in some games, where these events are useless anyway.
To avoid forwarding repeated key events:
bashscrcpy --no-key-repeat
This option has no effect on HID keyboard (key repeat is handled by Androiddirectly in this mode).
Right-click and middle-click
By default, right-click triggers BACK (or POWER on) and middle-click triggersHOME. To disable these shortcuts and forward the clicks to the device instead:
bashscrcpy --forward-all-clicks
File drop
Install APK
To install an APK, drag & drop an APK file (ending with .apk
) to the scrcpywindow.
There is no visual feedback, a log is printed to the console.
Push file to device
To push a file to /sdcard/Download/
on the device, drag & drop a (non-APK)file to the scrcpy window.
There is no visual feedback, a log is printed to the console.
The target directory can be changed on start:
bashscrcpy --push-target=/sdcard/Movies/
Audio forwarding
Audio is not forwarded by scrcpy. Use [sndcpy].
Also see [issue #14].
Shortcuts
In the following list, MOD is the shortcut modifier. By default, it's(left) Alt or (left) Super.
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```
[Super] is typically the Windows or Cmd key.
| Action | Shortcut | ------------------------------------------- |:----------------------------- | Switch fullscreen mode | MOD+f | Rotate display left | MOD+← (left) | Rotate display right | MOD+→ (right) | Resize window to 1:1 (pixel-perfect) | MOD+g | Resize window to remove black borders | MOD+w \| Double-left-click¹ | Click on HOME
| MOD+h \| Middle-click | Click on BACK
| MOD+b \| Right-click² | Click on APP_SWITCH
| MOD+s \| 4th-click³ | Click on MENU
(unlock screen) | MOD+m | Click on VOLUME_UP
| MOD+↑ (up) | Click on VOLUME_DOWN
| MOD+↓ (down) | Click on POWER
| MOD+p | Power on | Right-click² | Turn device screen off (keep mirroring) | MOD+o | Turn device screen on | MOD+Shift+o | Rotate device screen | MOD+r | Expand notification panel | MOD+n \| 5th-click³ | Expand settings panel | MOD+n+n \| Double-5th-click³ | Collapse panels | MOD+Shift+n | Copy to clipboard⁴ | MOD+c | Cut to clipboard⁴ | MOD+x | Synchronize clipboards and paste⁴ | MOD+v | Inject computer clipboard text | MOD+Shift+v | Enable/disable FPS counter (on stdout) | MOD+i | Pinch-to-zoom | Ctrl+click-and-move | Drag & drop APK file | Install APK from computer | Drag & drop non-APK file | Push file to device
¹Double-click on black borders to remove them.
²Right-click turns the screen on if it was off, presses BACK otherwise.
³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 asecond time. For example, to execute "Expand settings panel":
- Press and keep pressing MOD.
- Then double-press n.
- Finally, release MOD.
All Ctrl+key shortcuts are forwarded to the device, so they arehandled by the active application.
Custom paths
To use a specific adb binary, configure its path in the environment variableADB
:
bashADB=/path/to/adb scrcpy
To override the path of the scrcpy-server
file, configure its path inSCRCPY_SERVER_PATH
.
To override the icon, configure its path in SCRCPY_ICON_PATH
.
Why scrcpy?
A colleague challenged me to find a name as unpronounceable as [gnirehtet].
[strcpy
] copies a string; scrcpy
copies a screen.
How to build?
See [BUILD].
Common issues
See the FAQ.
Developers
Read the [developers page].
Licence
Copyright (C) 2018 GenymobileCopyright (C) 2018-2021 Romain VimontLicensed 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.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.
Articles
Translations
This README is available in other languages:
- Indonesian (Indonesia,
id
) - v1.16 - Italiano (Italiano,
it
) - v1.19 - 日本語 (Japanese,
jp
) - v1.19 - 한국어 (Korean,
ko
) - v1.11 - Português Brasileiro (Brazilian Portuguese,
pt-BR
) - v1.19 - Español (Spanish,
sp
) - v1.17 - 简体中文 (Simplified Chinese,
zh-Hans
) - v1.20 - 繁體中文 (Traditional Chinese,
zh-Hant
) - v1.15 - Turkish (Turkish,
tr
) - v1.18
Only this README file is guaranteed to be up-to-date.
To restore the repository download the bundle
wget https://archive.org/download/github.com-Genymobile-scrcpy_-_2021-11-17_21-00-29/Genymobile-scrcpy_-_2021-11-17_21-00-29.bundle
and run: git clone Genymobile-scrcpy_-_2021-11-17_21-00-29.bundle
Source: https://github.com/Genymobile/scrcpy
Uploader: Genymobile
Upload date: 2021-11-17
- Addeddate
- 2021-11-18 01:46:21
- Identifier
- github.com-Genymobile-scrcpy_-_2021-11-17_21-00-29
- Originalurl
-
https://github.com/Genymobile/scrcpy
- Pushed_date
- 2021-11-17 21:00:29
- Scanner
- Internet Archive Python library 1.9.9
- Uploaded_with
- iagitup - v1.6.2
- Year
- 2021