material-ui-player v1.0.10

Material UI Player

Simple React components for playing audio and video, using material-ui

• AudioCard: Audio element with controls
• VideoCard: Video element with controls
• SoundButton: IconButton to only play audio files (ideal for short audios)

Contents

• Why use this package
• Usage
• Props
• Callback props
• Note
• License

Why use this package

• Allow customization on traditional <audio> and <video> HTML elements
• Easy play media files stored in Firebase Storage or anywhere need to retrieve the download URL
• Material-UI components like : theming, customizations and low level components
• Use modern React hook and coding conventions
• Documentation made with Storybook

Usage

npm install material-ui-player # or yarn add material-ui-player

import React from 'react'
import { AudioCard, VideoCard } from 'material-ui-player'

// Relative URL - play a media from same origin
<AudioCard src={'/audio.mp3'} />
<VideoCard src={'/video.mp4'} />
<SoundButton src={'/audio.mp3'} />

// Absolute URL - play a media from external source
<AudioCard src={'https://file-examples-com.github.io/uploads/2017/11/file_example_MP3_1MG.mp3'} />
<VideoCard src={'http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4'} />
<SoundButton src={'https://file-examples-com.github.io/uploads/2017/11/file_example_MP3_1MG.mp3'} />

// Promise retrieve URL
<AudioCard src={fetch('<my url>')} />
<VideoCard src={fetch('<my url>')} />
<SoundButton src={fetch('<my url>')} />

Props

Callback props

Callback props take a function that gets fired on various player events:

Demo

Try it using the storyboard

Note

Please note:

• As required from Material UI you mast be sure to use this library's components inside a <ThemeProvider> wrapper, in order to use your custom theme.
• This module has following peerDependencies:

    "@mui/material": ">=5.0.0",
    "@mui/styles": ">=5.0.0",
    "react": ">=17.0.0",
    "react-dom": ">=17.0.0"

NB: Still need to use Material UI 4? Use version 0.2.6

License

Released under MIT License