Skip to content

Commit

Permalink
Update documentation for --no-window
Browse files Browse the repository at this point in the history
  • Loading branch information
rom1v committed May 11, 2024
1 parent 65b9f04 commit b5ed834
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 17 deletions.
11 changes: 9 additions & 2 deletions doc/audio.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,17 @@ To disable only the audio playback, see [no playback](video.md#no-playback).

## Audio only

To play audio only, disable the video:
To play audio only, disable video and control:

```bash
scrcpy --no-video
scrcpy --no-video --no-control
```

To play audio without a window:

```bash
# --no-video and --no-control are implied by --no-window
scrcpy --no-window
# interrupt with Ctrl+C
```

Expand Down
19 changes: 19 additions & 0 deletions doc/control.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,25 @@ scrcpy -n # short version
Read [keyboard](keyboard.md) and [mouse](mouse.md).


## Control only

To control the device without mirroring:

```bash
scrcpy --no-video --no-audio
```

By default, mouse mode is switched to UHID if video mirroring is disabled (a
relative mouse mode is required).

To also use a UHID keyboard, set it explicitly:

```bash
scrcpy --no-video --no-audio --keyboard=uhid
scrcpy --no-video --no-audio -K # short version
```


## Copy-paste

Any time the Android clipboard changes, it is automatically synchronized to the
Expand Down
43 changes: 32 additions & 11 deletions doc/otg.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
# OTG

By default, _scrcpy_ injects input events at the Android API level. As an
alternative, when connected over USB, it is possible to send HID events, so that
scrcpy behaves as if it was a physical keyboard and/or mouse connected to the
Android device.
alternative, it is possible to send HID events, so that scrcpy behaves as if it
was a [physical keyboard] and/or a [physical mouse] connected to the Android
device (see [keyboard](keyboard.md) and [mouse](mouse.md)).

A special mode allows to control the device without mirroring, using AOA
[keyboard](keyboard.md#aoa) and [mouse](mouse.md#aoa). Therefore, it is possible
to run _scrcpy_ with only physical keyboard and mouse simulation (HID), as if
the computer keyboard and mouse were plugged directly to the device via an OTG
cable.
[physical keyboard]: keyboard.md#physical-keyboard-simulation
[physical mouse]: physical-keyboard-simulation

In this mode, `adb` (USB debugging) is not necessary, and mirroring is disabled.
A special mode (OTG) allows to control the device using AOA
[keyboard](keyboard.md#aoa) and [mouse](mouse.md#aoa), without using _adb_ at
all (so USB debugging is not necessary). In this mode, video and audio are
disabled, and `--keyboard=aoa and `--mouse=aoa` are implicitly set.

This is similar to `--keyboard=aoa --mouse=aoa`, but without mirroring.
Therefore, it is possible to run _scrcpy_ with only physical keyboard and mouse
simulation, as if the computer keyboard and mouse were plugged directly to the
device via an OTG cable.

To enable OTG mode:

Expand All @@ -23,7 +25,7 @@ scrcpy --otg
scrcpy --otg -s 0123456789abcdef
```

It is possible to disable HID keyboard or HID mouse:
It is possible to disable keyboard or mouse:

```bash
scrcpy --otg --keyboard=disabled
Expand All @@ -35,3 +37,22 @@ It only works if the device is connected over USB.
## OTG issues on Windows

See [FAQ](/FAQ.md#otg-issues-on-windows).


## Control-only

Note that the purpose of OTG is to control the device without USB debugging
(adb).

If you want to solely control the device without mirroring while USB debugging
is enabled, then OTG mode is not necessary.

Instead, disable video and audio, and select UHID (or AOA):

```bash
scrcpy --no-video --no-audio --keyboard=uhid --mouse=uhid
scrcpy --no-video --no-audio -KM # short version
scrcpy --no-video --no-audio --keyboard=aoa --mouse=aoa
```

One benefit of UHID is that it also works wirelessly.
13 changes: 9 additions & 4 deletions doc/recording.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,10 @@ orientation](video.md#orientation).

## No playback

To disable playback while recording:
To disable playback and control while recording:

```bash
scrcpy --no-playback --record=file.mp4
scrcpy -Nr file.mkv
# interrupt recording with Ctrl+C
scrcpy --no-playback --no-control --record=file.mp4
```

It is also possible to disable video and audio playback separately:
Expand All @@ -73,6 +71,13 @@ It is also possible to disable video and audio playback separately:
scrcpy --record=file.mkv --no-audio-playback
```

To also disable the window:

```bash
scrcpy --no-playback --no-window --record=file.mp4
# interrupt recording with Ctrl+C
```

## Time limit

To limit the recording time:
Expand Down
9 changes: 9 additions & 0 deletions doc/window.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Window

## Disable window

To disable window (may be useful for recording or for playing audio only):

```bash
scrcpy --no-window --record=file.mp4
# Ctrl+C to interrupt
```

## Title

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

0 comments on commit b5ed834

Please sign in to comment.