# recorderweb

> This package is made for purpose to record screen in web (Access Camera, mic and auto - download feature). ## Without video only avatar

Latest version **0.1.3** (published 2022-06-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install recorderweb
pnpm add recorderweb
yarn add recorderweb
bun add recorderweb
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2022-06-09 |
| First published | 2022-06-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 7 |
| Unpacked size | 240.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Nitesh singh |
| Maintainers | nitesh2020 |
| Keywords | camera, react-recorder, react-recording, recorderweb, sharescreen, recordscreen, screenrecorder, camera, mic, screen, react-recorder, web recorder |

## Links

- npm: https://www.npmjs.com/package/recorderweb
- Repository: https://github.com/nitesh9001/recorderWeb
- Homepage: https://github.com/nitesh9001/recorderWeb/blob/main/README.md
- Issues: https://github.com/nitesh9001/recorderWeb/issues
- npm.io page: https://npm.io/package/recorderweb

## Dependencies (7)

- [react](https://npm.io/package/react.md) ^18.1.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.1.0
- [web-vitals](https://npm.io/package/web-vitals.md) ^2.1.4
- [react-scripts](https://npm.io/package/react-scripts.md) 5.0.1
- [@popperjs/core](https://npm.io/package/@popperjs/core.md) ^2.11.5
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.12.4
- [regenerator-runtime](https://npm.io/package/regenerator-runtime.md) ^0.13.9

## Recent versions

- 0.1.3 (latest) — 2022-06-09
- 0.1.2 — 2022-06-03
- 0.1.1 — 2022-06-02
- 0.1.0 — 2022-06-02

## README

# Getting Started with RecorderWeb package

This package is made for purpose to record screen in web (Access Camera, mic and auto - download feature).
## Without video only avatar
<img width="600" alt="image" src="https://user-images.githubusercontent.com/48119181/171716304-0d47fb24-8411-45ff-81b3-82d2677cfe5b.png">

## With video 

<img width="444" alt="image" src="https://user-images.githubusercontent.com/48119181/171832347-c88b3aa6-12c1-4386-859f-6a673caf4373.png">

> #### Features
>
> - Screen Recorder.
> - With mic access.
> - With camera(user video enabled you can switch while recording)
> - Downaload the video
> - You can enable auto-download 
> - enable timer 
> - switch to avatar mode(user video is disabled).
> - customize your error
> - add callback function while start or end of the recording.

## Browser Support

All browser support 
**But for mobile devices it is disabled as navigator does not support in mobile devices**

## Installing

Using npm:

`$ npm install recorderweb`

## Usage
And then include it in your module (import recorderweb from "recorderweb")
`import recoderweb from 'recorderweb'`

     let recorderWebObj = new RecorderWeb(); 

     recorderWebObj.create("RecoderWeb",{
      environment: "desktop",
      mic: true,
      camera: true,
      download: true,
      timer: true,
      screenShot: false,
      autoDownload: true, // to auto download video after stop
      videoFormat: "mp4", // need to add in package
      avatar: "Nitesh", // if want avatar then specify Name of like-  Nitesh, Ritesh 
      onStop: callBackOnStop, // get media tracks after stop
      onStart: callbackOnStart // get notify after start the recoding.
     });

     recorderWebObj.mount("id of your div where want to mount");

## Settings


|..| variables   | possible value  | type of value   |                 remarks                 |
|-|:--------     |:---------------:|:---------------:|:----------------------------------------|
|.|  mic        |   true / fasle  |   boolean       |  to access mic keep it true (it can't <br/> be enabled after start). |
|.|  camera     |   true / fasle  |   boolean       |  to access user video keep it true. <br/>  you can switch while recording  | 
|.|  download    |   true / fasle  |   boolean       |  for download button keep the flag true |
|.|  timer       |   true / fasle  |   boolean       |  for showing timer keep the flag true   |
|.|  autoDownload|   true / fasle  |   boolean       |  for autodownload video after recording stop|
|.|  videoFormat |   mp4 (only *)  |   string        |  it must be mp4 for now                 |
|.|  avatar      |   name_of_user  |   srting        |  instead of video switch to avatar <br/> (firstletter of you name) |
|.|  screenShot  |   true / false  |   boolean       |  it disabled for now                    |

## Callback Methods
  > -  onStart   :  This callback is trigered when the recording will start.
  > -  onStop    :  This callback is trigered when the recording will stop.
  > -  getTracks :  This will give you the traks of recordings you can modify 
                    it according to your  need (in beta version).

## License
MIT License.

## Development
This project was generated with Angular CLI version 1.7.1.

## Contributions
Contributions are welcome, please open an issue and preferrably file a pull request.

Opening Issue
Please share sample code using codesandbox.com or stackblitz.com to help me re-produce the issue.

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