react-rrtc

Overview

react-rrtc is a ReactJS plugin that provides a convenient hook for recording audio and video
streams using the RecordRTC library. This plugin simplifies the process of
recording media streams
within your React applications.

Features

- Record audio, screen and video streams with ease.
- Pause and resume recording functionality.
- Access to recorded media as Blob objects.
- Compatibility with various media stream configurations.
- Flexibility to customize recording options.

Installation

To install react-rrtc, simply run:

``bash
npm install react-rrtc
`

or

`bash
yarn add react-rrtc
`

Usage

$3

`javascript
import {useRecordRTC} from "react-rrtc";
`

$3

`jsx
import React from 'react';
import {useRecordRTC} from 'react-rrtc';

const MyComponent = () => {
const [timerStatus, setTimerStatus] = React.useState(false);
const options = {
countDownSec: 5, // Optional: Countdown before recording starts in seconds
rtcOptions: {}, // Optional: Additional options for RecordRTC
afterRecordingStartHook: async () => {
setTimerStatus(false);
},
};

const {
blob,
recorder,
recorderState,
previewVideoRef,
audioPreviewRef,
getScreenStream,
getUserMediaStream,
startRecording,
pauseRecording,
resumeRecording,
stopRecording,
} = useRecordRTC(options);

// Your component logic here

return (


export default MyComponent;
`

API

$3

- blob: The recorded media as a Blob object.
- recorder: The RecordRTCPromisesHandler instance.
- recorderState: The current state of the recorder (e.g., "inactive", "recording", "paused").
- previewVideoRef: Ref for previewing video.
- audioPreviewRef: Ref for previewing audio.

$3

- getScreenStream(constraints: DisplayMediaStreamOptions): Promise: Get a media
stream from the screen.
- getUserMediaStream(constraints: MediaStreamConstraints): Promise: Get a user media
stream.
- startRecording(stream: MediaStream, type: "audio"|"video" = "audio"): Promise: Start
recording from a media stream.
- pauseRecording(): Promise: Pause the current recording.
- resumeRecording(): Promise: Resume a paused recording.
- stopRecording(): Promise`: Stop the recording and retrieve the recorded media.

And many more to come...

License

This project is licensed under the MIT License - see the LICENSE file for details.