react-audio-player

A simple React wrapper on the HTML5 audio tag

Github星跟踪图

React Audio Player

This is a light React wrapper around the HTML5 audio tag. It provides the ability to manipulate the player and listen to events through a nice React interface.

Installation

npm install --save react-audio-player

Also be sure you have react and react-dom installed in your app at version 15 or above.

Usage

import ReactAudioPlayer from 'react-audio-player';
//...
<ReactAudioPlayer
  src="my_audio_file.ogg"
  autoPlay
  controls
/>

Example

See the example directory for a basic working example of using this project. To run it locally, run npm install in the example directory and then npm start.

Props

Props - Native/React Attributes

See the audio tag documentation for detailed explanations of these attributes.

autoPlay {Bool} [false]

children {Element} [null]

className {String} ['']

controls {Bool} [false]

crossOrigin {String} ['']

See MDN's article on CORS for more about this attribute.

controlsList {String} ['']

For Chrome 58+. Only available in React 15.6.2+

id {String} ['']

loop {Bool} [false]

muted {Bool} [false]

volume {Number} [1.0]

preload {String} ['metadata']

src {String} ['']

style {Object} [{}]

Props - Events

listenInterval {Number} [10000]

Indicates how often to call the onListened prop during playback, in milliseconds.

onAbort {Function}

Called when unloading the audio player, like when switching to a different src file. Passed the event.

onCanPlay {Function}

Called when enough of the file has been downloaded to be able to start playing. Passed the event.

onCanPlayThrough {Function}

Called when enough of the file has been downloaded to play through the entire file. Passed the event.

onEnded {Function}

Called when playback has finished to the end of the file. Passed the event.

onError {Function}

Called when the audio tag encounters an error. Passed the event.

onListen {Function}

Called every listenInterval milliseconds during playback. Passed the event.

onPause {Function}

Called when the user pauses playback. Passed the event.

onPlay {Function}

Called when the user taps play. Passed the event.

onSeeked {Function}

Called when the user drags the time indicator to a new time. Passed the event.

onVolumeChanged {Function}

Called when the user changes the volume, such as by dragging the volume slider.

onLoadedMetadata {Function}

Called when the metadata for the given audio file has finished downloading. Passed the event.

Advanced Usage

Access to the audio element

You can get direct access to the underlying audio element. First get a ref to ReactAudioPlayer:

<ReactAudioPlayer
  ref={(element) => { this.rap = element; }}
/>

Then you can access the audio element like this:

this.rap.audioEl

This is especially useful if you need access to read-only attributes of the audio tag such as buffered and played. See the audio tag documentation for more on these attributes.

主要指标

概览
名称与所有者justinmc/react-audio-player
主编程语言TypeScript
编程语言JavaScript (语言数: 3)
平台
许可证MIT License
所有者活动
创建于2016-03-13 06:38:56
推送于2023-11-12 09:25:30
最后一次提交2021-04-18 23:22:12
发布数31
最新版本名称v0.17.0 (发布于 2021-04-18 23:22:12)
第一版名称v0.2.3 (发布于 2016-08-19 08:31:40)
用户参与
星数595
关注者数7
派生数103
提交数187
已启用问题?
问题数65
打开的问题数31
拉请求数43
打开的拉请求数37
关闭的拉请求数26
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?