├── .gitignore ├── LICENSE ├── README.md ├── classes └── player.js ├── package.json ├── utils ├── add.js ├── get.js ├── getAll.js ├── index.js └── store.js └── vue-sounds.js /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # vue-sounds 2 | A Vue.js plugin to play sounds. 3 | >Easy to add sounds to your components. 4 | 5 | ## Installation 6 | ```bash 7 | npm install vue-sounds --save 8 | ``` 9 | Or with yarn 10 | 11 | ```bash 12 | yarn add vue-sounds 13 | ``` 14 | 15 | ## Setup 16 | ```js 17 | import Vue from 'vue' 18 | import store from './store' 19 | import sounds from "vue-sounds"; 20 | Vue.use(sounds, store); 21 | ``` 22 | ## Usage 23 | ### Adding audio clip 24 | There are two methods to do that 25 | #### Adding then when the user enters the website 26 | You pass them in the option parameter 27 | ```js 28 | Vue.use(sounds, store, { 29 | sounds:[ 30 | {name:"", url:""}, 31 | .... 32 | ] 33 | }); 34 | ``` 35 | Note that name field must be unique for every audio clip. 36 | 37 | #### Dynamically adding clips 38 | In any components you will have access to ```$sounds``` object: 39 | ```js 40 | this.$sounds.add("name", "url"); 41 | ``` 42 | ## The $sounds object 43 | This will give you access to these methods: 44 | **Method**|**Parameters**|**Return type**|**Description** 45 | ----|----|----|---- 46 | get | soundName {string} | ```Player``` object | this will search for an audio with the given name and returns a player object for that audio clip. 47 | add | soundName {string} and url {string} | ```void```| it will add a new audio clip to the store. 48 | getAll | no parameters| Array with {name, url} objects |returns all of the audio clips in the store. 49 | 50 | ### Play sounds 51 | Before you can play sounds you have to create a ```Player``` object to do so, the plugin gives you access to ```get``` method 52 | ```js 53 | this.$sounds.get("name"); 54 | ``` 55 | This will return a Player object that gives you access to these method: 56 | **Method**|**Parameters**|**Return type**|**Description** 57 | ----|----|----|---- 58 | play | no parameters| ```Promise```|play the clip. 59 | pause | no parameters| ```Promise```|pause the clip. 60 | stop | no parameters| ```Promise```|stops the clip. 61 | volume | optional vol {Number} range (0-1) | number | sets the volume to vol and returns it, if vol is undefined returns the current volume. 62 | 63 | It will also throw an error if you try to get a clip that doesn't exist. 64 | -------------------------------------------------------------------------------- /classes/player.js: -------------------------------------------------------------------------------- 1 | class Player { 2 | constructor(url) { 3 | this.audio = new Audio(url); 4 | } 5 | play() { 6 | return this.audio.play(); 7 | } 8 | 9 | pause() { 10 | return this.audio.pause(); 11 | } 12 | 13 | stop() { 14 | this.audio.pause(); 15 | this.audio.currentTime = 0; 16 | } 17 | volume(vol) { 18 | if (typeof vol !== "undefined") { 19 | if (typeof vol !== "number") 20 | throw new Error("Type of vol must be number"); 21 | else if (vol > 1 || vol < 0) 22 | throw new Error("vol must be in range 0-1"); 23 | this.audio.volume = vol; 24 | } 25 | return this.audio.volume; 26 | } 27 | } 28 | 29 | export default Player; 30 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "vue-sounds", 3 | "keywords": [ 4 | "sounds", 5 | "audio", 6 | "vue", 7 | "mp3" 8 | ], 9 | "homepage": "https://github.com/redcodemohammed/vue-sounds", 10 | "version": "0.0.8", 11 | "description": "A Vue.js plugin to play sounds.", 12 | "main": "vue-sounds.js", 13 | "repository": { 14 | "url": "https://github.com/redcodemohammed/vue-sounds.git", 15 | "type": "git" 16 | }, 17 | "author": "redcodemohammed ", 18 | "license": "MIT", 19 | "private": false 20 | } 21 | -------------------------------------------------------------------------------- /utils/add.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @param {String} audioName - A unique name for the audio clip. 3 | * @param {String} url - A url that leads to the audio file. 4 | */ 5 | export default function (audioName, url) { 6 | //check if the name is valid: 7 | if (typeof audioName !== "string" || audioName.length <= 0) { 8 | throw new Error("Invalid audioName"); 9 | } 10 | 11 | //check if the name is not used before: 12 | if (this.store.getters.getSingleSound(audioName)) { 13 | throw new Error("The name of each audio must be unique"); 14 | } 15 | 16 | let urlRegEx = /(https?:\/\/(www.)?[-a-zA-Z0-9@:%.+~#=]{1,256}.[a-zA-Z0-9()]{1,6}\b)?([-a-zA-Z0-9()@:%+.~#?&//=]*)/gi; 17 | if (typeof url !== "string" || url.length <= 0 || !urlRegEx.test(url)) { 18 | throw new Error("Invalid url"); 19 | } 20 | 21 | //add it to the store: 22 | this.store.dispatch("addSounds", { 23 | name: audioName, 24 | url, 25 | }); 26 | } 27 | -------------------------------------------------------------------------------- /utils/get.js: -------------------------------------------------------------------------------- 1 | import Player from "../classes/player"; 2 | 3 | /** 4 | * @param {String} audioName - The name of the audio clip you want to get. 5 | */ 6 | export default function (audioName) { 7 | //check if the name is valid: 8 | if (typeof audioName !== "string" || audioName.length <= 0) { 9 | throw new Error("Invalid audioName"); 10 | } 11 | 12 | // find the audio object: 13 | let audioObject = this.store.getters.getSingleSound(audioName); 14 | if (!audioObject) throw new Error("No such an audio clip, try to add it first"); 15 | 16 | return new Player(audioObject.url); 17 | } 18 | -------------------------------------------------------------------------------- /utils/getAll.js: -------------------------------------------------------------------------------- 1 | export default function () { 2 | return this.store.getters.getAllSounds; 3 | } 4 | -------------------------------------------------------------------------------- /utils/index.js: -------------------------------------------------------------------------------- 1 | import add from "./add"; 2 | import get from "./get"; 3 | import storeModule from "./store"; 4 | import getAll from "./getAll"; 5 | 6 | class VueSounds { 7 | constructor(store, options) { 8 | //make sure there is a store: 9 | if (typeof store !== "object") { 10 | throw new Error("Please pass a valid vuex store to the plugin."); 11 | } 12 | 13 | //create a new store module: 14 | store.registerModule("VueSounds", storeModule); 15 | 16 | this.store = store; 17 | this.get = get; 18 | this.add = add; 19 | this.getAll = getAll; 20 | 21 | //add sounds to the store: 22 | let sounds = typeof options === "undefined" ? undefined : options.sounds; 23 | if (sounds && sounds.length > 0) 24 | sounds.forEach(sound => this.add(sound.name, sound.url)); 25 | } 26 | } 27 | 28 | export default VueSounds; 29 | -------------------------------------------------------------------------------- /utils/store.js: -------------------------------------------------------------------------------- 1 | export default { 2 | state: { 3 | sounds: [] 4 | }, 5 | getters: { 6 | getAllSounds(state) { 7 | return state.sounds; 8 | }, 9 | getSingleSound: state => name => state.sounds.find(sound => sound.name === name) 10 | }, 11 | actions: { 12 | addSounds({ commit }, ...sound) { 13 | commit("addSounds", ...sound) 14 | } 15 | }, 16 | mutations: { 17 | addSounds(state, ...sound) { 18 | state.sounds.push(...sound); 19 | } 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /vue-sounds.js: -------------------------------------------------------------------------------- 1 | import vueSounds from "./utils/index"; 2 | 3 | // This is your plugin object. It can be exported to be used anywhere. 4 | const VueSounds = { 5 | // The install method is all that needs to exist on the plugin object. 6 | // It takes the global Vue object as well as user-defined options. 7 | install(Vue, store, options) { 8 | Vue.prototype.$sounds = new vueSounds(store, options); 9 | } 10 | }; 11 | 12 | export default VueSounds; 13 | --------------------------------------------------------------------------------