RepoMirrors
/
scrcpy
mirror of https://github.com/Genymobile/scrcpy
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
2,505 Commits 541 Branches 50 Tags 32 MiB
C 68.4%
Java 27.7%
Roff 1.6%
Shell 0.9%
Meson 0.8%
Other 0.6%
Go to file
Romain Vimont 3b241af3f6 Allow to pass an explicit version name on release 
To build with a specific version name:

    VERSION=pr1234 ./release.sh

If not set, it will use the result of "git describe" (as before).
 		2024-09-06 23:07:15 +02:00
.github Add FUNDING.yml 2024-07-19 17:56:26 +02:00
app Fix typos 2024-08-05 16:13:02 +02:00
assets Update README 2018-03-07 18:04:38 +01:00
config Upgrade Android checkstyle to 10.12.5 2023-11-15 21:13:12 +01:00
doc Update links to 2.6.1 2024-08-02 22:58:09 +02:00
gradle/wrapper Upgrade AGP (8.1.3) and Gradle to 8.4 2023-11-15 21:13:12 +01:00
server Do not apply all workarounds for ONYX devices 2024-08-10 14:29:26 +02:00
.gitignore Add scrcpy-server to .gitignore 2023-10-21 09:01:50 +02:00
FAQ.md Document UHID 2024-03-01 00:52:28 +01:00
LICENSE Happy new year 2024! 2024-03-02 16:48:21 +01:00
README.md Update links to 2.6.1 2024-08-02 22:58:09 +02:00
build.gradle Upgrade AGP from 8.1.3 to 8.3.0 2024-06-21 12:12:13 +02:00
bump_version Add script to bump version 2021-12-10 19:50:17 +01:00
cross_win32.txt Improve crossbuild 2023-11-25 21:06:37 +01:00
cross_win64.txt Improve crossbuild 2023-11-25 21:06:37 +01: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 2.6.1 2024-08-02 22:58:09 +02:00
meson.build Bump version to 2.6.1 2024-08-02 22:32:04 +02:00
meson_options.txt Add compilation flag for USB features 2022-02-12 14:15:07 +01:00
release.mk Allow to pass an explicit version name on release 2024-09-06 23:07:15 +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

This GitHub repo (https://github.com/Genymobile/scrcpy) is the only official source for the project. Do not download releases from random websites, even if their name contains scrcpy.

scrcpy (v2.6.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 (especially Xiaomi), you might get the following error:

java.lang.SecurityException: Injecting input events requires the caller (or the source of the instrumentation, if any) to have the INJECT_EVENTS permission.

In that case, you 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

Usage examples

There are a lot of options, documented in separate pages. Here are just some common examples.

  • Capture the screen in H.265 (better quality), limit the size to 1920, limit the frame rate to 60fps, disable audio, and control the device by simulating a physical keyboard:

    scrcpy --video-codec=h265 --max-size=1920 --max-fps=60 --no-audio --keyboard=uhid
scrcpy --video-codec=h265 -m1920 --max-fps=60 --no-audio -K  # short version

  • Record the device camera in H.265 at 1920x1080 (and microphone) to an MP4 file:

    scrcpy --video-source=camera --video-codec=h265 --camera-size=1920x1080 --record=file.mp4

  • Capture the device front camera and expose it as a webcam on the computer (on Linux):

    scrcpy --video-source=camera --camera-size=1920x1080 --camera-facing=front --v4l2-sink=/dev/video2 --no-playback

  • Control the device without mirroring by simulating a physical keyboard and mouse (USB debugging not required):

    scrcpy --otg

User documentation

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

Resources

Articles

Contact

You can open an issue for bug reports, feature requests or general questions.

For bug reports, please read the FAQ first, you might find a solution to your problem immediately.

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