audio-channel-queue 1.0.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -8
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
# Audio Queue Package
|
|
2
|
-
The purpose of this package is to help queue audio files so they do not play on top of each other.
|
|
2
|
+
The purpose of this package is to help queue audio files so they do not play on top of each other. You can also enqueue audio files to different queues. This allows you to play sounds concurrently, but not have them overlap in their given audio queue.
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
This package offers TypeScript support 📘, boasts zero dependencies 🚫, and is released under the MIT license 📜. As an added bonus, it's NON-GMO 🌱 and 100% Free Range Organic 🐓.
|
|
5
5
|
|
|
6
|
-
To preview this package and see how it works with visualized code examples, check out the demo that can be found here:
|
|
6
|
+
To preview this package and see how it works with visualized code examples, check out the demo that can be found here: [Audio Channel Queue Demo](https://tonycarpenter21.github.io/audio-queue-demo/). (A link to the demo repo can be found here: [Audio Channel Queue Demo Repo](https://github.com/tonycarpenter21/audio-queue-demo).)
|
|
7
|
+
|
|
8
|
+
NPM package can be found [here](https://www.npmjs.com/package/audio-channel-queue).
|
|
9
|
+
|
|
10
|
+
GitHub Repo can be found [here](https://github.com/tonycarpenter21/audio-channel-queue).
|
|
7
11
|
|
|
8
12
|
## How To Install This Package:
|
|
9
|
-
Install this package by running either of these commands:
|
|
10
|
-
- For npm run `npm install
|
|
11
|
-
- For yarn run `yarn add
|
|
13
|
+
Install this package by running either of these commands (typescript packages are included automatically):
|
|
14
|
+
- For npm run `npm install audio-channel-queue`
|
|
15
|
+
- For yarn run `yarn add audio-channel-queue`
|
|
12
16
|
|
|
13
17
|
### How To Use This Package:
|
|
14
18
|
```queueAudio(audioFileGoesHere);```
|
|
@@ -34,12 +38,12 @@ If you need to expose the queue array for logging or other purposes, it is avail
|
|
|
34
38
|
`App.tsx`
|
|
35
39
|
```
|
|
36
40
|
import redTeamWins from './audio/red_team_wins.mp3';
|
|
37
|
-
import { queueAudio } from '
|
|
41
|
+
import { queueAudio } from 'audio-channel-queue';
|
|
38
42
|
|
|
39
43
|
function App(): JSX.Element {
|
|
40
44
|
|
|
41
45
|
return (
|
|
42
|
-
<div>
|
|
46
|
+
<div className="App">
|
|
43
47
|
<button onClick={()=> queueAudio(redTeamWins)}>Play sound</button>
|
|
44
48
|
</div>
|
|
45
49
|
)
|
package/package.json
CHANGED
|
@@ -1,17 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "audio-channel-queue",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.0",
|
|
4
4
|
"description": "Allows you to queue audio files to different playback channels.",
|
|
5
5
|
"main": "dist/audio.js",
|
|
6
6
|
"types": "dist/audio.d.ts",
|
|
7
|
-
"files": [
|
|
7
|
+
"files": [
|
|
8
|
+
"dist",
|
|
9
|
+
"src"
|
|
10
|
+
],
|
|
8
11
|
"scripts": {
|
|
9
12
|
"build": "tsc",
|
|
10
13
|
"prepare": "npm run build"
|
|
11
14
|
},
|
|
12
15
|
"repository": {
|
|
13
16
|
"type": "git",
|
|
14
|
-
"url": "git+https://github.com/tonycarpenter21/audio-queue
|
|
17
|
+
"url": "git+https://github.com/tonycarpenter21/audio-channel-queue.git"
|
|
15
18
|
},
|
|
16
19
|
"keywords": [
|
|
17
20
|
"audio",
|