Go to file
Romain Vimont ff579990c2 Shutdown connection before joining threads
Interrupting async processors may require to shutdown the connection to
wake up blocking calls.

Therefore, shutdown the connection first, then join the threads, then
close the connection.

Refs commit 9c08eb79cb
2023-11-01 18:36:10 +01:00
.github/ISSUE_TEMPLATE Improve bug report template 2020-05-06 22:26:43 +02:00
app Improve manpage formatting 2023-10-31 19:20:59 +01:00
assets Update README 2018-03-07 18:04:38 +01:00
config Upgrade Android checkstyle to 9.0.1 2021-10-30 11:23:51 +02:00
doc Add camera documentation 2023-10-31 15:57:06 +01:00
gradle/wrapper Upgrade gradle build tools to 7.4.0 2023-03-03 11:13:48 +01:00
scripts Use portable shebang for all bash scripts 2020-09-15 13:54:00 +02:00
server Shutdown connection before joining threads 2023-11-01 18:36:10 +01:00
.gitignore Add local.properties to gitignore 2020-11-03 17:09:03 +01:00
FAQ.md Fix documentation link in FAQ 2023-03-28 08:32:07 +02:00
LICENSE Happy new year 2023! 2023-03-12 02:04:58 +01:00
README.md Add camera documentation 2023-10-31 15:57:06 +01:00
build.gradle Upgrade gradle build tools to 7.4.0 2023-03-03 11:13:48 +01:00
bump_version Add script to bump version 2021-12-10 19:50:17 +01:00
cross_win32.txt Upgrade SDL (2.28.0) for Windows 2023-06-20 21:45:14 +02:00
cross_win64.txt Upgrade SDL (2.28.0) for Windows 2023-06-20 21:45:14 +02:00
gradle.properties Enable video output file, with pts set by server 2018-11-11 16:30:23 +01:00
gradlew Update to Gradle 6.3 2020-04-03 18:11:35 +02:00
gradlew.bat Update to Gradle 6.3 2020-04-03 18:11:35 +02:00
install_release.sh Update links to v2.1.1 2023-07-14 23:09:44 +02:00
meson.build Enable missing-prototypes warning 2023-10-24 23:06:57 +02:00
meson_options.txt Add compilation flag for USB features 2022-02-12 14:15:07 +01:00
release.mk Upgrade platform-tools (34.0.3) for Windows 2023-06-22 00:10:37 +02:00
release.sh Rename release.make to release.mk 2021-01-01 15:51:10 +01:00
run Fix icon path in ./run 2022-03-30 14:00:05 +02:00
settings.gradle Convert server to an Android project 2018-01-30 12:01:36 +01:00

README.md

scrcpy (v2.1.1)

scrcpy

pronounced "screen copy"

This application mirrors Android devices (video and audio) connected via USB or over TCP/IP, and allows to control the device with the keyboard and the mouse of the computer. It does not require any root access. It works on Linux, Windows and macOS.

screenshot

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 Android device
  • user benefits: no account, no ads, no internet required
  • freedom: free and open source software

Its features include:

Prerequisites

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

Audio forwarding is supported for API >= 30 (Android 11+).

Make sure you enabled USB debugging on your device(s).

On some devices, you also need to enable an additional option USB debugging (Security Settings) (this is an item different from USB debugging) to control it using a keyboard and mouse. Rebooting the device is necessary once this option is set.

Note that USB debugging is not required to run scrcpy in OTG mode.

Get the app

User documentation

The application provides a lot of features and configuration options. They are documented in the following pages:

Resources

Articles

Contact

If you encounter a bug, please read the FAQ first, then open an issue.

For general questions or discussions, you can also use:

Donate

I'm @rom1v, the author and maintainer of scrcpy.

If you appreciate this application, you can support my open source work:

Licence

Copyright (C) 2018 Genymobile
Copyright (C) 2018-2023 Romain Vimont

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

    http://www.apache.org/licenses/LICENSE-2.0

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.