use-media-recorder/README.md

MediaRecorder API using React hooks.

[![npm version](https://badge.fury.io/js/use-media-recorder.svg)](https://badge.fury.io/js/use-media-recorder)

# useMediaRecorder

[MediaRecorder API](https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder) using [React hooks](https://reactjs.org/docs/hooks-intro.html).

## Table of Contents

- [Getting Started](#getting-started)
- [Usage](#usage)
  - [Video and audio](#video-and-audio)
  - [Audio only](#audio-only)
- [Demo](#demo)
- [License](#license)

## Getting started

`npm install --save use-media-recorder`

- Supports both video + audio and audio only recordings.
- Currently it generates `video/webm` and `audio/webm`.

## Usage

### Video and audio

```
import { useMediaRecorder } from 'use-media-recorder'
const [isRecording, setIsRecording] = useState(false)
const [setCaptureRef, data, err] = useMediaRecorder({ isRecording })
```

### Audio only

```
import { useMediaRecorder } from 'use-media-recorder'
const [isRecording, setIsRecording] = useState(false)
const [setCaptureRef, data, err] = useMediaRecorder({ isRecording, audioOnly: true })
```

Full example can be found [here](https://github.com/jagonzalr/useMediaRecorder/blob/master/demo/App.jsx)

## Demo

```
git clone git@github.com:jagonzalr/useMediaRecorder.git
cd useMediaRecorder
npm intall
npm start
```

## License

useMediaRecorder is [MIT licensed](./LICENSE).