Web client prototype for scrcpy.
MIT License
Web client for Genymobile/scrcpy and more.
Browser must support the following technologies:
Server:
adb
executable must be available in the PATH environment variableDevice:
Make sure you have installed node.js, node-gyp and build tools
git clone https://github.com/NetrisTV/ws-scrcpy.git
cd ws-scrcpy
## For stable version find latest tag and switch to it:
# git tag -l
# git checkout vX.Y.Z
npm install
npm start
The modified version of Genymobile/scrcpy used to stream H264-video, which then decoded by one of included decoders:
Based on xevokk/h264-converter.
HTML5 Video.
Requires Media Source API and video/mp4; codecs="avc1.42E01E"
support. Creates mp4 containers from NALU, received from a
device, then feeds them to MediaSource. In theory, it can use
hardware acceleration.
Based on mbebenita/Broadway and 131/h264-live-player. Software video-decoder compiled into wasm-module. Requires WebAssembly and preferably WebGL support.
Based on udevbe/tinyh264. Software video-decoder compiled into wasm-module. A slightly updated version of mbebenita/Broadway. Requires WebAssembly, WebWorkers, WebGL support.
Decoding is done by browser built-in (software/hardware) media decoder. Requires WebCodecs support. At the moment, available only in Chromium and derivatives.
Drag & drop an APK file to push it to the /data/local/tmp
directory. You can
install it manually from the included xtermjs/xterm.js terminal
emulator (see below).
Control your device from adb shell
in your browser.
Experimental Feature: is not built by default (see custom build)
Requires ws-qvh available in PATH
.
Enable USE_WDA_MJPEG_SERVER
in the build configuration file
(see custom build).
Alternative way to stream screen content. It does not
require additional software as ws-qvh
, but may require more resources as each
frame encoded as jpeg image.
To control device we use appium/WebDriverAgent. Functionality limited to:
Make sure you did properly setup WebDriverAgent.
WebDriverAgent project is located under node_modules/appium-webdriveragent/
.
You might want to enable AssistiveTouch
on your device: Settings/General/Accessibility
.
You can customize project before build by overriding the default configuration in build.config.override.json:
INCLUDE_APPL
- include code for iOS device tracking and controlINCLUDE_GOOG
- include code for Android device tracking and controlINCLUDE_ADB_SHELL
- remote shell for android devicesINCLUDE_DEV_TOOLS
- dev tools for web pages andINCLUDE_FILE_LISTING
- minimalistic file management
USE_BROADWAY
- include Broadway Player
USE_H264_CONVERTER
- include Mse Player
USE_TINY_H264
- include TinyH264 Player
USE_WEBCODECS
- include WebCodecs Player
USE_WDA_MJPEG_SERVER
- configure WebDriverAgent to start MJPEG serverUSE_QVH_SERVER
- include support for ws-qvh
SCRCPY_LISTENS_ON_ALL_INTERFACES
- WebSocket server in scrcpy-server.jar
true
, it allowsYou can specify a path to a configuration file in WS_SCRCPY_CONFIG
environment variable.
If you want to have another pathname than "/" you can specify it in the
WS_SCRCPY_PATHNAME
environment variable.
Configuration file format: Configuration.d.ts.
Configuration file example: config.example.yaml.
proxy over adb
from the interfaces list.Be advised and keep in mind:
Currently, support of WebSocket protocol added to v1.19 of scrcpy