A simple, clean, and responsive visual wrapper for the HTML audio tag, built with React. Give it a playlist and go.
If you're not using npm and you need production-ready scripts to include in your project, check out the releases.
// dist/main.jsvar React = ;var ReactDOM = ;var AudioPlayer = ;var playlist =url: 'audio/track1.mp3'title: 'Track 1 by Some Artist'url: 'audio/track2.mp3'title: 'Some Other Artist - Track 2' ;ReactDOM;
The fastest way to get off the ground with this module is to paste the following code into an HTML file and open it in a web browser:
React Responsive Audio Player
Of course you'll need to include paths to actual audio files, or the player will display and not work.
npm install --save react-responsive-audio-player react react-dom
react-dom isn't technically a peer dependency, you'll need it if you plan to place the audio player in the DOM, which you probably will.
When you first include the component in your project it might not look how you're expecting. Be sure to check the Styling section below.
If you prefer not to use a package bundler, you can find built releases to download here.
Options can be passed to the AudioPlayer element as props. Currently supported props are:
playlist(required): an array containing data about the tracks which will be played. undefined by default. Each track object can contain the following properties:
url(required): A string containing the address of the audio file to play
title: The title of the track - corresponds to the
artist: The track's artist - corresponds to the
album: The album the track belongs to - corresponds to the
artwork: The artwork for the track - corresponds to the
MediaMetadata.artworkproperty NOTE: Network speed may affect how quickly album artwork shows up in system MediaSession notifications. You can try these strategies for implementing caching.
meta: An object containing any other track-specific information you want to store
NOTE: Although in version 1 it works to re-render the
AudioPlayerwith a mutated
playlistprop, this usage is now deprecated and will not work correctly in version 2. Please make a copy of the playlist instead. For more information, see here.
controls: an array of keyword strings which correspond to available audio control components. The order of keywords translates to the order of rendered controls. The default array is:
['spacer', 'backskip', 'playpause', 'forwardskip', 'spacer', 'progress']. The possible keyword values are:
'playpause'(play/pause toggle button)
'backskip'(previous track skip button)
'forwardskip'(next track skip button)
'progress'(a drag-to-seek audio progress bar)
'progressdisplay'(a read-only [non-draggable] progress bar)
'spacer'(a transparent space-filling element whose default width is
10px, although the style of the
.spacerclass can be overridden)
autoplay: a boolean value (
false) that if true will cause the player to begin automatically once mounted. false by default.
NOTE: Autoplaying audio or video is considered highly annoying in most contexts and is disabled by some browsers. Please use this option judiciously!
autoplayDelayInSeconds: a number value that represents the number of seconds to wait until beginning autoplay. Will be ignored if
autoplayis false. 0 by default. NOTE: Delay is managed by
setTimeoutand is therefore inexact. If you need to time an autoplay exactly, find a different module that uses the WebAudio API for playback (or fork this one!).
gapLengthInSeconds: a number value that represents the number of seconds to wait at the end of a track before beginning the next one in the playlist. Not applicable for manually-initiated skip. 0 by default. NOTE: Like
autoplayDelayInSeconds, this delay is inexact.
cycle: a boolean value that if true continues playing from the beginning after the playlist has completed. true by default.
stayOnBackSkipThreshold: a number value that represents the number of seconds of progress after which pressing the back button will simply restart the current track. 5 by default.
supportedMediaSessionActions: an array of Media Session API action names. This determines which system audio controls should be available on platforms supporting the Media Session API. It is not the same as the
controlsarray. The default array is:
['play', 'pause', 'previoustrack', 'nexttrack']. The possible values are:
'play'(ignored at present since systems should provide a default implementation regardless)
'pause'(ignored at present, for same reason as
mediaSessionSeekLengthInSeconds: a number value representing the number of seconds forward or backward to seek when handling the Media Session API
seekforwardactions. 10 by default.
getDisplayText: a function which takes a track object and returns a string used to represent that track in the UI. By default, the track will be displayed as "[artist] - [title]".
onMediaEvent: An object where the keys are media event types and the values are callback functions. undefined by default.
audioElementRef: A callback function called after the component mounts and before it unmounts. Similar to React ref callback prop but its only parameter is the internally-referenced HTML audio element, not the component itself. undefined by default. NOTE: This ref should not be used for audio element event listeners; use
crossOrigin: A string value corresponding to the
crossOriginmedia element attribute for adjusting CORS settings.
None of these options are required, though the player will be functionally disabled if no
playlist prop is provided.
These will be removed in v2.0! Please migrate away.
hideBackSkip: a boolean value that if true disables the back skip button by hiding it from view. false by default. Use the
hideForwardSkip: a boolean value that if true disables the forward skip button by hiding it from view. false by default. Use the
disableSeek: a boolean value that if true prevents seeking. false by default. Use the
displayTexton the track object for
playlist: a string value that determines the UI display name for a track. Instead, use
artistto provide information on a track object, and use the
getDisplayTextfunction prop for custom display if needed.
style: a React style object which is applied to the outermost div in the component. undefined by default.
Does this work with the Web Audio API?
We don't expose any special props for manipulating the Web Audio API with React.
However, you can use the
audioElementRef prop and
createMediaElementSource to process your audio before it gets sent to the speaker.
For example, you could use this code to add a low pass to high pass filter transition during the first 10 seconds your audio player is mounted:
You might need to set the
crossOrigin prop in order for Web Audio API processing to work correctly.
In order to use the default stylings you'll need to grab the compiled
audioplayer.css sheet from the module's
dist/ directory. Again, if you're not using npm, you can get the sheet here.
It's easy to override the default styles with CSS. Alternatively, for styles which only affect the outer element, you can use React inline styles.
For example, if you want your audio player to take the full screen width, do the following:
- Include the following code in your own CSS:
- Give your audio player fixed position styling, e.g.<AudioPlayer = />
Usage with SASS
If you preprocess your styles with Sass, you can have more powerful control via Sass variables. The defaults are located at the top of src/index.scss:
!default flag means you can override these variable definitions before the styles are included.
// Include var overrides before default styles import;// Using webpack css/sass module import syntax;// include other overrides afterward.audio_player
For building and testing instructions, see CONTRIBUTING.md.
Thanks to BrowserStack for providing their platform free of charge for this project (and many other open source projects). We're using BrowserStack to test compatibility across multiple browsers and platforms.