node-scrcpy-client

Node.js client for scrcpy server (https://github.com/Genymobile/scrcpy). scrcpy allows you to record your android device / emulator screen. It does not need root access.

Installation

This module is installed via npm:

npm install --save scrcpy-client

Usage

Obtain raw frames

It will connect to adb server, push the jar to the device and emit events with the h264 frames.

const Scrcpy = require('scrcpy-client');

const scrcpy = new Scrcpy();

scrcpy.on('data', (pts, data) => console.log(`[${pts}] Data: ${data.length}b`));

scrcpy.start()
  .then(info => console.log(`Started -> ${info.name} at ${info.width}x${info.height}`))
  .catch(e => console.error('Impossible to start', e));

Configuration options

  {
    adbHost: 'localhost',
    adbPort: 5037,
    deviceId: null,
    port: 8099,
    maxSize: 600,
    bitrate: 999999999,
    tunnelForward: true,
    crop: '9999:9999:0:0',
    sendFrameMeta: true
  }

If deviceId is not defined (or null) it will try to use the first device available.
If sendFrameMeta is true data events will contain 2 parameters pts and data.

More examples

You can find them in the examples folder.

Enable debug of module

This module uses debug for debugging, you can enable debug messages with:

DEBUG=scrcpy

Run tests

npm test

Jar Issues with Latest Pixel

On the latest Pixel OS there are some issues with the Jar file where no data was being streamed after the first await this.socket.read(69) command. This repo contains a build of scrcpy-1.8 where two main changes have been made.

`app/src/sys/unix/command.c`

This file now contains the following lines at the beginning of the file:

#define _POSIX_C_SOURCE 200809L // for kill()
#define _BSD_SOURCE // for readlink()

`server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java`

This file now contains the following on line 153 (in the createDisplay function):

return SurfaceControl.createDisplay("scrcpy", false);

With these changes, scrcpy was built from source and the .jar file has been dumped into this repo in lib folder.

Relevant Links

Stuff that helped fix this issue:

libsdl-org/SDL#3657 Genymobile/scrcpy#1787 https://github.com/Genymobile/scrcpy/commit/dd73a71a158e8bb6f1c09cd118b24ed9a48dae99 Genymobile/scrcpy#1726

License (MIT)

In case you never heard about the MIT license.

See the LICENSE file for details.

All credits for scrcpy server goes to Genymobile. The compiled version distributed with this library is a mirror of their built, not compiled by me, to ensure SHA1 signature remains the same and comes from a trust source.

twotabsofacid/node-scrcpy-client