Compare commits
9
Commits
afe67ebdc1
...
v1.2.16
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f84a115e32 | ||
|
|
ac20d12b13 | ||
|
|
2b90b2775f | ||
|
|
00875123f5 | ||
|
|
04eba4de45 | ||
|
|
7bd03b5e5f | ||
|
|
fefad30ad5 | ||
|
|
9b14d8e9f0 | ||
|
|
2430f6e667 |
No files matched your search
@@ -6,11 +6,6 @@ on:
|
|||||||
permissions:
|
permissions:
|
||||||
contents: write
|
contents: write
|
||||||
|
|
||||||
env:
|
|
||||||
VERSION_MAJOR: '1'
|
|
||||||
VERSION_MINOR: '1'
|
|
||||||
VERSION_PATCH: ${{ gitea.run_number }}
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -33,8 +28,9 @@ jobs:
|
|||||||
run: npm ci
|
run: npm ci
|
||||||
|
|
||||||
- name: Set Release Version
|
- name: Set Release Version
|
||||||
id: version
|
|
||||||
run: npm run version:place
|
run: npm run version:place
|
||||||
|
env:
|
||||||
|
VERSION_PATCH: ${{ gitea.run_number }}
|
||||||
|
|
||||||
- name: Export Release Version
|
- name: Export Release Version
|
||||||
id: release_version
|
id: release_version
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ Create an [issue](https://git.lechner-systems.at/FrauJulian/Discord-Audio-Stream
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Node.js `>=24.17.0` and `<25` is required.
|
Node.js `>=22.12.0` and `<25` is required.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install discord-audio-stream @discordjs/voice @discordjs/opus
|
npm install discord-audio-stream @discordjs/voice @discordjs/opus
|
||||||
@@ -114,6 +114,7 @@ type AudioManagerOptions = {
|
|||||||
};
|
};
|
||||||
source?: { type: 'url'; url: string } | { type: 'file'; path: string };
|
source?: { type: 'url'; url: string } | { type: 'file'; path: string };
|
||||||
renewIntervalMs?: number | false;
|
renewIntervalMs?: number | false;
|
||||||
|
reconnectAttempts?: number;
|
||||||
connectTimeoutMs?: number;
|
connectTimeoutMs?: number;
|
||||||
onError?: (error: Error) => void;
|
onError?: (error: Error) => void;
|
||||||
volume?: {
|
volume?: {
|
||||||
@@ -124,15 +125,17 @@ type AudioManagerOptions = {
|
|||||||
```
|
```
|
||||||
|
|
||||||
`connectTimeoutMs` and numeric `renewIntervalMs` values must be whole milliseconds from `1` through `2_147_483_647`.
|
`connectTimeoutMs` and numeric `renewIntervalMs` values must be whole milliseconds from `1` through `2_147_483_647`.
|
||||||
|
`reconnectAttempts` must be a non-negative safe integer. URL sources must use `http:` or `https:`.
|
||||||
`volume.initialPercent` must be a finite number from `0` through `100` and requires `volume.enabled: true`.
|
`volume.initialPercent` must be a finite number from `0` through `100` and requires `volume.enabled: true`.
|
||||||
|
|
||||||
### Defaults
|
### Defaults
|
||||||
|
|
||||||
| Option | Default |
|
| Option | Default |
|
||||||
| ------------------ | ---------- |
|
| ------------------- | ---------- |
|
||||||
| `ffmpeg.mode` | `'native'` |
|
| `ffmpeg.mode` | `'native'` |
|
||||||
| `connectTimeoutMs` | `20_000` |
|
| `connectTimeoutMs` | `20_000` |
|
||||||
| `renewIntervalMs` | `false` |
|
| `renewIntervalMs` | `false` |
|
||||||
|
| `reconnectAttempts` | `0` |
|
||||||
| `volume.enabled` | `false` |
|
| `volume.enabled` | `false` |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
@@ -188,6 +191,9 @@ Connection renewal is disabled by default because `@discordjs/voice` handles rec
|
|||||||
`renewIntervalMs` only when an application has a measured need for periodic restarts. `stop()` and `dispose()` always
|
`renewIntervalMs` only when an application has a measured need for periodic restarts. `stop()` and `dispose()` always
|
||||||
clear the renewal timer.
|
clear the renewal timer.
|
||||||
|
|
||||||
|
After an unrecoverable disconnect, playback stops by default. Set `reconnectAttempts` to retry joining the configured
|
||||||
|
voice channel and restarting the current source.
|
||||||
|
|
||||||
## Errors
|
## Errors
|
||||||
|
|
||||||
The package exports these error classes:
|
The package exports these error classes:
|
||||||
|
|||||||
Generated
+2
-2
@@ -7,7 +7,7 @@
|
|||||||
"": {
|
"": {
|
||||||
"name": "discord-audio-stream",
|
"name": "discord-audio-stream",
|
||||||
"version": "x.x.x",
|
"version": "x.x.x",
|
||||||
"license": "LGPL-3.0-only",
|
"license": "AGPL-3.0-only",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@discordjs/opus": "^0.10.0",
|
"@discordjs/opus": "^0.10.0",
|
||||||
"@jest/globals": "^30.4.1",
|
"@jest/globals": "^30.4.1",
|
||||||
@@ -31,7 +31,7 @@
|
|||||||
"typescript": "npm:@typescript/typescript6@^6.0.2"
|
"typescript": "npm:@typescript/typescript6@^6.0.2"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=24.17.0 <25"
|
"node": ">=22.12.0 <25"
|
||||||
},
|
},
|
||||||
"funding": {
|
"funding": {
|
||||||
"url": "https://ko-fi.com/FrauJulian"
|
"url": "https://ko-fi.com/FrauJulian"
|
||||||
|
|||||||
+2
-2
@@ -2,7 +2,7 @@
|
|||||||
"$schema": "https://json.schemastore.org/package.json",
|
"$schema": "https://json.schemastore.org/package.json",
|
||||||
"name": "discord-audio-stream",
|
"name": "discord-audio-stream",
|
||||||
"version": "x.x.x",
|
"version": "x.x.x",
|
||||||
"license": "LGPL-3.0-only",
|
"license": "AGPL-3.0-only",
|
||||||
"description": "A small Discord voice audio streaming library with managed ffmpeg playback.",
|
"description": "A small Discord voice audio streaming library with managed ffmpeg playback.",
|
||||||
"exports": {
|
"exports": {
|
||||||
".": {
|
".": {
|
||||||
@@ -112,7 +112,7 @@
|
|||||||
"esbuild": "^0.28.2"
|
"esbuild": "^0.28.2"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=24.17.0 <25"
|
"node": ">=22.12.0 <25"
|
||||||
},
|
},
|
||||||
"private": false,
|
"private": false,
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
|
|||||||
+6
-9
@@ -3,6 +3,8 @@ const fs = require('fs');
|
|||||||
const lockFilePath = 'package-lock.json';
|
const lockFilePath = 'package-lock.json';
|
||||||
const packageFilePath = 'package.json';
|
const packageFilePath = 'package.json';
|
||||||
const placeholderVersion = 'x.x.x';
|
const placeholderVersion = 'x.x.x';
|
||||||
|
const versionMajor = 1;
|
||||||
|
const versionMinor = 2;
|
||||||
const command = process.argv[2];
|
const command = process.argv[2];
|
||||||
|
|
||||||
function readJson(path) {
|
function readJson(path) {
|
||||||
@@ -24,7 +26,7 @@ function getLockFile() {
|
|||||||
function writeVersions(version) {
|
function writeVersions(version) {
|
||||||
const pkg = readJson(packageFilePath);
|
const pkg = readJson(packageFilePath);
|
||||||
pkg.version = version;
|
pkg.version = version;
|
||||||
writeJson(packageFilePath, pkg, 2);
|
writeJson(packageFilePath, pkg, 4);
|
||||||
|
|
||||||
const lock = getLockFile();
|
const lock = getLockFile();
|
||||||
|
|
||||||
@@ -74,19 +76,14 @@ function fixPlaceholder() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function getCiVersion() {
|
function getCiVersion() {
|
||||||
const major = process.env.VERSION_MAJOR;
|
|
||||||
const minor = process.env.VERSION_MINOR;
|
|
||||||
const patch = process.env.VERSION_PATCH;
|
const patch = process.env.VERSION_PATCH;
|
||||||
const segments = { major, minor, patch };
|
|
||||||
|
|
||||||
for (const [name, value] of Object.entries(segments)) {
|
if (!/^\d+$/.test(patch ?? '')) {
|
||||||
if (!/^\d+$/.test(value ?? '')) {
|
console.error(`Missing or invalid patch version segment: "${patch ?? ''}"`);
|
||||||
console.error(`Missing or invalid ${name} version segment: "${value ?? ''}"`);
|
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
return `${major}.${minor}.${patch}`;
|
return `${versionMajor}.${versionMinor}.${patch}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (command === 'check-placeholder') {
|
if (command === 'check-placeholder') {
|
||||||
|
|||||||
+35
-1
@@ -48,6 +48,7 @@ export default class AudioManager implements Disposable {
|
|||||||
private connectAttempt: AbortController | undefined;
|
private connectAttempt: AbortController | undefined;
|
||||||
private renewTimer: NodeJS.Timeout | undefined;
|
private renewTimer: NodeJS.Timeout | undefined;
|
||||||
private playbackState: PlaybackState = 'idle';
|
private playbackState: PlaybackState = 'idle';
|
||||||
|
private reconnectGeneration = 0;
|
||||||
private connectionOptions: VoiceConnectionOptions | undefined;
|
private connectionOptions: VoiceConnectionOptions | undefined;
|
||||||
private audioSource: AudioSource | undefined;
|
private audioSource: AudioSource | undefined;
|
||||||
private readonly options: Required<Pick<AudioManagerOptions, 'connectTimeoutMs'>> &
|
private readonly options: Required<Pick<AudioManagerOptions, 'connectTimeoutMs'>> &
|
||||||
@@ -61,6 +62,13 @@ export default class AudioManager implements Disposable {
|
|||||||
assertValidTimerDelay(options.renewIntervalMs, 'renewIntervalMs');
|
assertValidTimerDelay(options.renewIntervalMs, 'renewIntervalMs');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
options.reconnectAttempts !== undefined &&
|
||||||
|
(!Number.isSafeInteger(options.reconnectAttempts) || options.reconnectAttempts < 0)
|
||||||
|
) {
|
||||||
|
throw new AudioManagerConfigError('reconnectAttempts must be a non-negative safe integer.');
|
||||||
|
}
|
||||||
|
|
||||||
if (options.volume?.initialPercent !== undefined) {
|
if (options.volume?.initialPercent !== undefined) {
|
||||||
if (options.volume.enabled !== true) {
|
if (options.volume.enabled !== true) {
|
||||||
throw new AudioManagerConfigError('volume.initialPercent requires volume.enabled to be true.');
|
throw new AudioManagerConfigError('volume.initialPercent requires volume.enabled to be true.');
|
||||||
@@ -254,6 +262,7 @@ export default class AudioManager implements Disposable {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
this.reconnectGeneration += 1;
|
||||||
this.cancelConnectAttempt();
|
this.cancelConnectAttempt();
|
||||||
this.clearRenewTimer();
|
this.clearRenewTimer();
|
||||||
this.stopCurrentPlayback();
|
this.stopCurrentPlayback();
|
||||||
@@ -285,6 +294,7 @@ export default class AudioManager implements Disposable {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
this.reconnectGeneration += 1;
|
||||||
this.cancelConnectAttempt();
|
this.cancelConnectAttempt();
|
||||||
this.clearRenewTimer();
|
this.clearRenewTimer();
|
||||||
this.stopCurrentPlayback();
|
this.stopCurrentPlayback();
|
||||||
@@ -307,8 +317,13 @@ export default class AudioManager implements Disposable {
|
|||||||
|
|
||||||
if (this.audioSource.type === 'url') {
|
if (this.audioSource.type === 'url') {
|
||||||
try {
|
try {
|
||||||
|
const url = new URL(this.audioSource.url);
|
||||||
|
if (url.protocol !== 'http:' && url.protocol !== 'https:') {
|
||||||
|
throw new Error('Unsupported audio source protocol.');
|
||||||
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
input: new URL(this.audioSource.url).toString(),
|
input: url.toString(),
|
||||||
source: this.audioSource,
|
source: this.audioSource,
|
||||||
};
|
};
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
@@ -361,6 +376,9 @@ export default class AudioManager implements Disposable {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private async handleDisconnectedConnection(connection: VoiceConnection): Promise<void> {
|
private async handleDisconnectedConnection(connection: VoiceConnection): Promise<void> {
|
||||||
|
const shouldReconnect = this.resource !== undefined && (this.options.reconnectAttempts ?? 0) > 0;
|
||||||
|
const reconnectGeneration = this.reconnectGeneration;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
await Promise.race([
|
await Promise.race([
|
||||||
entersState(connection, VoiceConnectionStatus.Signalling, DISCONNECT_RECOVERY_TIMEOUT_MS),
|
entersState(connection, VoiceConnectionStatus.Signalling, DISCONNECT_RECOVERY_TIMEOUT_MS),
|
||||||
@@ -371,6 +389,22 @@ export default class AudioManager implements Disposable {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (shouldReconnect) {
|
||||||
|
this.clearRenewTimer();
|
||||||
|
for (let attempt = 0; attempt < (this.options.reconnectAttempts ?? 0); attempt += 1) {
|
||||||
|
try {
|
||||||
|
await this.start();
|
||||||
|
return;
|
||||||
|
} catch (reconnectError) {
|
||||||
|
error = reconnectError;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.reconnectGeneration !== reconnectGeneration || this.playbackState === 'disposed') {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
this.clearRenewTimer();
|
this.clearRenewTimer();
|
||||||
this.stopCurrentPlayback();
|
this.stopCurrentPlayback();
|
||||||
this.audioPlayer.stop(true);
|
this.audioPlayer.stop(true);
|
||||||
|
|||||||
@@ -150,6 +150,12 @@ export type AudioManagerOptions = {
|
|||||||
*/
|
*/
|
||||||
renewIntervalMs?: number | false;
|
renewIntervalMs?: number | false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of full reconnect and playback restart attempts after an unrecoverable disconnect.
|
||||||
|
* Disabled by default. Must be a non-negative safe integer.
|
||||||
|
*/
|
||||||
|
reconnectAttempts?: number;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Maximum milliseconds to wait for the Discord voice connection to become ready.
|
* Maximum milliseconds to wait for the Discord voice connection to become ready.
|
||||||
* Must be an integer from `1` through `2_147_483_647`.
|
* Must be an integer from `1` through `2_147_483_647`.
|
||||||
|
|||||||
@@ -235,6 +235,28 @@ describe('AudioManager', () => {
|
|||||||
expect(manager.isConnected).toBe(false);
|
expect(manager.isConnected).toBe(false);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('reconnects and restarts playback when configured', async () => {
|
||||||
|
const manager = new AudioManager({
|
||||||
|
connection: connectionOptions,
|
||||||
|
source: liveStreamSource,
|
||||||
|
renewIntervalMs: false,
|
||||||
|
reconnectAttempts: 1,
|
||||||
|
});
|
||||||
|
await manager.start();
|
||||||
|
jest.mocked(entersState)
|
||||||
|
.mockRejectedValueOnce(new Error('disconnect'))
|
||||||
|
.mockRejectedValueOnce(new Error('disconnect'));
|
||||||
|
jest.mocked(joinVoiceChannel).mockReturnValueOnce(mockSecondVoiceConnection);
|
||||||
|
mockConnection.state.status = VoiceConnectionStatus.Disconnected;
|
||||||
|
|
||||||
|
await listenerFor(connectionListeners, VoiceConnectionStatus.Disconnected)();
|
||||||
|
|
||||||
|
expect(joinVoiceChannel).toHaveBeenCalledTimes(2);
|
||||||
|
expect(startFfmpeg).toHaveBeenCalledTimes(2);
|
||||||
|
expect(manager.state).toBe('playing');
|
||||||
|
expect(manager.isConnected).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
it('cleans up when connection startup fails', async () => {
|
it('cleans up when connection startup fails', async () => {
|
||||||
jest.useFakeTimers();
|
jest.useFakeTimers();
|
||||||
|
|
||||||
@@ -599,6 +621,18 @@ describe('AudioManager', () => {
|
|||||||
await expect(manager.play()).rejects.toThrow(AudioManagerConfigError);
|
await expect(manager.play()).rejects.toThrow(AudioManagerConfigError);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it.each(['file:///etc/passwd', 'ftp://example.com/audio.mp3'])('rejects non-HTTP URL source %s', async (url) => {
|
||||||
|
const manager = new AudioManager({
|
||||||
|
connection: connectionOptions,
|
||||||
|
source: { type: 'url', url },
|
||||||
|
renewIntervalMs: false,
|
||||||
|
});
|
||||||
|
|
||||||
|
await manager.connect();
|
||||||
|
await expect(manager.play()).rejects.toThrow(AudioManagerConfigError);
|
||||||
|
expect(startFfmpeg).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
it('applies initial volume only when volume support is enabled', async () => {
|
it('applies initial volume only when volume support is enabled', async () => {
|
||||||
const manager = new AudioManager({
|
const manager = new AudioManager({
|
||||||
connection: connectionOptions,
|
connection: connectionOptions,
|
||||||
|
|||||||
Reference in new issue
Block a user