audio-channel-queue 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 TONY CARPENTER
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+# Audio Queue Package
+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.
+
+To preview this package and see how it works with visualized code examples, check out the demo that can be found here: _____.
+
+## How To Install This Package:
+Install this package by running either of these commands:
+- For npm run `npm install _____ --save?` (for typescript run `npm install ____ ____--save`)
+- For yarn run `yarn add _____` (for typescript run `yarn add ____ ____`)
+
+### How To Use This Package:
+```queueAudio(audioFileGoesHere);```
+Use the `queueAudio()` function to add a file to the queue and start playing it automatically. It takes two arguments:
+- The first argument is an imported sound file.
+- The second argument is optional and it allows you to choose a different queue channel. 
+
+```stopCurrentAudioInChannel(queueChannelNumberGoesHere);```
+Use the `stopCurrentAudioInChannel()` function to stop the current playback of a file in a queue and start playing the next one automatically. It takes one argument:
+- The first argument is optional and it allows you to choose a different queue channel. If you are only using the default channel, just use `stopCurrentAudioInChannel()`.
+
+```stopAllAudioInChannel(queueChannelNumberGoesHere);```
+Use the `stopAllAudioInChannel()` function to stop the current playback of all files in a queue and removes all enqueued files. It takes one argument:
+- The first argument is optional and it allows you to choose a different queue channel. If you are only using the default channel, just use `stopAllAudioInChannel()`.
+
+```stopAllAudio(queueChannelNumberGoesHere);```
+Use the `stopAllAudio()` function to stop the current playback of all files in all queues. It takes no arguments.
+
+If you need to expose the queue array for logging or other purposes, it is available to you as well: `audioChannels`.
+
+### Example Usage in React:
+
+`App.tsx`
+```
+import redTeamWins from './audio/red_team_wins.mp3';
+import { queueAudio } from './queue-audio-package ____';
+
+function App(): JSX.Element {
+
+  return (
+    <div>
+      <button onClick={()=> queueAudio(redTeamWins)}>Play sound</button>
+    </div>
+  )
+};
+
+export default App;
+```
+
+If you cannot import audio files into your app, you may need a `custom.d.ts` file in the root directory. An example of one is shown here:
+
+`custom.d.ts`
+```
+declare module '*.mp3' {
+  const src: string;
+  export default src;
+}
+```

package/dist/audio.d.ts

@@ -0,0 +1,9 @@
+export type AudioQueue = HTMLAudioElement[];
+export type AudioQueueChannel = {
+    queue: AudioQueue;
+};
+export declare const audioChannels: AudioQueueChannel[];
+export declare const queueAudio: (audioUrl: string, channelNumber?: number) => Promise<void>;
+export declare const stopCurrentAudioInChannel: (channelNumber?: number) => void;
+export declare const stopAllAudioInChannel: (channelNumber?: number) => void;
+export declare const stopAllAudio: () => void;

package/dist/audio.js

@@ -0,0 +1,65 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stopAllAudio = exports.stopAllAudioInChannel = exports.stopCurrentAudioInChannel = exports.queueAudio = exports.audioChannels = void 0;
+exports.audioChannels = [];
+const queueAudio = (audioUrl_1, ...args_1) => __awaiter(void 0, [audioUrl_1, ...args_1], void 0, function* (audioUrl, channelNumber = 0) {
+    if (!exports.audioChannels[channelNumber]) {
+        exports.audioChannels[channelNumber] = { queue: [] };
+    }
+    const audio = new Audio(audioUrl);
+    exports.audioChannels[channelNumber].queue.push(audio);
+    if (exports.audioChannels[channelNumber].queue.length === 1) {
+        return playAudioQueue(channelNumber);
+    }
+});
+exports.queueAudio = queueAudio;
+const playAudioQueue = (channelNumber) => __awaiter(void 0, void 0, void 0, function* () {
+    const channel = exports.audioChannels[channelNumber];
+    if (channel.queue.length === 0)
+        return;
+    const currentAudio = channel.queue[0];
+    return new Promise((resolve) => {
+        currentAudio.addEventListener('ended', () => __awaiter(void 0, void 0, void 0, function* () {
+            channel.queue.shift();
+            yield playAudioQueue(channelNumber);
+            resolve();
+        }));
+        currentAudio.play();
+    });
+});
+const stopCurrentAudioInChannel = (channelNumber = 0) => {
+    const channel = exports.audioChannels[channelNumber];
+    if (channel && channel.queue.length > 0) {
+        const currentAudio = channel.queue[0];
+        currentAudio.pause();
+        channel.queue.shift();
+        playAudioQueue(channelNumber);
+    }
+};
+exports.stopCurrentAudioInChannel = stopCurrentAudioInChannel;
+const stopAllAudioInChannel = (channelNumber = 0) => {
+    const channel = exports.audioChannels[channelNumber];
+    if (channel) {
+        if (channel.queue.length > 0) {
+            const currentAudio = channel.queue[0];
+            currentAudio.pause();
+        }
+        channel.queue = [];
+    }
+};
+exports.stopAllAudioInChannel = stopAllAudioInChannel;
+const stopAllAudio = () => {
+    exports.audioChannels.forEach((_channel, index) => {
+        (0, exports.stopAllAudioInChannel)(index);
+    });
+};
+exports.stopAllAudio = stopAllAudio;

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "audio-channel-queue",
+  "version": "1.0.0",
+  "description": "Allows you to queue audio files to different playback channels.",
+  "main": "dist/audio.js",
+  "types": "dist/audio.d.ts",
+  "files": ["dist", "src"],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tonycarpenter21/audio-queue-package.git"
+  },
+  "keywords": [
+    "audio",
+    "queue",
+    "channel",
+    "no dependencies"
+  ],
+  "author": "Tony Carpenter",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/tonycarpenter21/audio-queue-package/issues"
+  },
+  "homepage": "https://github.com/tonycarpenter21/audio-queue-package#readme",
+  "devDependencies": {
+    "typescript": "^5.6.2"
+  }
+}