Control device

Scrcpy supports various input events, including mouse, touch, keyboard, and physical buttons. The client sends input events to the server, which injects them into the device.

There are three ways to create or send control messages, they provide the same set of methods:

• Keyboard event: Simulate key presses.
• Text input: Inject text directly into the device.
• Touch event: Simulate mouse or finger touches.
• Mouse scroll event: Simulate mouse wheel scrolling.
• Back or screen on: Simulate back button or turn on the screen.
• Screen power mode: Turn off the screen without locking the device.
• Panel controls: Expand or collapse notification and settings panels.
• Rotate device: Change the device orientation.
• Set clipboard: Set the device clipboard content.
• USB HID devices: Control USB Human Interface Devices (HID) on the device.
• Reset video: Restart video capture and encoding.(since v3.0)
• Start app: Start applications on the device by package name.

Using @yume-chan/scrcpy

Using ScrcpyControlMessageSerializer

The ScrcpyControlMessageSerializer class provides methods to serialize events into Scrcpy messages. It's up to the caller to send the serialized message to the server.

The message format differs between Scrcpy versions, so a ScrcpyOptionsX_YY instance is required when creating the serializer.

JavaScript

import { ScrcpyControlMessageSerializer } from "@yume-chan/scrcpy";

const options = new ScrcpyOptions1_21({});
const serializer = new ScrcpyControlMessageSerializer(options);
const message = serializer.rotateDevice();

TypeScript

import { ScrcpyControlMessageSerializer } from "@yume-chan/scrcpy";

const options = new ScrcpyOptions1_21({});
const serializer = new ScrcpyControlMessageSerializer(options);
const message: Uint8Array = serializer.rotateDevice();

Using ScrcpyControlMessageWriter

ScrcpyControlMessageWriter class connects a WritableStream<Uint8Array> to a ScrcpyControlMessageSerializer. It writes serialized messages to the stream.

JavaScript

import { ScrcpyControlMessageWriter } from "@yume-chan/scrcpy";
import { WritableStream } from "@yume-chan/stream-extra";

const stream = new WritableStream();
const options = new ScrcpyOptions1_21({});
const writer = new ScrcpyControlMessageWriter(stream.getWriter(), options);

await writer.rotateDevice();

TypeScript

import { ScrcpyControlMessageWriter } from "@yume-chan/scrcpy";
import { WritableStream } from "@yume-chan/stream-extra";

const stream = new WritableStream<Uint8Array>();
const options = new ScrcpyOptions1_21({});
const writer = new ScrcpyControlMessageWriter(stream.getWriter(), options);

await writer.rotateDevice();

It has the same set of methods as ScrcpyControlMessageSerializer, plus a write method to write arbitrary data to the stream.

await writer.write(new Uint8Array([0x01, 0x02, 0x03]));

Make sure to write the whole message at once, otherwise it might be interleaved with other messages.

Using @yume-chan/adb-scrcpy

If the control socket is enabled, AdbScrcpyClient.controller is a ScrcpyControlMessageWriter that connects to the server's control socket.

if (client.controller) {
  await client.controller.rotateDevice();
}

AdbScrcpyClient also hooks up the device message socket to the options object, so setClipboard method can be used directly.