Skip to content

Latest commit

 

History

History
93 lines (59 loc) · 1.49 KB

README.md

File metadata and controls

93 lines (59 loc) · 1.49 KB
Raw

mui-react-lib

This library offers React/MUI components to be used along with ApiRTC objects.

Install

npm install @apirtc/mui-react-lib

Also you will need to add

<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons" />

in index.html <head> to make Icons work.

Components

Stream

Use it to display any ApiRTC Stream. Example:

import { MuteButton, Stream, Video } from '@apirtc/mui-react-lib'

<Stream stream={stream}
        muted={false}
        controls={<><MuteButton /></>}>
        <Video />
</Stream>

Available children:

<Audio />
<Video />

Available controls:

<AudioEnableButton/>
<MuteButton />
<SnapshotButton />
<TorchButton />
<VideoEnableButton/>

Configure log level

Available log levels:

  • debug
  • info
  • warn
  • error

from web app code:

import { setLogLevel } from '@apirtc/mui-react-lib'

setLogLevel('warn')

from console:

setApirtcMuiReactLibLogLevel('debug')

Contribute

You need to get access in write mode to the repository.

The 'developers' team has access.

Then work on a branch and submit merge requests to main branch.

Release a new version

  • run npm run test, making sure tests passed, and code coverage as high as possible.

  • Update README documentation section if relevant.

  • Update package.json version number.

  • Update CHANGELOG accordingly.

  • run npm run build

  • run npm publish --access public