Repository files navigation

This application provides display and control of Android devices connected onUSB (orover TCP/IP). It does not require anyroot access.It works onGNU/Linux,Windows andmacOS.

It focuses on:

• lightness (native, displays only the device screen)
• performance (30~60fps)
• 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)

The Android device requires at least API 21 (Android 5.0).

Make sure youenabled adb debugging on your device(s).

On some devices, you also need to enablean additional option tocontrol it using keyboard and mouse.

On Linux, you typically need tobuild the app manually. Don't worry,it's not that hard.

ASnap package is available:scrcpy.

For Arch Linux, anAUR package is available:scrcpy.

For Gentoo, anEbuild is available:scrcpy/.

For Windows, for simplicity, prebuilt archives with all the dependencies(includingadb) are available:

• scrcpy-win32-v1.12.1.zip
  (SHA-256: 0f4b3b063536b50a2df05dc42c760f9cc0093a9a26dbdf02d8232c74dab43480)
• scrcpy-win64-v1.12.1.zip
  (SHA-256: 57d34b6d16cfd9fe169bc37c4df58ebd256d05c1ea3febc63d9cb0a027ab47c9)

You can alsobuild the app manually.

The application is available inHomebrew. Just install it:

brew install scrcpy

You needadb, accessible from yourPATH. If you don't have it yet:

brew cask install android-platform-tools

You can alsobuild the app manually.

Plug an Android device, and execute:

scrcpy

It accepts command-line arguments, listed by:

scrcpy --help

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

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

The default bit-rate is 8 Mbps. To change the video bitrate (e.g. to 2 Mbps):

scrcpy --bit-rate 2Mscrcpy -b 2M# short version

On devices with Android >= 10, the capture frame rate can be limited:

scrcpy --max-fps 15

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:

scrcpy --crop 1224:1440:0:0# 1224x1440 at offset (0,0)

If--max-size is also specified, resizing is applied after cropping.

It is possible to record the screen while mirroring:

scrcpy --record file.mp4scrcpy -r file.mkv

To disable mirroring while recording:

scrcpy --no-display --record file.mp4scrcpy -Nr file.mkv# interrupt recording with Ctrl+C# Ctrl+C does not terminate properly on Windows, so disconnect the device

"Skipped frames" are recorded, even if they are not displayed in real time (forperformance reasons). Frames aretimestamped on the device, sopacket delayvariation does not impact the recorded file.

Scrcpy usesadb to communicate with the device, andadb canconnect to adevice over TCP/IP:

1. Connect the device to the same Wi-Fi as your computer.
2. Get your device IP address (in Settings → About phone → Status).
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(replaceDEVICE_IP).
6. Runscrcpy as usual.

It may be useful to decrease the bit-rate and the definition:

scrcpy --bit-rate 2M --max-size 800scrcpy -b2M -m800# short version

If several devices are listed inadb devices, you must specify theserial:

scrcpy --serial 0123456789abcdefscrcpy -s 0123456789abcdef# short version

You can start several instances ofscrcpy for several devices.

To connect to a remote device, it is possible to connect a localadb client toa remoteadb server (provided they use the same version of theadbprotocol):

adb kill-server# kill the local adb server on 5037ssh -CN -L5037:localhost:5037 -R27183:localhost:27183 your_remote_computer# keep this open

From another terminal:

scrcpy

Like for wireless connections, it may be useful to reduce quality:

scrcpy -b2M -m800 --max-fps 15

By default, the window title is the device model. It can be changed:

scrcpy --window-title'My device'

The initial window position and size may be specified:

scrcpy --window-x 100 --window-y 100 --window-width 800 --window-height 600

To disable window decorations:

scrcpy --window-borderless

To keep the scrcpy window always on top:

scrcpy --always-on-top

The app may be started directly in fullscreen:

scrcpy --fullscreenscrcpy -f# short version

Fullscreen can then be toggled dynamically withCtrl+f.

To disable controls (everything which can interact with the device: input keys,mouse events, drag&drop files):

scrcpy --no-controlscrcpy -n

It is possible to turn the device screen off while mirroring on start with acommand-line option:

scrcpy --turn-screen-offscrcpy -S

Or by pressingCtrl+o at any time.

To turn it back on, pressPOWER (orCtrl+p).

By default, to minimize latency,scrcpy always renders the last decoded frameavailable, and drops any previous one.

To force the rendering of all frames (at a cost of a possible increasedlatency), use:

scrcpy --render-expired-frames

For presentations, it may be useful to show physical touches (on the physicaldevice).

Android provides this feature inDevelopers options.

Scrcpy provides an option to enable this feature on start and disable on exit:

scrcpy --show-touchesscrcpy -t

Note that it only showsphysical touches (with the finger on the device).

PressCtrl+r to switch between portrait and landscape modes.

Note that it rotates only if the application in foreground supports therequested orientation.

It is possible to synchronize clipboards between the computer and the device, inboth directions:

• Ctrl+c copies the device clipboard to the computer clipboard;
• Ctrl+Shift+v copies the computer clipboard to the device clipboard;
• Ctrl+vpastes the computer clipboard as a sequence of text events (butbreaks non-ASCII characters).

There are two kinds ofevents 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 maycause issues. If you encounter such a problem, youcan avoid it by:

scrcpy --prefer-text

(but this will break keyboard behavior in games)

To install an APK, drag & drop an APK file (ending with.apk) to thescrcpywindow.

There is no visual feedback, a log is printed to the console.

To push a file to/sdcard/ on the device, drag & drop a (non-APK) file to thescrcpy window.

There is no visual feedback, a log is printed to the console.

The target directory can be changed on start:

scrcpy --push-target /sdcard/foo/bar/

Audio is not forwarded byscrcpy. UseUSBaudio (Linux-only).

Also seeissue #14.

¹Double-click on black borders to remove them.
²Right-click turns the screen on if it was off, presses BACK otherwise.

To use a specificadb binary, configure its path in the environment variableADB:

ADB=/path/to/adb scrcpy

To override the path of thescrcpy-server file, configure its path inSCRCPY_SERVER_PATH.

A colleague challenged me to find a name as unpronounceable asgnirehtet.

strcpy copies astring;scrcpy copies ascreen.

SeeBUILD.

See theFAQ.

Read thedevelopers page.

Copyright (C) 2018 GenymobileCopyright (C) 2018-2019 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.

• Introducing scrcpy
• Scrcpy now works wirelessly