2023-03-12 01:37:49 +00:00
|
|
|
|
# scrcpy (v2.0)
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2022-02-23 00:21:18 +00:00
|
|
|
|
<img src="app/data/icon.svg" width="128" height="128" alt="scrcpy" align="right" />
|
2021-10-23 07:29:30 +00:00
|
|
|
|
|
2022-01-27 16:08:14 +00:00
|
|
|
|
_pronounced "**scr**een **c**o**py**"_
|
|
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
This application mirrors Android devices (video and audio) connected via
|
|
|
|
|
|
USB or [over TCP/IP](doc/device.md#tcpip-wireless), 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_.
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2018-02-13 18:31:44 +00:00
|
|
|
|
|
2017-12-12 14:54:33 +00:00
|
|
|
|
|
2019-08-04 12:43:08 +00:00
|
|
|
|
It focuses on:
|
|
|
|
|
|
|
2021-11-13 08:39:26 +00:00
|
|
|
|
- **lightness**: native, displays only the device screen
|
|
|
|
|
|
- **performance**: 30~120fps, depending on the device
|
|
|
|
|
|
- **quality**: 1920×1080 or above
|
|
|
|
|
|
- **low latency**: [35~70ms][lowlatency]
|
|
|
|
|
|
- **low startup time**: ~1 second to display the first image
|
2022-04-10 15:45:34 +00:00
|
|
|
|
- **non-intrusiveness**: nothing is left installed on the Android device
|
2021-11-13 08:39:26 +00:00
|
|
|
|
- **user benefits**: no account, no ads, no internet required
|
|
|
|
|
|
- **freedom**: free and open source software
|
2019-08-04 12:43:08 +00:00
|
|
|
|
|
|
|
|
|
|
[lowlatency]: https://github.com/Genymobile/scrcpy/pull/646
|
|
|
|
|
|
|
2021-11-13 08:39:26 +00:00
|
|
|
|
Its features include:
|
2023-03-04 07:56:35 +00:00
|
|
|
|
- [audio forwarding](doc/audio.md) (Android >= 11)
|
|
|
|
|
|
- [recording](doc/recording.md)
|
|
|
|
|
|
- mirroring with [Android device screen off](doc/device.md#turn-screen-off)
|
|
|
|
|
|
- [copy-paste](doc/control.md#copy-paste) in both directions
|
|
|
|
|
|
- [configurable quality](doc/video.md)
|
|
|
|
|
|
- Android device [as a webcam (V4L2)](doc/v4l2.md) (Linux-only)
|
|
|
|
|
|
- [physical keyboard/mouse simulation (HID)](doc/hid-otg.md)
|
|
|
|
|
|
- [OTG mode](doc/hid-otg.md#otg)
|
2021-11-13 08:39:26 +00:00
|
|
|
|
- and more…
|
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
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
[Audio forwarding](doc/audio.md) is supported from API 30 (Android 11).
|
|
|
|
|
|
|
|
|
|
|
|
Make sure you [enabled adb debugging][enable-adb] on your device(s).
|
2018-02-13 18:31:44 +00:00
|
|
|
|
|
|
|
|
|
|
[enable-adb]: https://developer.android.com/studio/command-line/adb.html#Enabling
|
|
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
On some devices, you also need to enable [an additional option][control] `USB
|
|
|
|
|
|
debugging (Security Settings)` (this is an item different from `USB debugging`)
|
|
|
|
|
|
to control it using a keyboard and mouse.
|
2018-11-25 10:29:27 +00:00
|
|
|
|
|
|
|
|
|
|
[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
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
- [Linux](doc/linux.md)
|
|
|
|
|
|
- [Windows](doc/windows.md)
|
|
|
|
|
|
- [macOS](doc/macos.md)
|
2018-09-04 16:40:57 +00:00
|
|
|
|
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
## User documentation
|
2018-11-11 16:27:59 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
The application provides a lot of features and configuration options. They are
|
|
|
|
|
|
documented in the following pages:
|
2018-11-13 19:36:57 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
- [Device](doc/device.md)
|
|
|
|
|
|
- [Video](doc/video.md)
|
|
|
|
|
|
- [Audio](doc/audio.md)
|
|
|
|
|
|
- [Control](doc/control.md)
|
|
|
|
|
|
- [Window](doc/window.md)
|
|
|
|
|
|
- [Recording](doc/recording.md)
|
|
|
|
|
|
- [Tunnels](doc/tunnels.md)
|
|
|
|
|
|
- [HID/OTG](doc/hid-otg.md)
|
|
|
|
|
|
- [Video4Linux](doc/v4l2.md)
|
|
|
|
|
|
- [Shortcuts](doc/shortcuts.md)
|
2018-11-13 19:36:57 +00:00
|
|
|
|
|
|
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
## Resources
|
2018-11-13 19:36:57 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
- [FAQ](FAQ.md)
|
|
|
|
|
|
- [Translations][wiki] (not necessarily up to date)
|
|
|
|
|
|
- [Build instructions](doc/build.md)
|
|
|
|
|
|
- [Developers](doc/develop.md)
|
2018-11-13 19:36:57 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
[wiki]: https://github.com/Genymobile/scrcpy/wiki
|
2018-03-08 08:25:02 +00:00
|
|
|
|
|
|
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
## Articles
|
2018-03-08 08:25:02 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
- [Introducing scrcpy][article-intro]
|
|
|
|
|
|
- [Scrcpy now works wirelessly][article-tcpip]
|
2018-03-08 08:25:02 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
[article-intro]: https://blog.rom1v.com/2018/03/introducing-scrcpy/
|
|
|
|
|
|
[article-tcpip]: https://www.genymotion.com/blog/open-source-project-scrcpy-now-works-wirelessly/
|
2018-03-08 08:25:02 +00:00
|
|
|
|
|
2018-08-17 15:49:13 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
## Contact
|
2018-08-17 15:49:13 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
If you encounter a bug, please read the [FAQ](FAQ.md) first, then open an [issue].
|
2018-08-17 15:49:13 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
[issue]: https://github.com/Genymobile/scrcpy/issues
|
2018-03-11 09:34:11 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
For general questions or discussions, you can also use:
|
2022-02-22 18:31:35 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
- Reddit: [`r/scrcpy`](https://www.reddit.com/r/scrcpy)
|
|
|
|
|
|
- Twitter: [`@scrcpy_app`](https://twitter.com/scrcpy_app)
|
2018-03-11 09:34:11 +00:00
|
|
|
|
|
|
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
## Donate
|
2018-03-08 08:25:02 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
I'm [@rom1v](https://github.com/rom1v), the author and maintainer of _scrcpy_.
|
2018-03-08 08:25:02 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
If you appreciate this application, you can [support my open source
|
|
|
|
|
|
work][donate].
|
2018-03-08 08:25:02 +00:00
|
|
|
|
|
2023-03-04 07:56:35 +00:00
|
|
|
|
[donate]: https://blog.rom1v.com/about/#support-my-open-source-work
|
2018-03-08 08:25:02 +00:00
|
|
|
|
|
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
|
2023-03-04 08:08:42 +00:00
|
|
|
|
Copyright (C) 2018-2023 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.
|
