Display and control your Android device
Reorganize features in README
Romain Vimontb145b8d5f445
diff --git a/README.md b/README.mdindex 17703152..b4e9a20e 100644--- a/README.md+++ b/README.md@@ -108,8 +108,9 @@ scrcpy --help## Features+### Capture configuration-### Reduce size+#### Reduce sizeSometimes, it is useful to mirror an Android device at a lower definition toincrease performance.@@ -125,7 +126,7 @@ 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+#### Change bit-rateThe default bit-rate is 8 Mbps. To change the video bitrate (e.g. to 2 Mbps):@@ -134,16 +135,15 @@ scrcpy --bit-rate 2Mscrcpy -b 2M # short version```-### Limit capture frame rate+#### Limit frame rate-On device with Android >= 10, the capture frame rate can be limited:+On devices with Android >= 10, the capture frame rate can be limited:```bashscrcpy --max-fps 15```--### Crop+#### CropThe device screen may be cropped to mirror only part of the screen.@@ -156,29 +156,7 @@ scrcpy --crop 1224:1440:0:0 # 1224x1440 at offset (0,0)If `--max-size` is also specified, resizing is applied after cropping.-### Wireless--_Scrcpy_ uses `adb` to communicate with the device, and `adb` can [connect] to a-device 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` _(replace `DEVICE_IP`)_.-6. Run `scrcpy` as usual.--It may be useful to decrease the bit-rate and the definition:--```bash-scrcpy --bit-rate 2M --max-size 800-scrcpy -b2M -m800 # short version-```--[connect]: https://developer.android.com/studio/command-line/adb.html#wireless---### Record screen+### RecordingIt is possible to record the screen while mirroring:@@ -203,78 +181,91 @@ variation] does not impact the recorded file.[packet delay variation]: https://en.wikipedia.org/wiki/Packet_delay_variation-### Multi-devices+### Connection-If several devices are listed in `adb devices`, you must specify the _serial_:--```bash-scrcpy --serial 0123456789abcdef-scrcpy -s 0123456789abcdef # short version-```--You can start several instances of _scrcpy_ for several devices.+#### Wireless+_Scrcpy_ uses `adb` to communicate with the device, and `adb` can [connect] to a+device over TCP/IP:-### Fullscreen+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` _(replace `DEVICE_IP`)_.+6. Run `scrcpy` as usual.-The app may be started directly in fullscreen:+It may be useful to decrease the bit-rate and the definition:```bash-scrcpy --fullscreen-scrcpy -f # short version+scrcpy --bit-rate 2M --max-size 800+scrcpy -b2M -m800 # short version```-Fullscreen can then be toggled dynamically with `Ctrl`+`f`.+[connect]: https://developer.android.com/studio/command-line/adb.html#wireless-### Always on top+#### Multi-devices-The window of app can always be above others by:+If several devices are listed in `adb devices`, you must specify the _serial_:```bash-scrcpy --always-on-top+scrcpy --serial 0123456789abcdef+scrcpy -s 0123456789abcdef # short version```+You can start several instances of _scrcpy_ for several devices.-### Show touches-For presentations, it may be useful to show physical touches (on the physical-device).+### Window configuration-Android provides this feature in _Developers options_.+#### Title-_Scrcpy_ provides an option to enable this feature on start and disable on exit:+By default, the window title is the device model. It can be changed:```bash-scrcpy --show-touches-scrcpy -t+scrcpy --window-title 'My device'```-Note that it only shows _physical_ touches (with the finger on the device).+#### Position and size+The initial window position and size may be specified:-### Install APK+```bash+scrcpy --window-x 100 --window-y 100 --window-width 800 --window-height 600+```-To install an APK, drag & drop an APK file (ending with `.apk`) to the _scrcpy_-window.+#### Borderless-There is no visual feedback, a log is printed to the console.+To disable window decorations:+```bash+scrcpy --window-borderless+```-### Push file to device+#### Always on top-To push a file to `/sdcard/` on the device, drag & drop a (non-APK) file to the-_scrcpy_ window.+To keep the scrcpy window always on top:-There is no visual feedback, a log is printed to the console.+```bash+scrcpy --always-on-top+```-The target directory can be changed on start:+#### Fullscreen++The app may be started directly in fullscreen:```bash-scrcpy --push-target /sdcard/foo/bar/+scrcpy --fullscreen+scrcpy -f # short version```-### Read-only+Fullscreen can then be toggled dynamically with `Ctrl`+`f`.+++### Other mirroring options++#### Read-onlyTo disable controls (everything which can interact with the device: input keys,mouse events, drag&drop files):@@ -284,7 +275,7 @@ scrcpy --no-controlscrcpy -n```-### Turn screen off+#### Turn screen offIt is possible to turn the device screen off while mirroring on start with acommand-line option:@@ -298,8 +289,7 @@ Or by pressing `Ctrl`+`o` at any time.To turn it back on, press `POWER` (or `Ctrl`+`p`).--### Render expired frames+#### Render expired framesBy default, to minimize latency, _scrcpy_ always renders the last decoded frameavailable, and drops any previous one.@@ -311,16 +301,49 @@ latency), use:scrcpy --render-expired-frames```-### Custom window title+#### Show touches-By default, the window title is the device model. It can be changed:+For presentations, it may be useful to show physical touches (on the physical+device).++Android provides this feature in _Developers options_.++_Scrcpy_ provides an option to enable this feature on start and disable on exit:```bash-scrcpy --window-title 'My device'+scrcpy --show-touches+scrcpy -t```+Note that it only shows _physical_ touches (with the finger on the device).+++### File drop++#### Install APK++To install an APK, drag & drop an APK file (ending with `.apk`) to the _scrcpy_+window.++There is no visual feedback, a log is printed to the console.+++#### Push file to device++To push a file to `/sdcard/` 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:++```bash+scrcpy --push-target /sdcard/foo/bar/+```++-### Forward audio+### Audio forwardingAudio is not forwarded by _scrcpy_. Use [USBaudio] (Linux-only).