@ziplayer/plugin
Version:
A modular Discord voice player with plugin system
90 lines • 3.42 kB
JavaScript
;
/**
* @fileoverview Main export file for ZiPlayer plugins.
*
* This module exports all available plugins for the ZiPlayer music bot framework.
* Each plugin provides support for different audio sources and services.
*
* @example
* import { YouTubePlugin, SoundCloudPlugin, SpotifyPlugin, TTSPlugin } from "ziplayer/plugins";
*
* const manager = new PlayerManager({
* plugins: [
* new YouTubePlugin(),
* new SoundCloudPlugin(),
* new SpotifyPlugin(),
* new TTSPlugin({ defaultLang: "en" })
* ]
* });
*
* @since 1.0.0
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.TTSPlugin = exports.SpotifyPlugin = exports.SoundCloudPlugin = exports.YouTubePlugin = void 0;
/**
* YouTube plugin for handling YouTube videos, playlists, and search.
*
* Provides comprehensive support for YouTube content including:
* - Video URLs (youtube.com, youtu.be, music.youtube.com)
* - Playlist URLs and dynamic mixes
* - Search functionality
* - Audio stream extraction
* - Related track recommendations
*
* @example
* const youtubePlugin = new YouTubePlugin();
* const result = await youtubePlugin.search("Never Gonna Give You Up", "user123");
*/
var YouTubePlugin_1 = require("./YouTubePlugin");
Object.defineProperty(exports, "YouTubePlugin", { enumerable: true, get: function () { return YouTubePlugin_1.YouTubePlugin; } });
/**
* SoundCloud plugin for handling SoundCloud tracks, playlists, and search.
*
* Provides comprehensive support for SoundCloud content including:
* - Track URLs (soundcloud.com)
* - Playlist URLs
* - Search functionality
* - Audio stream extraction
* - Related track recommendations
*
* @example
* const soundcloudPlugin = new SoundCloudPlugin();
* const result = await soundcloudPlugin.search("chill music", "user123");
*/
var SoundCloudPlugin_1 = require("./SoundCloudPlugin");
Object.defineProperty(exports, "SoundCloudPlugin", { enumerable: true, get: function () { return SoundCloudPlugin_1.SoundCloudPlugin; } });
/**
* Spotify plugin for metadata extraction and display purposes.
*
* **Note:** This plugin only provides metadata extraction and does not support
* audio streaming. It uses Spotify's public oEmbed endpoint for display purposes.
*
* Provides support for:
* - Track URLs/URIs (spotify:track:...)
* - Playlist URLs/URIs (spotify:playlist:...)
* - Album URLs/URIs (spotify:album:...)
* - Metadata extraction using oEmbed API
*
* @example
* const spotifyPlugin = new SpotifyPlugin();
* const result = await spotifyPlugin.search("spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "user123");
*/
var SpotifyPlugin_1 = require("./SpotifyPlugin");
Object.defineProperty(exports, "SpotifyPlugin", { enumerable: true, get: function () { return SpotifyPlugin_1.SpotifyPlugin; } });
/**
* Text-to-Speech (TTS) plugin for converting text to audio.
*
* Provides comprehensive TTS functionality including:
* - Google TTS integration
* - Custom TTS provider support
* - Multiple language support
* - Configurable speech rate
* - Flexible query parsing
*
* @example
* const ttsPlugin = new TTSPlugin({ defaultLang: "en" });
* const result = await ttsPlugin.search("tts:Hello world", "user123");
*/
var TTSPlugin_1 = require("./TTSPlugin");
Object.defineProperty(exports, "TTSPlugin", { enumerable: true, get: function () { return TTSPlugin_1.TTSPlugin; } });
//# sourceMappingURL=index.js.map