streamify-audio 2.2.1 → 2.2.5

package/.github/workflows/npm-publish-github-packages.yml

@@ -0,0 +1,36 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test
+
+  publish-gpr:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://npm.pkg.github.com/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/README.md

@@ -33,6 +33,21 @@ Both modes share the same providers, filters, and streaming engine.
 
 ---
 
+## 🎵 Supported Sources
+
+Streamify is built to be a universal audio engine. It supports:
+
+- **YouTube**: Videos, Music, Shorts, Live, Playlists
+- **Spotify**: Tracks, Albums, Playlists (resolved to YouTube)
+- **SoundCloud**: Tracks
+- **Twitch**: Live streams
+- **Mixcloud**: Mixes and DJ sets
+- **Bandcamp**: Tracks and Albums
+- **Direct URLs**: Public raw audio links (MP3, OGG, WAV, etc.)
+- **Local Files**: Absolute or relative paths on the host system
+
+---
+
 ## 🚀 Quick Start
 
 ```bash
@@ -135,6 +150,13 @@ When running in HTTP mode, Streamify exposes a REST API:
 | `GET` | `/spotify/stream/:id` | Stream Spotify track |
 | `GET` | `/soundcloud/search?q=query` | Search SoundCloud |
 | `GET` | `/soundcloud/stream/:id` | Stream SoundCloud track |
+| `GET` | `/twitch/stream/:channel` | Stream Twitch live |
+| `GET` | `/mixcloud/stream/:id` | Stream Mixcloud set |
+| `GET` | `/bandcamp/stream/:id` | Stream Bandcamp track |
+| `GET` | `/http/stream/:base64_url` | Stream from direct URL |
+| `GET` | `/local/stream/:base64_path` | Stream local file |
+| `GET` | `/search?q=query&source=...` | Generic search across providers |
+| `GET` | `/stream/:source/:id` | Generic stream endpoint |
 
 ### Stream Parameters
 
@@ -171,23 +193,51 @@ audio.play();
 | Feature | Discord | HTTP |
 |---------|:-------:|:----:|
 | 🎵 YouTube, Spotify, SoundCloud | ✅ | ✅ |
+| 🎮 Twitch, Mixcloud, Bandcamp | ✅ | ✅ |
+| 📁 Local Files & Direct URLs | ✅ | ✅ |
+| 📺 **Voice Channel Status** | ✅ | — |
+| 🔍 **Advanced Search Filters** | ✅ | ✅ |
 | 📋 Playlists & Albums | ✅ | ✅ |
-| 🎚️ 25+ Audio Filters | ✅ | ✅ |
+| 🎚️ 30+ Stackable Filters | ✅ | ✅ |
 | 🎛️ 15-Band Equalizer | ✅ | ✅ |
 | 🎨 15 EQ Presets | ✅ | ✅ |
+| 🔄 **Seamless Transitions** | ✅ | ✅ |
 | ⏭️ Instant Skip (prefetch) | ✅ | — |
 | ⏸️ Auto-pause when alone | ✅ | — |
 | ▶️ Auto-resume on rejoin | ✅ | — |
 | 🚪 Auto-leave on inactivity | ✅ | — |
-| 📻 Autoplay related tracks | ✅ | — |
 | 🚫 Sponsorblock | ✅ | ✅ |
-| 📊 Stream position tracking | ✅ | ✅ |
+| 📊 Timing & Performance Logs | ✅ | ✅ |
 | 🔌 No Lavalink/Java needed | ✅ | ✅ |
 
 ---
 
 ## 🎮 Discord Player Features
 
+### Voice Channel Status
+
+Show what's playing directly in the sidebar of the voice channel.
+
+```javascript
+const manager = new Streamify.Manager(client, {
+    voiceChannelStatus: {
+        enabled: true,
+        template: '🎶 Playing: {title} | {requester}'
+    }
+});
+```
+
+### Search with Filters
+
+Filter for live streams or sort results by popularity/date.
+
+```javascript
+const results = await manager.search('lofi hip hop', {
+    type: 'live',
+    sort: 'popularity'
+});
+```
+
 ### Queue Management
 
 ```javascript
