Compare commits

..
6 Commits
Author SHA1 Message Date
fraujulian afe67ebdc1 docs(errors): distinguish rejected operations
Build Validation / build (push) Successful in 41s
2026-08-24 15:27:44 +02:00
fraujulian c4cd464bfa docs(api): clarify setter behavior 2026-08-24 15:27:05 +02:00
fraujulian 08b103a26b docs(api): document option validation 2026-08-24 15:26:16 +02:00
fraujulian f83d78ab4e ci(node): pin Node.js 24.17 2026-08-24 15:25:19 +02:00
fraujulian 242de19cf2 build(node): require Node.js 24.17 2026-08-24 15:24:41 +02:00
fraujulian 36f546eaba docs(readme): refresh project badges 2026-08-24 15:23:41 +02:00
6 changed files with 19 additions and 12 deletions
+2 -2
View File
@@ -22,10 +22,10 @@ jobs:
fetch-depth: 0
fetch-tags: true
- name: Use NodeJS 24
- name: Use Node.js 24.17.0
uses: actions/setup-node@v6
with:
node-version: '24'
node-version: '24.17.0'
registry-url: 'https://registry.npmjs.org'
package-manager-cache: false
+2 -2
View File
@@ -15,10 +15,10 @@ jobs:
- name: Checkout Repository
uses: actions/checkout@v4
- name: use NodeJS 24
- name: Use Node.js 24.17.0
uses: actions/setup-node@v4
with:
node-version: '24'
node-version: '24.17.0'
- name: Install Dependencies
run: npm ci
+10 -5
View File
@@ -1,8 +1,8 @@
# Discord Audio Stream
[![npm](https://img.shields.io/npm/dw/discord-audio-stream)](http://npmjs.org/package/discord-audio-stream)
[![npm](https://img.shields.io/npm/dw/discord-audio-stream)](https://www.npmjs.com/package/discord-audio-stream)
![latest release](https://img.shields.io/gitea/v/release/FrauJulian/Discord-Audio-Stream?gitea_url=https%3A%2F%2Fgit.lechner-systems.at&color=blue)
![Gitea Repo stars](https://img.shields.io/gitea/stars/FrauJulian/Discord-Audio-Stream?gitea_url=https%3A%2F%2Fgit.lechner-systems.at&style=social)
![Github Repo stars](https://img.shields.io/github/stars/FrauJulian/Discord-Audio-Stream?github_url=https%3A%2F%2Fgithub.com&style=social)
`discord-audio-stream` is a small TypeScript library for managed Discord voice playback through
`@discordjs/voice` and ffmpeg.
@@ -18,7 +18,7 @@ Create an [issue](https://git.lechner-systems.at/FrauJulian/Discord-Audio-Stream
## Installation
Node.js `24.x` is required.
Node.js `>=24.17.0` and `<25` is required.
```bash
npm install discord-audio-stream @discordjs/voice @discordjs/opus
@@ -123,6 +123,9 @@ type AudioManagerOptions = {
};
```
`connectTimeoutMs` and numeric `renewIntervalMs` values must be whole milliseconds from `1` through `2_147_483_647`.
`volume.initialPercent` must be a finite number from `0` through `100` and requires `volume.enabled: true`.
### Defaults
| Option | Default |
@@ -136,8 +139,8 @@ type AudioManagerOptions = {
| Method | Description |
| ------------------------ | ---------------------------------------------------------------------------------- |
| `setConnection(options)` | Replaces the voice connection target. |
| `setSource(source)` | Replaces the audio source. |
| `setConnection(options)` | Sets the target for the next `connect()` or `start()` call. |
| `setSource(source)` | Sets the source for the next `play()` or `start()` call. |
| `connect()` | Joins the configured Discord voice channel. |
| `play(source?)` | Starts playback on an existing connection. |
| `start()` | Connects and starts playback. |
@@ -200,6 +203,8 @@ operations, such as calling `pause()` while nothing is playing, throw `AudioMana
Use `onError` to observe asynchronous audio player and voice connection errors. The manager cleans up failed playback
and unrecoverable connections before invoking the callback.
`onError` does not handle rejected `connect()`, `play()`, or `start()` calls. Await and catch those calls explicitly.
## Development
```bash
+1 -1
View File
@@ -31,7 +31,7 @@
"typescript": "npm:@typescript/typescript6@^6.0.2"
},
"engines": {
"node": "24.x"
"node": ">=24.17.0 <25"
},
"funding": {
"url": "https://ko-fi.com/FrauJulian"
+1 -1
View File
@@ -112,7 +112,7 @@
"esbuild": "^0.28.2"
},
"engines": {
"node": "24.x"
"node": ">=24.17.0 <25"
},
"private": false,
"publishConfig": {
+3 -1
View File
@@ -112,7 +112,7 @@ export type VolumeOptions = {
/**
* Initial volume percentage applied when playback starts.
*
* Requires `enabled: true`.
* Must be a finite number from `0` through `100` and requires `enabled: true`.
*/
initialPercent?: number;
};
@@ -144,6 +144,7 @@ export type AudioManagerOptions = {
* Milliseconds after which the manager reconnects and restarts playback.
*
* Renewal is disabled unless an interval is provided.
* Numeric values must be integers from `1` through `2_147_483_647`.
*
* @defaultValue `false`
*/
@@ -151,6 +152,7 @@ export type AudioManagerOptions = {
/**
* Maximum milliseconds to wait for the Discord voice connection to become ready.
* Must be an integer from `1` through `2_147_483_647`.
*
* @defaultValue `20_000`
*/