document useAudioObject prop

souporserious · Oct 4, 2018 · a660c71 · a660c71
1 parent db96214
commit a660c71
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -43,6 +43,12 @@ Autoplay media when the component is mounted or `src` changes.
 
 Loop the current `src` indefinitely.
 
+#### `useAudioObject`: PropTypes.bool
+
+When playing HTML5 `audio`, it will construct audio using the
+[`Audio`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLAudioElement#Constructor)
+class instead of rendering an element to the page.
+
 #### `connectSource`: PropTypes.func(source, audioContext)
 
 A chance to connect a series of

diff --git a/src/vendors/HTML5.jsx b/src/vendors/HTML5.jsx
@@ -6,7 +6,10 @@ import vendorPropTypes from './vendor-prop-types'
 const audioContext = new (window.AudioContext || window.webkitAudioContext)()
 
 class HTML5 extends Component {
-  static propTypes = vendorPropTypes
+  static propTypes = {
+    ...vendorPropTypes,
+    useAudioObject: PropTypes.bool,
+  }
 
   get instance() {
     return this._player