@@ -297,6 +347,10 @@ const url = streamify.getStreamUrl('youtube', 'dQw4w9WgXcQ', {
 | `volume` | 0 to 200 | Volume % |
 | `nightcore` | boolean | Speed + pitch up |
 | `vaporwave` | boolean | Speed + pitch down |
+| `subboost` | boolean | Extreme sub-bass boost |
+| `reverb` | boolean | Room acoustics effect |
+| `surround` | boolean | Surround sound mapping |
+| `boost` | boolean | Clarity & volume boost |
 | `8d` | boolean | Rotating audio |
 | `karaoke` | boolean | Reduce vocals |
 | `bassboost` | boolean | Heavy bass |
@@ -349,7 +403,10 @@ const manager = new Streamify.Manager(client, {
     providers: {
         youtube: { enabled: true },
         spotify: { enabled: true },
-        soundcloud: { enabled: false }  // Disable SoundCloud
+        soundcloud: { enabled: true },
+        twitch: { enabled: true },
+        mixcloud: { enabled: true },
+        bandcamp: { enabled: true }
     },
     spotify: {
         clientId: 'your_client_id',
@@ -357,7 +414,14 @@ const manager = new Streamify.Manager(client, {
     },
     audio: {
         bitrate: '128k',
-        format: 'opus'
+        format: 'opus',
+        vbr: true,
+        compressionLevel: 10,
+        application: 'audio'
+    },
+    ytdlp: {
+        format: 'bestaudio/best',
+        additionalArgs: []
     },
     defaultVolume: 80,
     maxPreviousTracks: 25,
@@ -380,7 +444,10 @@ const streamify = new Streamify({
     providers: {
         youtube: { enabled: true },
         spotify: { enabled: true },
-        soundcloud: { enabled: true }
+        soundcloud: { enabled: true },
+        twitch: { enabled: true },
+        mixcloud: { enabled: true },
+        bandcamp: { enabled: true }
     },
     spotify: {
         clientId: 'your_client_id',
@@ -388,7 +455,14 @@ const streamify = new Streamify({
     },
     audio: {
         bitrate: '128k',
-        format: 'opus'
+        format: 'opus',
+        vbr: true,
+        compressionLevel: 10,
+        application: 'audio'
+    },
+    ytdlp: {
+        format: 'bestaudio/best',
+        additionalArgs: []
     },
     logLevel: 'info'
 });

package/docs/configuration.md

@@ -27,7 +27,16 @@ const manager = new Streamify.Manager(client, {
     // Audio settings
     audio: {
         bitrate: '128k',      // Audio bitrate
-        format: 'opus'        // opus, mp3, aac
+        format: 'opus',       // opus, mp3, aac
+        vbr: true,            // Enable Variable Bitrate (Opus only)
+        compressionLevel: 10, // Opus compression level (0-10)
+        application: 'audio'  // Opus application (audio, voip, lowdelay)
+    },
+
+    // yt-dlp settings
+    ytdlp: {
+        format: 'bestaudio/best', // Custom yt-dlp format string
+        additionalArgs: []        // Extra arguments for yt-dlp (e.g. proxy)
     },
 
     // Defaults
@@ -57,10 +66,21 @@ const manager = new Streamify.Manager(client, {
     autoplay: {
         enabled: false,
         maxTracks: 5              // Related tracks to fetch
+    },
+
+    // Voice Channel Status
+    voiceChannelStatus: {
+        enabled: true,            // Show "Now Playing" in VC description
+        template: '🎶 Now Playing: {title} - {artist}' // Custom template
     }
 });
 ```
 
+**Voice Channel Status Template Variables:**
+- `{title}` - Track title
+- `{artist}` - Track artist/author
+- `{requester}` - Username of the requester (if provided)
+
 ## HTTP Server Mode
 
 ```javascript
@@ -94,7 +114,16 @@ const streamify = new Streamify({
     // Audio
     audio: {
         bitrate: '128k',
-        format: 'opus'
+        format: 'opus',
+        vbr: true,
+        compressionLevel: 10,
+        application: 'audio'
+    },
+
+    // yt-dlp
+    ytdlp: {
+        format: 'bestaudio/best',
+        additionalArgs: []
     },
 
     // Logging

package/docs/discord/manager.md

@@ -70,15 +70,22 @@ process.on('SIGINT', () => {
 
 Searches for tracks.
 
-```javascript
-// Basic search (YouTube)
-const result = await manager.search('never gonna give you up');
+- `query` (string) - The search term or URL
+- `options` (object) - Search configuration
+    - `source` (string) - `youtube`, `spotify`, `soundcloud`, `twitch`, `mixcloud`, `bandcamp`, `local`, `http`
+    - `limit` (number) - Number of results (default: 10)
+    - `type` (string) - `video`, `live`, or `all` (YouTube only)
+    - `sort` (string) - `relevance`, `popularity`, `date`, or `rating` (YouTube only)
+
+**Example:**
 
-// With options
-const result = await manager.search('never gonna give you up', {
-    source: 'spotify',  // youtube, spotify, soundcloud
-    limit: 10
+```javascript
+const result = await manager.search('lofi hip hop', {
+    source: 'youtube',
+    type: 'live',
+    sort: 'popularity'
 });
+```
 
 // Result
 {

package/docs/discord/player.md

@@ -14,7 +14,7 @@ const player = manager.get(guildId);
 
 ## Playback Methods
 
-### play(track)
+### play(track, options?)
 
 Plays a track immediately. If something is playing, adds to queue and skips.
 
@@ -23,6 +23,34 @@ const result = await manager.search('never gonna give you up');
 await player.play(result.tracks[0]);
 ```
 
+**Options:**
+- `startPosition` - Start playback at a specific position in milliseconds
+- `volume` - Set volume before playing (0-200)
+- `filters` - Apply filters before playing
+- `replace` - Replace current track without adding to queue/history
+
+```javascript
+// Start playing at 30 seconds
+await player.play(track, { startPosition: 30000 });
+
+// Start with specific volume
+await player.play(track, { volume: 50 });
+
+// Start with filters applied
+await player.play(track, { filters: { bass: 10, nightcore: true } });
+
+// Replace current track without queueing
+await player.play(track, { replace: true });
+
+// Combine options
+await player.play(track, {
+    startPosition: savedPositionMs,
+    volume: savedVolume,
+    filters: savedFilters,
+    replace: true
+});
+```
+
 ### pause()
 
 Pauses playback and destroys the stream to save resources.
@@ -97,6 +125,61 @@ console.log(player.filters);  // { bass: 10, nightcore: true }
 
 See [Filters](../filters.md) for all available filters.
 
+## Effect Presets
+
+Effect presets are pre-configured filter combinations that stack by default.
+
+```javascript
+// Apply a single preset
+await player.setEffectPresets(['bassboost']);
+
+// Apply multiple presets (they stack)
+await player.setEffectPresets(['nightcore', 'bassboost']);
+
+// Apply with custom intensity (0.1 - 1.0)
+await player.setEffectPresets([
+    { name: 'nightcore', intensity: 0.8 },
+    { name: 'bassboost', intensity: 0.5 }
+]);
+
+// Replace all presets instead of stacking
+await player.setEffectPresets(['8d'], { replace: true });
+
+// Get active presets
+const active = player.getActiveEffectPresets();
+// [{ name: 'nightcore', intensity: 0.8 }, { name: 'bassboost', intensity: 0.5 }]
+
+// Clear all effect presets
+await player.clearEffectPresets();
+
+// List available presets
+const presets = player.getEffectPresets();
+// ['bassboost', 'nightcore', 'vaporwave', '8d', 'karaoke', ...]
+```
+
+**Available Presets:**
+- `bassboost` - Boost bass frequencies
+- `nightcore` - Speed up with higher pitch
+- `vaporwave` - Slow down with lower pitch
+- `8d` - 8D rotating audio effect
+- `karaoke` - Reduce vocals
+- `reverb` - Add room acoustics / echo
+- `surround` - Virtual surround sound mapping
+- `boost` - General volume and clarity boost
+- `subboost` - Extreme sub-woofer boost
+- `trebleboost` - Boost treble frequencies
+- `deep` - Deep bass with lower pitch
+- `lofi` - Lo-fi aesthetic
+- `radio` - Radio/telephone effect
+- `telephone` - Old telephone effect
+- `soft` - Softer, quieter sound
+- `loud` - Louder, compressed sound
+- `chipmunk` - High-pitched voice
+- `darth` - Deep Darth Vader voice
+- `echo` - Echo/reverb effect
+- `vibrato` - Vibrato effect
+- `tremolo` - Tremolo effect
+
 ## Loop Modes
 
 ```javascript

package/docs/filters.md

@@ -1,6 +1,6 @@
 # Audio Filters
 
-Filters are applied in real-time via ffmpeg. When you change a filter during playback, Streamify recreates the stream and seeks to the current position.
+Filters are applied in real-time via ffmpeg. When you change a filter during playback, Streamify uses **Seamless Transitions** to prepare the new stream in the background and swap it instantly once ready, ensuring no audio gaps.
 
 ## Available Filters
 
@@ -287,6 +287,44 @@ await player.setFilter('peaking', {
 });
 ```
 
+## Effect Presets (Stacked)
+
+Streamify supports "Effect Presets" which can be stacked on top of each other. These are more powerful than standard filters because they can combine multiple FFmpeg settings.
+
+### Available Effect Presets
+
+| Preset | Description |
+|--------|-------------|
+| `bassboost` | Strong low-end boost |
+| `subboost` | Extreme sub-woofer boost |
+| `nightcore` | High speed and pitch |
+| `vaporwave` | Low speed and pitch |
+| `reverb` | Adds room acoustics / echo |
+| `surround` | Virtual surround sound mapping |
+| `boost` | General volume and clarity boost |
+| `karaoke` | Vocal reduction |
+| `8d` | Fast circular panning |
+
+### Usage
+
+```javascript
+// Set a single effect with intensity (0.0 to 2.0)
+await player.setEffectPresets({ name: 'reverb', intensity: 0.8 });
+
+// Stack multiple effects
+await player.setEffectPresets([
+    { name: 'bassboost', intensity: 1.2 },
+    { name: 'nightcore', intensity: 1.0 }
+]);
+
+// Clear all effects
+await player.clearEffectPresets();
+
+// Get active effects
+const active = player.getActiveEffectPresets();
+// [{ name: 'reverb', intensity: 0.8 }]
+```
+
 ## Additional Effects
 
 | Effect | Description |

package/docs/http/endpoints.md

@@ -100,6 +100,31 @@ GET /soundcloud/stream/:trackUrl
 
 Note: `trackUrl` should be URL-encoded.
 
+## Generic Routes
+
+### Search
+
+```
+GET /search?q=query&source=youtube&limit=10
+```
+
+**Query Parameters:**
+- `q` - Search query
+- `source` - `youtube`, `spotify`, `soundcloud`, `twitch`, `mixcloud`, `bandcamp`, `local`, `http`
+- `limit` - Number of results
+
+### Stream
+
+```
+GET /stream/:source/:id
+```
+
+**Example:**
+```
+GET /stream/twitch/monstercat
+GET /stream/local/L2hvbWUvdXNlci9tdXNpYy9zbmFyZS53YXY= (Base64 path)
+```
+
 ## Stream Management
 
 ### List Active Streams

package/docs/http/server.md

@@ -95,6 +95,8 @@ const results = await streamify.search('youtube', 'query', 10);
 const results = await streamify.youtube.search('query');
 const results = await streamify.spotify.search('query');
 const results = await streamify.soundcloud.search('query');
+const info = await streamify.twitch.getInfo('channel');
+const url = streamify.local.getStreamUrl('/path/to/file.mp3');
 ```
 
 ### Get Info

package/docs/sources.md

@@ -1,6 +1,6 @@
 # Sources
 
-Streamify supports YouTube, Spotify, and SoundCloud.
+Streamify supports YouTube, Spotify, SoundCloud, Twitch, Mixcloud, Bandcamp, Local Files, and Direct URLs.
 
 ## Supported Features
 
@@ -9,6 +9,11 @@ Streamify supports YouTube, Spotify, and SoundCloud.
 | YouTube | ✅ | ✅ | ✅ | — |
 | Spotify | ✅ | ✅ | ✅ | ✅ |
 | SoundCloud | ✅ | ✅ | ❌ | — |
+| Twitch | ✅ | ✅ | — | — |
+| Mixcloud | ✅ | ✅ | — | — |
+| Bandcamp | ✅ | ✅ | — | ✅ |
+| Direct URL | ✅ | ✅ | — | — |
+| Local File | ✅ | ✅ | — | — |
 
 ## YouTube
 
@@ -106,6 +111,50 @@ const result = await manager.resolve('https://soundcloud.com/rick-astley-officia
 
 - `soundcloud.com/USER/TRACK`
 
+## Twitch & Mixcloud
+
+Streaming support for live content and DJ sets.
+
+```javascript
+// Twitch Live
+await manager.resolve('https://twitch.tv/monstercat');
+
+// Mixcloud Sets
+await manager.resolve('https://www.mixcloud.com/spinninrecords/spinnin-sessions-550/');
+```
+
+## Bandcamp
+
+Support for high-quality independent music.
+
+```javascript
+await manager.resolve('https://monstercatmedia.bandcamp.com/track/the-governor');
+```
+
+## Direct URLs (HTTP)
+
+Play raw audio files from any public URL.
+
+```javascript
+await manager.resolve('https://example.com/audio.mp3');
+await manager.resolve('https://cdn.discordapp.com/attachments/.../music.ogg');
+```
+
+## Local Files
+
+Play files directly from the host system.
+
+```javascript
+// Absolute path
+await manager.resolve('/home/user/music/track.mp3');
+
+// Relative path
+await manager.resolve('./assets/sound-effect.wav');
+
+// File URI
+await manager.resolve('file:///var/lib/music/song.flac');
+```
+
 ## Auto-Detection
 
 The `resolve()` method auto-detects the source from URLs:
@@ -115,9 +164,8 @@ The `resolve()` method auto-detects the source from URLs:
 await manager.resolve('https://youtube.com/watch?v=dQw4w9WgXcQ');
 await manager.resolve('https://open.spotify.com/track/4PTG3Z6ehGkBFwjybzWkR8');
 await manager.resolve('https://soundcloud.com/rick-astley-official/never-gonna-give-you-up');
-
-// Falls back to YouTube search
-await manager.resolve('never gonna give you up');
+await manager.resolve('https://twitch.tv/some-channel');
+await manager.resolve('/path/to/local/file.mp3');
 ```
 
 ## Track Object

package/index.d.ts

@@ -163,6 +163,8 @@ declare module 'streamify-audio' {
         static Manager: typeof Manager;
         static Player: typeof Player;
         static Queue: typeof Queue;
+        static getEffectPresetsInfo(): EffectPresetInfo[];
+        static EFFECT_PRESETS: Record<string, { filters: Filters; description: string }>;
     }
 
     // ========================================================================
@@ -237,6 +239,29 @@ declare module 'streamify-audio' {
         on(event: 'playerDestroy', listener: (player: Player) => void): this;
     }
 
+    export interface PlayOptions {
+        startPosition?: number;
+        seek?: number;
+        volume?: number;
+        filters?: Filters;
+        replace?: boolean;
+    }
+
+    export interface EffectPreset {
+        name: string;
+        intensity?: number;
+    }
+
+    export interface EffectPresetInfo {
+        name: string;
+        description: string;
+        filters: string[];
+    }
+
+    export interface SetEffectPresetsOptions {
+        replace?: boolean;
+    }
+
     export class Player extends EventEmitter {
         constructor(manager: Manager, options: any);
 
@@ -261,7 +286,7 @@ declare module 'streamify-audio' {
         disconnect(): boolean;
         destroy(): void;
 
-        play(track: Track): Promise<void>;
+        play(track: Track, options?: PlayOptions): Promise<void>;
         pause(destroyStream?: boolean): boolean;
         resume(): Promise<boolean>;
         skip(): Promise<Track | null>;
@@ -281,6 +306,11 @@ declare module 'streamify-audio' {
         clearEQ(): Promise<boolean>;
         getPresets(): string[];
 
+        setEffectPresets(presets: (string | EffectPreset)[], options?: SetEffectPresetsOptions): Promise<boolean>;
+        getActiveEffectPresets(): EffectPreset[];
+        clearEffectPresets(): Promise<boolean>;
+        getEffectPresets(): string[];
+
         toJSON(): any;
 
         on(event: 'trackStart', listener: (track: Track) => void): this;