# linux-screen-recorder

> Simple screen recorder on node js

Latest version **1.0.3** (published 2019-11-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install linux-screen-recorder
pnpm add linux-screen-recorder
yarn add linux-screen-recorder
bun add linux-screen-recorder
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-11-22 |
| First published | 2019-11-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Armen Hakobyan |
| Maintainers | inorain_development |
| Keywords | screen, recorder, screen recorder, linux, ffmpeg, video recorder |

## Links

- npm: https://www.npmjs.com/package/linux-screen-recorder
- Repository: https://github.com/Armen6964/screen-recorder
- Homepage: https://github.com/Armen6964/screen-recorder/blob/master/README.md
- Issues: https://github.com/Armen6964/screen-recorder/issues
- npm.io page: https://npm.io/package/linux-screen-recorder

## Dependencies (1)

- [screenres](https://npm.io/package/screenres.md) ^2.0.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2019-11-22
- 1.0.2 — 2019-11-22
- 1.0.1 — 2019-11-22
- 1.0.0 — 2019-11-22

## README

<h1>Device Screen Recorder</h1>

<p>
Current version required 
**ffmpeg** 
installation on device 
and working only on 
linux based operating systems
</p>

<h3>Usage</h3>
<p>

    const Recorder = require("linux-screen-recorder");
    let r = new Recorder();
    r.record(); // start recording
   
</p>

<h3>Options</h3>

<p>
    
    const Recorder = require("linux-screen-recorder");
   
    let options = {
        width:1280,
        //width is recording area size horizontal.
        //not required (<<Integer>> default value is device screen width),
        height:720,
        // height is recording area size vertical
        // not required (<<Integer>> default value is device screen height),
        x:0,
        // x is horizontal offset of the recording area
        // not required (<<Integer>> default value 0)
        y:0,
        // y is vertical offset of the recording area
        // not required (<<Integer>> default value 0)
        fps : 20,
        // Frame Per Second to record
        // not required (<<Integer>> default value 25)
        path : ".",
        // path where the recording file will be saved
        // not required (<<String>> default value ".")
        webServer:true,
        // attaching web server on 8080 port for testing recorded file
        // open in your browser (http://{host}:8080/home?file={filename}.mp4)
        // not required (<<Boolean>> default value false))
    };
    
    let r = new Recorder(options);
    r.record();
    
</p>

<h3>Api</h3>

<p>

    r.screenHeight; //returns device screen height
    r.screenWidth; //returns device screen width
    r.height; //returns recording screen height
    r.width; //returns recording screen width
    r.filePath; //returns recording file path
    r.X; //returns recording horizontal offset
    r.Y; //returns recording vertical offset
    
    r.record(); //start recording
    r.stop(); //stop recording


</p>

<h1>TODO List</h1>

<p>1) Setup recording with audio </p>

---
_Source: https://npm.io/package/linux-screen-recorder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._