@ziplayer/plugin 0.0.5 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/YTSR_README.md +310 -0
- package/dist/SoundCloudPlugin.d.ts +149 -0
- package/dist/SoundCloudPlugin.d.ts.map +1 -1
- package/dist/SoundCloudPlugin.js +149 -0
- package/dist/SoundCloudPlugin.js.map +1 -1
- package/dist/SpotifyPlugin.d.ts +127 -5
- package/dist/SpotifyPlugin.d.ts.map +1 -1
- package/dist/SpotifyPlugin.js +127 -5
- package/dist/SpotifyPlugin.js.map +1 -1
- package/dist/TTSPlugin.d.ts +123 -2
- package/dist/TTSPlugin.d.ts.map +1 -1
- package/dist/TTSPlugin.js +114 -0
- package/dist/TTSPlugin.js.map +1 -1
- package/dist/YTSRPlugin.d.ts +249 -0
- package/dist/YTSRPlugin.d.ts.map +1 -0
- package/dist/YTSRPlugin.js +561 -0
- package/dist/YTSRPlugin.js.map +1 -0
- package/dist/YouTubePlugin.d.ts +148 -0
- package/dist/YouTubePlugin.d.ts.map +1 -1
- package/dist/YouTubePlugin.js +148 -0
- package/dist/YouTubePlugin.js.map +1 -1
- package/dist/index.d.ts +94 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +96 -1
- package/dist/index.js.map +1 -1
- package/package.json +2 -1
- package/src/SoundCloudPlugin.ts +149 -0
- package/src/SpotifyPlugin.ts +312 -190
- package/src/TTSPlugin.ts +130 -3
- package/src/YTSRPlugin.ts +564 -0
- package/src/YouTubePlugin.ts +528 -380
- package/src/index.ts +99 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SoundCloudPlugin.js","sourceRoot":"","sources":["../src/SoundCloudPlugin.ts"],"names":[],"mappings":";;;AAAA,uCAAuE;AAEvE,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;AAC1C,6BAA0B;AAE1B,MAAM,wBAAwB,GAAG,CAAC,gBAAgB,EAAE,oBAAoB,EAAE,kBAAkB,CAAC,CAAC;AAE9F,SAAS,qBAAqB,CAAC,QAAgB;IAC9C,IAAI,CAAC;QACJ,MAAM,MAAM,GAAG,IAAI,SAAG,CAAC,QAAQ,CAAC,CAAC;QACjC,OAAO,wBAAwB,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAAC,MAAM,CAAC;QACR,6CAA6C;QAC7C,OAAO,KAAK,CAAC;IACd,CAAC;AACF,CAAC;AACD,MAAa,gBAAiB,SAAQ,qBAAU;IAM/C;QACC,KAAK,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"SoundCloudPlugin.js","sourceRoot":"","sources":["../src/SoundCloudPlugin.ts"],"names":[],"mappings":";;;AAAA,uCAAuE;AAEvE,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;AAC1C,6BAA0B;AAE1B,MAAM,wBAAwB,GAAG,CAAC,gBAAgB,EAAE,oBAAoB,EAAE,kBAAkB,CAAC,CAAC;AAE9F,SAAS,qBAAqB,CAAC,QAAgB;IAC9C,IAAI,CAAC;QACJ,MAAM,MAAM,GAAG,IAAI,SAAG,CAAC,QAAQ,CAAC,CAAC;QACjC,OAAO,wBAAwB,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAAC,MAAM,CAAC;QACR,6CAA6C;QAC7C,OAAO,KAAK,CAAC;IACd,CAAC;AACF,CAAC;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,gBAAiB,SAAQ,qBAAU;IAM/C;;;;;;;;;OASG;IACH;QACC,KAAK,EAAE,CAAC;QAhBT,SAAI,GAAG,YAAY,CAAC;QACpB,YAAO,GAAG,OAAO,CAAC;QAgBjB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IAEO,KAAK,CAAC,IAAI;QACjB,IAAI,CAAC,MAAM,GAAG,IAAI,UAAU,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9C,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,KAAa;QACtB,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC7C,MAAM,KAAK,GAAG,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAClE,IAAI,KAAK,EAAE,CAAC;YACX,OAAO,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACrC,CAAC;QAED,4DAA4D;QAC5D,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;YAAE,OAAO,KAAK,CAAC;QAC/D,IAAI,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YAAE,OAAO,KAAK,CAAC;QAC7E,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;YAAE,OAAO,KAAK,CAAC;QAExC,kDAAkD;QAClD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,GAAW;QACnB,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,WAAmB;QAC9C,MAAM,IAAI,CAAC,KAAK,CAAC;QAEjB,wEAAwE;QACxE,4EAA4E;QAC5E,IAAI,CAAC;YACJ,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAC7C,MAAM,KAAK,GAAG,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAClE,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACpC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;YACvB,CAAC;QACF,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QAEV,IAAI,CAAC;YACJ,IAAI,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC;oBACJ,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;oBACtD,MAAM,KAAK,GAAU;wBACpB,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;wBACtB,KAAK,EAAE,IAAI,CAAC,KAAK;wBACjB,GAAG,EAAE,IAAI,CAAC,aAAa,IAAI,KAAK;wBAChC,QAAQ,EAAE,IAAI,CAAC,QAAQ;wBACvB,SAAS,EAAE,IAAI,CAAC,WAAW;wBAC3B,WAAW;wBACX,MAAM,EAAE,IAAI,CAAC,IAAI;wBACjB,QAAQ,EAAE;4BACT,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ;4BAC3B,KAAK,EAAE,IAAI,CAAC,cAAc;yBAC1B;qBACD,CAAC;oBACF,OAAO,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5B,CAAC;gBAAC,MAAM,CAAC;oBACR,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;oBAC7D,MAAM,MAAM,GAAY,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC;wBACxD,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE;wBACnB,KAAK,EAAE,CAAC,CAAC,KAAK;wBACd,GAAG,EAAE,CAAC,CAAC,aAAa;wBACpB,QAAQ,EAAE,CAAC,CAAC,QAAQ;wBACpB,SAAS,EAAE,CAAC,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW;wBAChD,WAAW;wBACX,MAAM,EAAE,IAAI,CAAC,IAAI;wBACjB,QAAQ,EAAE;4BACT,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ;4BACxB,KAAK,EAAE,CAAC,CAAC,cAAc;4BACvB,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE;yBACjC;qBACD,CAAC,CAAC,CAAC;oBAEJ,OAAO;wBACN,MAAM;wBACN,QAAQ,EAAE;4BACT,IAAI,EAAE,QAAQ,CAAC,KAAK;4BACpB,GAAG,EAAE,QAAQ,CAAC,aAAa,IAAI,KAAK;4BACpC,SAAS,EAAE,QAAQ,CAAC,WAAW;yBAC/B;qBACD,CAAC;gBACH,CAAC;YACF,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;YACrE,MAAM,MAAM,GAAY,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAU,EAAE,EAAE,CAAC,CAAC;gBACjE,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,QAAQ,EAAE;gBACvB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,GAAG,EAAE,KAAK,CAAC,aAAa;gBACxB,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,SAAS,EAAE,KAAK,CAAC,WAAW;gBAC5B,WAAW;gBACX,MAAM,EAAE,IAAI,CAAC,IAAI;gBACjB,QAAQ,EAAE;oBACT,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ;oBAC5B,KAAK,EAAE,KAAK,CAAC,cAAc;iBAC3B;aACD,CAAC,CAAC,CAAC;YAEJ,OAAO,EAAE,MAAM,EAAE,CAAC;QACnB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,6BAA6B,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAChE,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,SAAS,CAAC,KAAY;QAC3B,MAAM,IAAI,CAAC,KAAK,CAAC;QAEjB,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC1D,IAAI,CAAC,MAAM,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;YACtD,CAAC;YAED,OAAO;gBACN,MAAM;gBACN,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,KAAK,CAAC,QAAQ;aACxB,CAAC;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,oCAAoC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACtE,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,gBAAgB,CACrB,QAAyB,EACzB,OAA+D,EAAE;QAEjE,MAAM,IAAI,CAAC,KAAK,CAAC;QACjB,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE;gBAC3D,KAAK,EAAE,EAAE;gBACT,MAAM,EAAE,QAAQ;aAChB,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;gBAChC,OAAO,EAAE,CAAC;YACX,CAAC;YACD,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAO,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;YAEjH,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;YAExD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC;gBAC/B,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE;gBACnB,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,GAAG,EAAE,CAAC,CAAC,aAAa;gBACpB,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,SAAS,EAAE,CAAC,CAAC,WAAW;gBACxB,WAAW,EAAE,MAAM;gBACnB,MAAM,EAAE,IAAI,CAAC,IAAI;gBACjB,QAAQ,EAAE;oBACT,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ;oBACxB,KAAK,EAAE,CAAC,CAAC,cAAc;iBACvB;aACD,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,EAAE,CAAC;QACX,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,WAAW,CAAC,KAAY;QAC7B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;QACpE,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5C,IAAI,CAAC,aAAa,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,+BAA+B,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,eAAe,CAAC,GAAW,EAAE,WAAmB;QACrD,MAAM,IAAI,CAAC,KAAK,CAAC;QACjB,IAAI,CAAC;YACJ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YAC3D,OAAO,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC;gBACvC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE;gBACnB,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,GAAG,EAAE,CAAC,CAAC,aAAa;gBACpB,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,SAAS,EAAE,CAAC,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW;gBAChD,WAAW;gBACX,MAAM,EAAE,IAAI,CAAC,IAAI;gBACjB,QAAQ,EAAE;oBACT,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ;oBACxB,KAAK,EAAE,CAAC,CAAC,cAAc;oBACvB,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE;iBACjC;aACD,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,EAAE,CAAC;QACX,CAAC;IACF,CAAC;CACD;AApUD,4CAoUC"}
|
package/dist/SpotifyPlugin.d.ts
CHANGED
|
@@ -1,19 +1,141 @@
|
|
|
1
1
|
import { BasePlugin, Track, SearchResult, StreamInfo } from "ziplayer";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* -
|
|
7
|
-
* -
|
|
3
|
+
* A minimal Spotify plugin for metadata extraction and display purposes.
|
|
4
|
+
*
|
|
5
|
+
* This plugin provides support for:
|
|
6
|
+
* - Spotify track URLs/URIs (spotify:track:...)
|
|
7
|
+
* - Spotify playlist URLs/URIs (spotify:playlist:...)
|
|
8
|
+
* - Spotify album URLs/URIs (spotify:album:...)
|
|
9
|
+
* - Metadata extraction using Spotify's public oEmbed endpoint
|
|
10
|
+
*
|
|
11
|
+
* **Important Notes:**
|
|
12
|
+
* - This plugin does NOT provide audio streams (player is expected to redirect/fallback upstream)
|
|
13
|
+
* - This plugin does NOT expand playlists/albums (no SDK; oEmbed doesn't enumerate items)
|
|
14
|
+
* - This plugin only provides display metadata for Spotify content
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
*
|
|
18
|
+
* const spotifyPlugin = new SpotifyPlugin();
|
|
19
|
+
*
|
|
20
|
+
* // Add to PlayerManager
|
|
21
|
+
* const manager = new PlayerManager({
|
|
22
|
+
* plugins: [spotifyPlugin]
|
|
23
|
+
* });
|
|
24
|
+
*
|
|
25
|
+
* // Get metadata for a Spotify track
|
|
26
|
+
* const result = await spotifyPlugin.search("spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "user123");
|
|
27
|
+
* console.log(result.tracks[0].metadata); // Contains Spotify metadata
|
|
28
|
+
*
|
|
29
|
+
*
|
|
30
|
+
* @since 1.1.0
|
|
8
31
|
*/
|
|
9
32
|
export declare class SpotifyPlugin extends BasePlugin {
|
|
10
33
|
name: string;
|
|
11
34
|
version: string;
|
|
35
|
+
/**
|
|
36
|
+
* Determines if this plugin can handle the given query.
|
|
37
|
+
*
|
|
38
|
+
* @param query - The search query or URL to check
|
|
39
|
+
* @returns `true` if the query is a Spotify URL/URI, `false` otherwise
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
*
|
|
43
|
+
* plugin.canHandle("spotify:track:4iV5W9uYEdYUVa79Axb7Rh"); // true
|
|
44
|
+
* plugin.canHandle("https://open.spotify.com/track/4iV5W9uYEdYUVa79Axb7Rh"); // true
|
|
45
|
+
* plugin.canHandle("youtube.com/watch?v=123"); // false
|
|
46
|
+
*
|
|
47
|
+
*/
|
|
12
48
|
canHandle(query: string): boolean;
|
|
49
|
+
/**
|
|
50
|
+
* Validates if a URL/URI is a valid Spotify URL/URI.
|
|
51
|
+
*
|
|
52
|
+
* @param url - The URL/URI to validate
|
|
53
|
+
* @returns `true` if the URL/URI is a valid Spotify URL/URI, `false` otherwise
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
*
|
|
57
|
+
* plugin.validate("spotify:track:4iV5W9uYEdYUVa79Axb7Rh"); // true
|
|
58
|
+
* plugin.validate("https://open.spotify.com/track/4iV5W9uYEdYUVa79Axb7Rh"); // true
|
|
59
|
+
* plugin.validate("https://youtube.com/watch?v=123"); // false
|
|
60
|
+
*
|
|
61
|
+
*/
|
|
13
62
|
validate(url: string): boolean;
|
|
63
|
+
/**
|
|
64
|
+
* Extracts metadata from Spotify URLs/URIs using the oEmbed API.
|
|
65
|
+
*
|
|
66
|
+
* This method handles Spotify track, playlist, and album URLs/URIs by fetching
|
|
67
|
+
* display metadata from Spotify's public oEmbed endpoint. It does not provide
|
|
68
|
+
* audio streams or expand playlists/albums.
|
|
69
|
+
*
|
|
70
|
+
* @param query - The Spotify URL/URI to extract metadata from
|
|
71
|
+
* @param requestedBy - The user ID who requested the extraction
|
|
72
|
+
* @returns A SearchResult containing a single track with metadata (no audio stream)
|
|
73
|
+
*
|
|
74
|
+
* @example
|
|
75
|
+
*
|
|
76
|
+
* // Extract track metadata
|
|
77
|
+
* const result = await plugin.search("spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "user123");
|
|
78
|
+
* console.log(result.tracks[0].metadata); // Contains Spotify metadata
|
|
79
|
+
*
|
|
80
|
+
* // Extract playlist metadata
|
|
81
|
+
* const playlistResult = await plugin.search("https://open.spotify.com/playlist/37i9dQZF1DXcBWIGoYBM5M", "user123");
|
|
82
|
+
* console.log(playlistResult.tracks[0].metadata.kind); // "playlist"
|
|
83
|
+
*
|
|
84
|
+
*/
|
|
14
85
|
search(query: string, requestedBy: string): Promise<SearchResult>;
|
|
86
|
+
/**
|
|
87
|
+
* Extracts tracks from a Spotify playlist URL.
|
|
88
|
+
*
|
|
89
|
+
* **Note:** This method is not implemented as this plugin does not support
|
|
90
|
+
* playlist expansion. It always returns an empty array.
|
|
91
|
+
*
|
|
92
|
+
* @param _input - The Spotify playlist URL (unused)
|
|
93
|
+
* @param _requestedBy - The user ID who requested the extraction (unused)
|
|
94
|
+
* @returns An empty array (playlist expansion not supported)
|
|
95
|
+
*
|
|
96
|
+
* @example
|
|
97
|
+
*
|
|
98
|
+
* const tracks = await plugin.extractPlaylist("spotify:playlist:123", "user123");
|
|
99
|
+
* console.log(tracks); // [] - empty array
|
|
100
|
+
*
|
|
101
|
+
*/
|
|
15
102
|
extractPlaylist(_input: string, _requestedBy: string): Promise<Track[]>;
|
|
103
|
+
/**
|
|
104
|
+
* Extracts tracks from a Spotify album URL.
|
|
105
|
+
*
|
|
106
|
+
* **Note:** This method is not implemented as this plugin does not support
|
|
107
|
+
* album expansion. It always returns an empty array.
|
|
108
|
+
*
|
|
109
|
+
* @param _input - The Spotify album URL (unused)
|
|
110
|
+
* @param _requestedBy - The user ID who requested the extraction (unused)
|
|
111
|
+
* @returns An empty array (album expansion not supported)
|
|
112
|
+
*
|
|
113
|
+
* @example
|
|
114
|
+
*
|
|
115
|
+
* const tracks = await plugin.extractAlbum("spotify:album:123", "user123");
|
|
116
|
+
* console.log(tracks); // [] - empty array
|
|
117
|
+
*
|
|
118
|
+
*/
|
|
16
119
|
extractAlbum(_input: string, _requestedBy: string): Promise<Track[]>;
|
|
120
|
+
/**
|
|
121
|
+
* Attempts to get an audio stream for a Spotify track.
|
|
122
|
+
*
|
|
123
|
+
* **Note:** This method always throws an error as this plugin does not support
|
|
124
|
+
* audio streaming. The player is expected to redirect to other plugins or
|
|
125
|
+
* use fallback mechanisms for actual audio playback.
|
|
126
|
+
*
|
|
127
|
+
* @param _track - The Track object (unused)
|
|
128
|
+
* @throws {Error} Always throws "Spotify streaming is not supported by this plugin"
|
|
129
|
+
*
|
|
130
|
+
* @example
|
|
131
|
+
*
|
|
132
|
+
* try {
|
|
133
|
+
* const stream = await plugin.getStream(track);
|
|
134
|
+
* } catch (error) {
|
|
135
|
+
* console.log(error.message); // "Spotify streaming is not supported by this plugin"
|
|
136
|
+
* }
|
|
137
|
+
*
|
|
138
|
+
*/
|
|
17
139
|
getStream(_track: Track): Promise<StreamInfo>;
|
|
18
140
|
private identifyKind;
|
|
19
141
|
private extractId;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SpotifyPlugin.d.ts","sourceRoot":"","sources":["../src/SpotifyPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEvE
|
|
1
|
+
{"version":3,"file":"SpotifyPlugin.d.ts","sourceRoot":"","sources":["../src/SpotifyPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,aAAc,SAAQ,UAAU;IAC5C,IAAI,SAAa;IACjB,OAAO,SAAW;IAElB;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAWjC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAU9B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAyBvE;;;;;;;;;;;;;;;OAeG;IACG,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAI7E;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAI1E;;;;;;;;;;;;;;;;;;OAkBG;IACG,SAAS,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC;IAInD,OAAO,CAAC,YAAY;IAoBpB,OAAO,CAAC,SAAS;YAeH,sBAAsB;YA0BtB,eAAe;IA0B7B,OAAO,CAAC,UAAU;YAeJ,WAAW;CAgBzB"}
|
package/dist/SpotifyPlugin.js
CHANGED
|
@@ -3,11 +3,34 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.SpotifyPlugin = void 0;
|
|
4
4
|
const ziplayer_1 = require("ziplayer");
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* -
|
|
10
|
-
* -
|
|
6
|
+
* A minimal Spotify plugin for metadata extraction and display purposes.
|
|
7
|
+
*
|
|
8
|
+
* This plugin provides support for:
|
|
9
|
+
* - Spotify track URLs/URIs (spotify:track:...)
|
|
10
|
+
* - Spotify playlist URLs/URIs (spotify:playlist:...)
|
|
11
|
+
* - Spotify album URLs/URIs (spotify:album:...)
|
|
12
|
+
* - Metadata extraction using Spotify's public oEmbed endpoint
|
|
13
|
+
*
|
|
14
|
+
* **Important Notes:**
|
|
15
|
+
* - This plugin does NOT provide audio streams (player is expected to redirect/fallback upstream)
|
|
16
|
+
* - This plugin does NOT expand playlists/albums (no SDK; oEmbed doesn't enumerate items)
|
|
17
|
+
* - This plugin only provides display metadata for Spotify content
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
*
|
|
21
|
+
* const spotifyPlugin = new SpotifyPlugin();
|
|
22
|
+
*
|
|
23
|
+
* // Add to PlayerManager
|
|
24
|
+
* const manager = new PlayerManager({
|
|
25
|
+
* plugins: [spotifyPlugin]
|
|
26
|
+
* });
|
|
27
|
+
*
|
|
28
|
+
* // Get metadata for a Spotify track
|
|
29
|
+
* const result = await spotifyPlugin.search("spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "user123");
|
|
30
|
+
* console.log(result.tracks[0].metadata); // Contains Spotify metadata
|
|
31
|
+
*
|
|
32
|
+
*
|
|
33
|
+
* @since 1.1.0
|
|
11
34
|
*/
|
|
12
35
|
class SpotifyPlugin extends ziplayer_1.BasePlugin {
|
|
13
36
|
constructor() {
|
|
@@ -15,6 +38,19 @@ class SpotifyPlugin extends ziplayer_1.BasePlugin {
|
|
|
15
38
|
this.name = "spotify";
|
|
16
39
|
this.version = "1.1.0";
|
|
17
40
|
}
|
|
41
|
+
/**
|
|
42
|
+
* Determines if this plugin can handle the given query.
|
|
43
|
+
*
|
|
44
|
+
* @param query - The search query or URL to check
|
|
45
|
+
* @returns `true` if the query is a Spotify URL/URI, `false` otherwise
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
*
|
|
49
|
+
* plugin.canHandle("spotify:track:4iV5W9uYEdYUVa79Axb7Rh"); // true
|
|
50
|
+
* plugin.canHandle("https://open.spotify.com/track/4iV5W9uYEdYUVa79Axb7Rh"); // true
|
|
51
|
+
* plugin.canHandle("youtube.com/watch?v=123"); // false
|
|
52
|
+
*
|
|
53
|
+
*/
|
|
18
54
|
canHandle(query) {
|
|
19
55
|
const q = query.toLowerCase().trim();
|
|
20
56
|
if (q.startsWith("spotify:"))
|
|
@@ -27,6 +63,19 @@ class SpotifyPlugin extends ziplayer_1.BasePlugin {
|
|
|
27
63
|
return false;
|
|
28
64
|
}
|
|
29
65
|
}
|
|
66
|
+
/**
|
|
67
|
+
* Validates if a URL/URI is a valid Spotify URL/URI.
|
|
68
|
+
*
|
|
69
|
+
* @param url - The URL/URI to validate
|
|
70
|
+
* @returns `true` if the URL/URI is a valid Spotify URL/URI, `false` otherwise
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
*
|
|
74
|
+
* plugin.validate("spotify:track:4iV5W9uYEdYUVa79Axb7Rh"); // true
|
|
75
|
+
* plugin.validate("https://open.spotify.com/track/4iV5W9uYEdYUVa79Axb7Rh"); // true
|
|
76
|
+
* plugin.validate("https://youtube.com/watch?v=123"); // false
|
|
77
|
+
*
|
|
78
|
+
*/
|
|
30
79
|
validate(url) {
|
|
31
80
|
if (url.startsWith("spotify:"))
|
|
32
81
|
return true;
|
|
@@ -38,6 +87,28 @@ class SpotifyPlugin extends ziplayer_1.BasePlugin {
|
|
|
38
87
|
return false;
|
|
39
88
|
}
|
|
40
89
|
}
|
|
90
|
+
/**
|
|
91
|
+
* Extracts metadata from Spotify URLs/URIs using the oEmbed API.
|
|
92
|
+
*
|
|
93
|
+
* This method handles Spotify track, playlist, and album URLs/URIs by fetching
|
|
94
|
+
* display metadata from Spotify's public oEmbed endpoint. It does not provide
|
|
95
|
+
* audio streams or expand playlists/albums.
|
|
96
|
+
*
|
|
97
|
+
* @param query - The Spotify URL/URI to extract metadata from
|
|
98
|
+
* @param requestedBy - The user ID who requested the extraction
|
|
99
|
+
* @returns A SearchResult containing a single track with metadata (no audio stream)
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
*
|
|
103
|
+
* // Extract track metadata
|
|
104
|
+
* const result = await plugin.search("spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "user123");
|
|
105
|
+
* console.log(result.tracks[0].metadata); // Contains Spotify metadata
|
|
106
|
+
*
|
|
107
|
+
* // Extract playlist metadata
|
|
108
|
+
* const playlistResult = await plugin.search("https://open.spotify.com/playlist/37i9dQZF1DXcBWIGoYBM5M", "user123");
|
|
109
|
+
* console.log(playlistResult.tracks[0].metadata.kind); // "playlist"
|
|
110
|
+
*
|
|
111
|
+
*/
|
|
41
112
|
async search(query, requestedBy) {
|
|
42
113
|
if (!this.validate(query)) {
|
|
43
114
|
return { tracks: [] };
|
|
@@ -57,12 +128,63 @@ class SpotifyPlugin extends ziplayer_1.BasePlugin {
|
|
|
57
128
|
}
|
|
58
129
|
return { tracks: [] };
|
|
59
130
|
}
|
|
131
|
+
/**
|
|
132
|
+
* Extracts tracks from a Spotify playlist URL.
|
|
133
|
+
*
|
|
134
|
+
* **Note:** This method is not implemented as this plugin does not support
|
|
135
|
+
* playlist expansion. It always returns an empty array.
|
|
136
|
+
*
|
|
137
|
+
* @param _input - The Spotify playlist URL (unused)
|
|
138
|
+
* @param _requestedBy - The user ID who requested the extraction (unused)
|
|
139
|
+
* @returns An empty array (playlist expansion not supported)
|
|
140
|
+
*
|
|
141
|
+
* @example
|
|
142
|
+
*
|
|
143
|
+
* const tracks = await plugin.extractPlaylist("spotify:playlist:123", "user123");
|
|
144
|
+
* console.log(tracks); // [] - empty array
|
|
145
|
+
*
|
|
146
|
+
*/
|
|
60
147
|
async extractPlaylist(_input, _requestedBy) {
|
|
61
148
|
return [];
|
|
62
149
|
}
|
|
150
|
+
/**
|
|
151
|
+
* Extracts tracks from a Spotify album URL.
|
|
152
|
+
*
|
|
153
|
+
* **Note:** This method is not implemented as this plugin does not support
|
|
154
|
+
* album expansion. It always returns an empty array.
|
|
155
|
+
*
|
|
156
|
+
* @param _input - The Spotify album URL (unused)
|
|
157
|
+
* @param _requestedBy - The user ID who requested the extraction (unused)
|
|
158
|
+
* @returns An empty array (album expansion not supported)
|
|
159
|
+
*
|
|
160
|
+
* @example
|
|
161
|
+
*
|
|
162
|
+
* const tracks = await plugin.extractAlbum("spotify:album:123", "user123");
|
|
163
|
+
* console.log(tracks); // [] - empty array
|
|
164
|
+
*
|
|
165
|
+
*/
|
|
63
166
|
async extractAlbum(_input, _requestedBy) {
|
|
64
167
|
return [];
|
|
65
168
|
}
|
|
169
|
+
/**
|
|
170
|
+
* Attempts to get an audio stream for a Spotify track.
|
|
171
|
+
*
|
|
172
|
+
* **Note:** This method always throws an error as this plugin does not support
|
|
173
|
+
* audio streaming. The player is expected to redirect to other plugins or
|
|
174
|
+
* use fallback mechanisms for actual audio playback.
|
|
175
|
+
*
|
|
176
|
+
* @param _track - The Track object (unused)
|
|
177
|
+
* @throws {Error} Always throws "Spotify streaming is not supported by this plugin"
|
|
178
|
+
*
|
|
179
|
+
* @example
|
|
180
|
+
*
|
|
181
|
+
* try {
|
|
182
|
+
* const stream = await plugin.getStream(track);
|
|
183
|
+
* } catch (error) {
|
|
184
|
+
* console.log(error.message); // "Spotify streaming is not supported by this plugin"
|
|
185
|
+
* }
|
|
186
|
+
*
|
|
187
|
+
*/
|
|
66
188
|
async getStream(_track) {
|
|
67
189
|
throw new Error("Spotify streaming is not supported by this plugin");
|
|
68
190
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SpotifyPlugin.js","sourceRoot":"","sources":["../src/SpotifyPlugin.ts"],"names":[],"mappings":";;;AAAA,uCAAuE;AAEvE
|
|
1
|
+
{"version":3,"file":"SpotifyPlugin.js","sourceRoot":"","sources":["../src/SpotifyPlugin.ts"],"names":[],"mappings":";;;AAAA,uCAAuE;AAEvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAa,aAAc,SAAQ,qBAAU;IAA7C;;QACC,SAAI,GAAG,SAAS,CAAC;QACjB,YAAO,GAAG,OAAO,CAAC;IAqRnB,CAAC;IAnRA;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,KAAa;QACtB,MAAM,CAAC,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;QACrC,IAAI,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;YAAE,OAAO,IAAI,CAAC;QAC1C,IAAI,CAAC;YACJ,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;YACrB,OAAO,CAAC,CAAC,QAAQ,KAAK,kBAAkB,CAAC;QAC1C,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,GAAW;QACnB,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC;YAAE,OAAO,IAAI,CAAC;QAC5C,IAAI,CAAC;YACJ,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YACvB,OAAO,CAAC,CAAC,QAAQ,KAAK,kBAAkB,CAAC;QAC1C,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,WAAmB;QAC9C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACvB,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAEtC,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;YACtB,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YAChE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACjC,CAAC;QAED,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;YACrE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACjC,CAAC;QAED,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;YACtB,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;YAClE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACjC,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,eAAe,CAAC,MAAc,EAAE,YAAoB;QACzD,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,YAAY,CAAC,MAAc,EAAE,YAAoB;QACtD,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,SAAS,CAAC,MAAa;QAC5B,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACtE,CAAC;IAEO,YAAY,CAAC,KAAa;QACjC,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAClC,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAAE,OAAO,OAAO,CAAC;YAC9C,IAAI,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC;gBAAE,OAAO,UAAU,CAAC;YACpD,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAAE,OAAO,OAAO,CAAC;YAC9C,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,IAAI,CAAC;YACJ,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;YACzB,MAAM,KAAK,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACpD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,IAAI,KAAK,OAAO;gBAAE,OAAO,OAAO,CAAC;YACrC,IAAI,IAAI,KAAK,UAAU;gBAAE,OAAO,UAAU,CAAC;YAC3C,IAAI,IAAI,KAAK,OAAO;gBAAE,OAAO,OAAO,CAAC;YACrC,OAAO,SAAS,CAAC;QAClB,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,SAAS,CAAC;QAClB,CAAC;IACF,CAAC;IAEO,SAAS,CAAC,KAAa;QAC9B,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAClC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC/B,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;QACzB,CAAC;QACD,IAAI,CAAC;YACJ,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;YACzB,MAAM,KAAK,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACpD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,cAAc;QACxC,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,IAAI,CAAC;QACb,CAAC;IACF,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,KAAa,EAAE,WAAmB;QACtE,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE;YAAE,OAAO,IAAI,CAAC;QAErB,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAChE,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI,iBAAiB,EAAE,EAAE,CAAC;QACnD,MAAM,SAAS,GAAG,IAAI,EAAE,aAAa,CAAC;QAEtC,MAAM,KAAK,GAAU;YACpB,EAAE;YACF,KAAK;YACL,GAAG;YACH,QAAQ,EAAE,CAAC;YACX,SAAS;YACT,WAAW;YACX,MAAM,EAAE,IAAI,CAAC,IAAI;YACjB,QAAQ,EAAE;gBACT,MAAM,EAAE,IAAI,EAAE,WAAW;gBACzB,QAAQ,EAAE,IAAI,EAAE,aAAa;gBAC7B,UAAU,EAAE,EAAE;aACd;SACD,CAAC;QACF,OAAO,KAAK,CAAC;IACd,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,KAAa,EAAE,WAAmB,EAAE,IAA0B;QAC3F,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE;YAAE,OAAO,IAAI,CAAC;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAEhE,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI,WAAW,IAAI,IAAI,EAAE,EAAE,CAAC;QACrD,MAAM,SAAS,GAAG,IAAI,EAAE,aAAa,CAAC;QAEtC,OAAO;YACN,EAAE;YACF,KAAK;YACL,GAAG;YACH,QAAQ,EAAE,CAAC;YACX,SAAS;YACT,WAAW;YACX,MAAM,EAAE,IAAI,CAAC,IAAI;YACjB,QAAQ,EAAE;gBACT,MAAM,EAAE,IAAI,EAAE,WAAW;gBACzB,QAAQ,EAAE,IAAI,EAAE,aAAa;gBAC7B,UAAU,EAAE,EAAE;gBACd,IAAI;aACJ;SACD,CAAC;IACH,CAAC;IAEO,UAAU,CAAC,KAAa,EAAE,YAAoB,EAAE,EAAU;QACjE,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAClC,OAAO,4BAA4B,YAAY,IAAI,EAAE,EAAE,CAAC;QACzD,CAAC;QACD,IAAI,CAAC;YACJ,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;YACzB,MAAM,KAAK,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACpD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC;YACtC,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAC9B,OAAO,4BAA4B,IAAI,IAAI,MAAM,EAAE,CAAC;QACrD,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,4BAA4B,YAAY,IAAI,EAAE,EAAE,CAAC;QACzD,CAAC;IACF,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,OAAe;QAMxC,MAAM,QAAQ,GAAG,uCAAuC,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;QACtF,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,eAAe,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1D,OAAO,GAAG,CAAC,IAAI,EAKb,CAAC;IACJ,CAAC;CACD;AAvRD,sCAuRC"}
|
package/dist/TTSPlugin.d.ts
CHANGED
|
@@ -1,18 +1,25 @@
|
|
|
1
1
|
import { BasePlugin, Track, SearchResult, StreamInfo } from "ziplayer";
|
|
2
2
|
import { Readable } from "stream";
|
|
3
|
+
/**
|
|
4
|
+
* Configuration options for the TTSPlugin.
|
|
5
|
+
*/
|
|
3
6
|
export interface TTSPluginOptions {
|
|
7
|
+
/** Default language code for TTS (e.g., "vi", "en", "en-US") */
|
|
4
8
|
defaultLang?: string;
|
|
9
|
+
/** Whether to use slow speech rate */
|
|
5
10
|
slow?: boolean;
|
|
6
11
|
/**
|
|
7
12
|
* Optional custom TTS hook. If provided, it will be used to
|
|
8
13
|
* create the audio stream for the given text instead of the
|
|
9
14
|
* built-in Google TTS wrapper.
|
|
10
15
|
*
|
|
11
|
-
*
|
|
16
|
+
* @param text - The text to convert to speech
|
|
17
|
+
* @param ctx - Context information including language, speed, and track
|
|
18
|
+
* @returns One of:
|
|
12
19
|
* - Node Readable (preferred)
|
|
13
20
|
* - HTTP(S) URL string or URL object
|
|
14
21
|
* - Buffer / Uint8Array / ArrayBuffer
|
|
15
|
-
|
|
22
|
+
* - Or an object with { stream, type } | { url, type }
|
|
16
23
|
*/
|
|
17
24
|
createStream?: (text: string, ctx?: {
|
|
18
25
|
lang: string;
|
|
@@ -20,13 +27,127 @@ export interface TTSPluginOptions {
|
|
|
20
27
|
track?: Track;
|
|
21
28
|
}) => Promise<Readable | string | URL | Buffer | Uint8Array | ArrayBuffer> | Readable | string | URL | Buffer | Uint8Array | ArrayBuffer;
|
|
22
29
|
}
|
|
30
|
+
/**
|
|
31
|
+
* A plugin for Text-to-Speech (TTS) functionality.
|
|
32
|
+
*
|
|
33
|
+
* This plugin provides support for:
|
|
34
|
+
* - Converting text to speech using Google TTS
|
|
35
|
+
* - Custom TTS providers via the createStream hook
|
|
36
|
+
* - Multiple language support
|
|
37
|
+
* - Configurable speech rate (normal/slow)
|
|
38
|
+
* - TTS query parsing with language and speed options
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* const ttsPlugin = new TTSPlugin({
|
|
42
|
+
* defaultLang: "en",
|
|
43
|
+
* slow: false
|
|
44
|
+
* });
|
|
45
|
+
*
|
|
46
|
+
* // Add to PlayerManager
|
|
47
|
+
* const manager = new PlayerManager({
|
|
48
|
+
* plugins: [ttsPlugin]
|
|
49
|
+
* });
|
|
50
|
+
*
|
|
51
|
+
* // Search for TTS content
|
|
52
|
+
* const result = await ttsPlugin.search("tts:Hello world", "user123");
|
|
53
|
+
* const stream = await ttsPlugin.getStream(result.tracks[0]);
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* // Custom TTS provider
|
|
57
|
+
* const customTTSPlugin = new TTSPlugin({
|
|
58
|
+
* defaultLang: "en",
|
|
59
|
+
* createStream: async (text, ctx) => {
|
|
60
|
+
* // Custom TTS implementation
|
|
61
|
+
* return customTTSProvider.synthesize(text, ctx.lang);
|
|
62
|
+
* }
|
|
63
|
+
* });
|
|
64
|
+
*
|
|
65
|
+
* @since 1.0.0
|
|
66
|
+
*/
|
|
23
67
|
export declare class TTSPlugin extends BasePlugin {
|
|
24
68
|
name: string;
|
|
25
69
|
version: string;
|
|
26
70
|
private opts;
|
|
71
|
+
/**
|
|
72
|
+
* Creates a new TTSPlugin instance.
|
|
73
|
+
*
|
|
74
|
+
* @param opts - Configuration options for the TTS plugin
|
|
75
|
+
* @param opts.defaultLang - Default language code for TTS (default: "vi")
|
|
76
|
+
* @param opts.slow - Whether to use slow speech rate (default: false)
|
|
77
|
+
* @param opts.createStream - Optional custom TTS provider function
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* // Basic TTS with Vietnamese as default
|
|
81
|
+
* const ttsPlugin = new TTSPlugin();
|
|
82
|
+
*
|
|
83
|
+
* // TTS with English as default and slow speech
|
|
84
|
+
* const slowTTSPlugin = new TTSPlugin({
|
|
85
|
+
* defaultLang: "en",
|
|
86
|
+
* slow: true
|
|
87
|
+
* });
|
|
88
|
+
*
|
|
89
|
+
* // TTS with custom provider
|
|
90
|
+
* const customTTSPlugin = new TTSPlugin({
|
|
91
|
+
* defaultLang: "en",
|
|
92
|
+
* createStream: async (text, ctx) => {
|
|
93
|
+
* return await myCustomTTS.synthesize(text, ctx.lang);
|
|
94
|
+
* }
|
|
95
|
+
* });
|
|
96
|
+
*/
|
|
27
97
|
constructor(opts?: TTSPluginOptions);
|
|
98
|
+
/**
|
|
99
|
+
* Determines if this plugin can handle the given query.
|
|
100
|
+
*
|
|
101
|
+
* @param query - The search query to check
|
|
102
|
+
* @returns `true` if the query starts with "tts:" or "say ", `false` otherwise
|
|
103
|
+
*
|
|
104
|
+
* @example
|
|
105
|
+
* plugin.canHandle("tts:Hello world"); // true
|
|
106
|
+
* plugin.canHandle("say Hello world"); // true
|
|
107
|
+
* plugin.canHandle("youtube.com/watch?v=123"); // false
|
|
108
|
+
*/
|
|
28
109
|
canHandle(query: string): boolean;
|
|
110
|
+
/**
|
|
111
|
+
* Creates a TTS track from the given query.
|
|
112
|
+
*
|
|
113
|
+
* This method parses TTS queries and creates a track that can be played as audio.
|
|
114
|
+
* It supports various query formats including language and speed specifications.
|
|
115
|
+
*
|
|
116
|
+
* @param query - The TTS query to process
|
|
117
|
+
* @param requestedBy - The user ID who requested the TTS
|
|
118
|
+
* @returns A SearchResult containing a single TTS track
|
|
119
|
+
*
|
|
120
|
+
* @example
|
|
121
|
+
* // Basic TTS
|
|
122
|
+
* const result = await plugin.search("tts:Hello world", "user123");
|
|
123
|
+
*
|
|
124
|
+
* // TTS with specific language
|
|
125
|
+
* const result2 = await plugin.search("tts:en:Hello world", "user123");
|
|
126
|
+
*
|
|
127
|
+
* // TTS with language and slow speed
|
|
128
|
+
* const result3 = await plugin.search("tts:en:true:Hello world", "user123");
|
|
129
|
+
*
|
|
130
|
+
* // Using "say" prefix
|
|
131
|
+
* const result4 = await plugin.search("say Hello world", "user123");
|
|
132
|
+
*/
|
|
29
133
|
search(query: string, requestedBy: string): Promise<SearchResult>;
|
|
134
|
+
/**
|
|
135
|
+
* Generates an audio stream for a TTS track.
|
|
136
|
+
*
|
|
137
|
+
* This method converts the text in the track to speech using either the custom
|
|
138
|
+
* TTS provider (if configured) or the built-in Google TTS service. It handles
|
|
139
|
+
* various return types from custom providers and ensures proper stream formatting.
|
|
140
|
+
*
|
|
141
|
+
* @param track - The TTS track to convert to audio
|
|
142
|
+
* @returns A StreamInfo object containing the audio stream
|
|
143
|
+
* @throws {Error} If TTS generation fails or no audio URLs are returned
|
|
144
|
+
*
|
|
145
|
+
* @example
|
|
146
|
+
* const track = { id: "tts-123", title: "TTS: Hello world", ... };
|
|
147
|
+
* const streamInfo = await plugin.getStream(track);
|
|
148
|
+
* console.log(streamInfo.type); // "arbitrary"
|
|
149
|
+
* console.log(streamInfo.stream); // Readable stream with audio
|
|
150
|
+
*/
|
|
30
151
|
getStream(track: Track): Promise<StreamInfo>;
|
|
31
152
|
private toReadable;
|
|
32
153
|
private parseQuery;
|
package/dist/TTSPlugin.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TTSPlugin.d.ts","sourceRoot":"","sources":["../src/TTSPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAIlC,MAAM,WAAW,gBAAgB;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf
|
|
1
|
+
{"version":3,"file":"TTSPlugin.d.ts","sourceRoot":"","sources":["../src/TTSPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAIlC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,gEAAgE;IAChE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sCAAsC;IACtC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,EAAE,CACd,IAAI,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE,KAElD,OAAO,CAAC,QAAQ,GAAG,MAAM,GAAG,GAAG,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,CAAC,GACpE,QAAQ,GACR,MAAM,GACN,GAAG,GACH,MAAM,GACN,UAAU,GACV,WAAW,CAAC;CACf;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,SAAU,SAAQ,UAAU;IACxC,IAAI,SAAS;IACb,OAAO,SAAW;IAClB,OAAO,CAAC,IAAI,CAA0F;IAEtG;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;gBACS,IAAI,CAAC,EAAE,gBAAgB;IASnC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAMjC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAuBvE;;;;;;;;;;;;;;;;OAgBG;IACG,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC;YAsEpC,UAAU;IAgBxB,OAAO,CAAC,UAAU;IAiDlB,OAAO,CAAC,YAAY;IAKpB,OAAO,CAAC,aAAa;CAYrB"}
|