https://github.com/nitesh9001/recorderweb

npm package to record camera, mic and capture screen in javascript framework for web view
https://github.com/nitesh9001/recorderweb

cameramic javascript packages react reactjs recordcamera recorderscreen recorderweb

Last synced: 9 days ago
JSON representation

npm package to record camera, mic and capture screen in javascript framework for web view

• Host: GitHub
• URL: https://github.com/nitesh9001/recorderweb
• Owner: nitesh9001
• Created: 2022-05-29T09:14:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-12T16:32:41.000Z (over 2 years ago)
• Last Synced: 2024-10-06T13:37:29.061Z (about 1 month ago)
• Topics: cameramic, javascript, packages, react, reactjs, recordcamera, recorderscreen, recorderweb
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/recorderweb
• Size: 395 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

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



## With video 



> #### 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 
 be enabled after start). |

|.|  camera     |   true / fasle  |   boolean       |  to access user video keep it true. 
  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 
 (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.