totole/vue-audio-recorder
1
0
Fork 0
mirror of https://github.com/kevin-DL/vue-audio-recorder.git synced 2026-01-11 19:04:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Gennady Grishkovtsov
2018-10-05 22:51:55 +03:00
parent 52b7dfe958
commit 420cf2e194
1 changed files with 3 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -15,7 +15,7 @@
- A lot of callbacks - A lot of callbacks
- Individual an audio player - Individual an audio player
### Tested in ### Tested in (desktop)
- Chrome - Chrome
- Firefox - Firefox
@@ -33,6 +33,7 @@ npm i vue-audio-recorder --save
| --------------------- | -------- | --------------------------------------------------------------- | | --------------------- | -------- | --------------------------------------------------------------- |
| attempts | Number | Number of recording attempts | | attempts | Number | Number of recording attempts |
| compact | Boolean | Hide the download and upload buttons | | compact | Boolean | Hide the download and upload buttons |
| headers | Object | HTTP headers |
| time | Number | Time limit for the record (minutes) | | time | Number | Time limit for the record (minutes) |
| upload-url | String | URL for uploading | | upload-url | String | URL for uploading |
| start-record | Function | Fires after click the record button | | start-record | Function | Fires after click the record button |
@@ -52,17 +53,6 @@ npm i vue-audio-recorder --save
## Usage ## Usage
The most common use case is to register the component globally
```js
import {AudioRecorder, AudioPlayer} from 'vue-audio-recorder'
Vue.component(AudioPlayer)
Vue.component(AudioRecorder)
```
Alternatively you can do this to register the components
```js ```js
import AudioRecorder from 'vue-audio-recorder' import AudioRecorder from 'vue-audio-recorder'
@@ -73,6 +63,7 @@ Alternatively you can do this to register the components
<audio-recorder <audio-recorder
upload-url="YOUR_API_URL" upload-url="YOUR_API_URL"
:attempts="3" :attempts="3"
:headers="headers"
:time="2" :time="2"
:start-record="callback" :start-record="callback"
:stop-record="callback" :stop-record="callback"