0.1.3 • Published 2 years ago

recorderweb v0.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

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

..variablespossible valuetype of valueremarks
.mictrue / faslebooleanto access mic keep it true (it can't be enabled after start).
.cameratrue / faslebooleanto access user video keep it true. you can switch while recording
.downloadtrue / faslebooleanfor download button keep the flag true
.timertrue / faslebooleanfor showing timer keep the flag true
.autoDownloadtrue / faslebooleanfor autodownload video after recording stop
.videoFormatmp4 (only *)stringit must be mp4 for now
.avatarname_of_usersrtinginstead of video switch to avatar (firstletter of you name)
.screenShottrue / falsebooleanit 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.