@ziplayer/plugin 0.1.0 → 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/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/index.d.ts +16 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +18 -1
- package/dist/index.js.map +1 -1
- package/package.json +2 -1
- package/src/YTSRPlugin.ts +564 -0
- package/src/index.ts +17 -0
package/YTSR_README.md
ADDED
|
@@ -0,0 +1,310 @@
|
|
|
1
|
+
# YTSRPlugin - Plugin Tìm Kiếm Nâng Cao YouTube
|
|
2
|
+
|
|
3
|
+
YTSRPlugin là một plugin mạnh mẽ cho ZiPlayer, cung cấp khả năng tìm kiếm nâng cao trên YouTube mà không cần tạo stream. Plugin
|
|
4
|
+
này sử dụng thư viện `youtube-sr` để tìm kiếm và trích xuất metadata từ YouTube.
|
|
5
|
+
|
|
6
|
+
## ✨ Tính Năng
|
|
7
|
+
|
|
8
|
+
- 🔍 **Tìm kiếm video nâng cao** với nhiều tùy chọn lọc
|
|
9
|
+
- 📋 **Tìm kiếm playlist** và channel
|
|
10
|
+
- 🎯 **Hỗ trợ nhiều loại tìm kiếm**: video, playlist, channel, hoặc tất cả
|
|
11
|
+
- ⏱️ **Lọc theo thời lượng**: short (< 4 phút), medium (4-20 phút), long (> 20 phút)
|
|
12
|
+
- 📅 **Lọc theo ngày upload**: hour, today, week, month, year
|
|
13
|
+
- 📊 **Sắp xếp kết quả**: relevance, uploadDate, viewCount, rating
|
|
14
|
+
- 🔗 **Hỗ trợ URL YouTube** trực tiếp
|
|
15
|
+
- 📱 **Metadata phong phú**: tác giả, lượt xem, mô tả, ngày upload, v.v.
|
|
16
|
+
- 🔄 **Video liên quan**: Tìm kiếm video liên quan cho một video cụ thể
|
|
17
|
+
- 🎵 **Mix Playlist**: Hỗ trợ xử lý YouTube Mix playlists (RD)
|
|
18
|
+
- ⚡ **Không streaming**: Chỉ trả về metadata, không tạo stream
|
|
19
|
+
|
|
20
|
+
## 🚀 Cài Đặt
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install youtube-sr
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## 📖 Cách Sử Dụng
|
|
27
|
+
|
|
28
|
+
### Khởi Tạo Plugin
|
|
29
|
+
|
|
30
|
+
```javascript
|
|
31
|
+
const { YTSRPlugin } = require("ziplayer/plugins");
|
|
32
|
+
const plugin = new YTSRPlugin();
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Tìm Kiếm Video Cơ Bản
|
|
36
|
+
|
|
37
|
+
```javascript
|
|
38
|
+
// Tìm kiếm video đơn giản
|
|
39
|
+
const result = await plugin.search("Never Gonna Give You Up", "user123");
|
|
40
|
+
console.log(`Tìm thấy ${result.tracks.length} video`);
|
|
41
|
+
|
|
42
|
+
result.tracks.forEach((track) => {
|
|
43
|
+
console.log(`${track.title} - ${track.metadata?.author}`);
|
|
44
|
+
console.log(`URL: ${track.url}`);
|
|
45
|
+
console.log(`Thời lượng: ${track.duration}s`);
|
|
46
|
+
});
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Tìm Kiếm Với Tùy Chọn Nâng Cao
|
|
50
|
+
|
|
51
|
+
```javascript
|
|
52
|
+
// Tìm kiếm với các filter nâng cao
|
|
53
|
+
const advancedResult = await plugin.search("chill music", "user123", {
|
|
54
|
+
limit: 10, // Số lượng kết quả tối đa
|
|
55
|
+
duration: "medium", // Thời lượng: short, medium, long, all
|
|
56
|
+
sortBy: "viewCount", // Sắp xếp: relevance, uploadDate, viewCount, rating
|
|
57
|
+
uploadDate: "month", // Ngày upload: hour, today, week, month, year, all
|
|
58
|
+
type: "video", // Loại: video, playlist, channel, all
|
|
59
|
+
});
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Tìm Kiếm Playlist
|
|
63
|
+
|
|
64
|
+
```javascript
|
|
65
|
+
// Tìm kiếm playlist
|
|
66
|
+
const playlistResult = await plugin.searchPlaylist("lofi hip hop", "user123", 5);
|
|
67
|
+
playlistResult.tracks.forEach((track) => {
|
|
68
|
+
console.log(`Playlist: ${track.title}`);
|
|
69
|
+
console.log(`Channel: ${track.metadata?.author}`);
|
|
70
|
+
console.log(`Số video: ${track.metadata?.videoCount}`);
|
|
71
|
+
});
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Tìm Kiếm Channel
|
|
75
|
+
|
|
76
|
+
```javascript
|
|
77
|
+
// Tìm kiếm channel
|
|
78
|
+
const channelResult = await plugin.searchChannel("PewDiePie", "user123", 3);
|
|
79
|
+
channelResult.tracks.forEach((track) => {
|
|
80
|
+
console.log(`Channel: ${track.title}`);
|
|
81
|
+
console.log(`Subscribers: ${track.metadata?.subscriberCount}`);
|
|
82
|
+
console.log(`URL: ${track.url}`);
|
|
83
|
+
});
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Tìm Kiếm Tất Cả Loại
|
|
87
|
+
|
|
88
|
+
```javascript
|
|
89
|
+
// Tìm kiếm tất cả loại (video, playlist, channel)
|
|
90
|
+
const allResult = await plugin.search("music", "user123", {
|
|
91
|
+
type: "all",
|
|
92
|
+
limit: 15,
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
allResult.tracks.forEach((track) => {
|
|
96
|
+
const type = track.metadata?.type || "video";
|
|
97
|
+
console.log(`[${type.toUpperCase()}] ${track.title}`);
|
|
98
|
+
});
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Xử Lý URL YouTube
|
|
102
|
+
|
|
103
|
+
```javascript
|
|
104
|
+
// Xử lý URL YouTube trực tiếp
|
|
105
|
+
const urlResult = await plugin.search("https://www.youtube.com/watch?v=dQw4w9WgXcQ", "user123");
|
|
106
|
+
if (urlResult.tracks.length > 0) {
|
|
107
|
+
const track = urlResult.tracks[0];
|
|
108
|
+
console.log(`Video: ${track.title}`);
|
|
109
|
+
console.log(`Tác giả: ${track.metadata?.author}`);
|
|
110
|
+
}
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Lấy Video Theo ID
|
|
114
|
+
|
|
115
|
+
```javascript
|
|
116
|
+
// Lấy video theo ID cụ thể
|
|
117
|
+
const video = await plugin.getVideoById("dQw4w9WgXcQ", "user123");
|
|
118
|
+
if (video) {
|
|
119
|
+
console.log(`Video: ${video.title}`);
|
|
120
|
+
console.log(`Tác giả: ${video.metadata?.author}`);
|
|
121
|
+
console.log(`URL: ${video.url}`);
|
|
122
|
+
}
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Lấy Video Liên Quan
|
|
126
|
+
|
|
127
|
+
```javascript
|
|
128
|
+
// Lấy video liên quan cho một video cụ thể
|
|
129
|
+
const relatedTracks = await plugin.getRelatedTracks("https://www.youtube.com/watch?v=dQw4w9WgXcQ", {
|
|
130
|
+
limit: 5, // Số lượng video liên quan tối đa
|
|
131
|
+
offset: 0, // Bỏ qua N video đầu tiên
|
|
132
|
+
history: [currentTrack], // Loại trừ các video đã phát
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
relatedTracks.forEach((track, index) => {
|
|
136
|
+
console.log(`${index + 1}. ${track.title} - ${track.metadata?.author}`);
|
|
137
|
+
});
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Xử Lý Mix Playlist (RD)
|
|
141
|
+
|
|
142
|
+
```javascript
|
|
143
|
+
// Xử lý YouTube Mix playlist (RD)
|
|
144
|
+
const mixResult = await plugin.handleMixPlaylist(
|
|
145
|
+
"https://www.youtube.com/watch?v=dQw4w9WgXcQ&list=RDMWGnHCaqxdU&start_radio=1",
|
|
146
|
+
"user123",
|
|
147
|
+
10, // Số lượng track tối đa
|
|
148
|
+
);
|
|
149
|
+
|
|
150
|
+
console.log(`Mix playlist: ${mixResult.playlist?.name}`);
|
|
151
|
+
console.log(`Tìm thấy ${mixResult.tracks.length} track trong Mix`);
|
|
152
|
+
|
|
153
|
+
mixResult.tracks.forEach((track, index) => {
|
|
154
|
+
console.log(`${index + 1}. ${track.title} - ${track.metadata?.author}`);
|
|
155
|
+
});
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
## 📋 API Reference
|
|
159
|
+
|
|
160
|
+
### `search(query, requestedBy, options?)`
|
|
161
|
+
|
|
162
|
+
Tìm kiếm nội dung trên YouTube với các tùy chọn nâng cao.
|
|
163
|
+
|
|
164
|
+
**Tham số:**
|
|
165
|
+
|
|
166
|
+
- `query` (string): Query tìm kiếm hoặc URL YouTube
|
|
167
|
+
- `requestedBy` (string): ID của user yêu cầu tìm kiếm
|
|
168
|
+
- `options` (object, tùy chọn):
|
|
169
|
+
- `limit` (number): Số lượng kết quả tối đa (mặc định: 10)
|
|
170
|
+
- `type` (string): Loại tìm kiếm - "video", "playlist", "channel", "all" (mặc định: "video")
|
|
171
|
+
- `duration` (string): Lọc theo thời lượng - "short", "medium", "long", "all" (mặc định: "all")
|
|
172
|
+
- `sortBy` (string): Sắp xếp - "relevance", "uploadDate", "viewCount", "rating" (mặc định: "relevance")
|
|
173
|
+
- `uploadDate` (string): Lọc theo ngày upload - "hour", "today", "week", "month", "year", "all" (mặc định: "all")
|
|
174
|
+
|
|
175
|
+
**Trả về:** `Promise<SearchResult>`
|
|
176
|
+
|
|
177
|
+
### `searchPlaylist(query, requestedBy, limit?)`
|
|
178
|
+
|
|
179
|
+
Tìm kiếm playlist trên YouTube.
|
|
180
|
+
|
|
181
|
+
**Tham số:**
|
|
182
|
+
|
|
183
|
+
- `query` (string): Query tìm kiếm playlist
|
|
184
|
+
- `requestedBy` (string): ID của user yêu cầu
|
|
185
|
+
- `limit` (number, tùy chọn): Số lượng playlist tối đa (mặc định: 5)
|
|
186
|
+
|
|
187
|
+
**Trả về:** `Promise<SearchResult>`
|
|
188
|
+
|
|
189
|
+
### `searchChannel(query, requestedBy, limit?)`
|
|
190
|
+
|
|
191
|
+
Tìm kiếm channel trên YouTube.
|
|
192
|
+
|
|
193
|
+
**Tham số:**
|
|
194
|
+
|
|
195
|
+
- `query` (string): Query tìm kiếm channel
|
|
196
|
+
- `requestedBy` (string): ID của user yêu cầu
|
|
197
|
+
- `limit` (number, tùy chọn): Số lượng channel tối đa (mặc định: 5)
|
|
198
|
+
|
|
199
|
+
**Trả về:** `Promise<SearchResult>`
|
|
200
|
+
|
|
201
|
+
### `getVideoById(videoId, requestedBy)`
|
|
202
|
+
|
|
203
|
+
Lấy thông tin video theo ID cụ thể.
|
|
204
|
+
|
|
205
|
+
**Tham số:**
|
|
206
|
+
|
|
207
|
+
- `videoId` (string): ID của video YouTube
|
|
208
|
+
- `requestedBy` (string): ID của user yêu cầu
|
|
209
|
+
|
|
210
|
+
**Trả về:** `Promise<Track | null>`
|
|
211
|
+
|
|
212
|
+
### `getRelatedTracks(trackURL, opts?)`
|
|
213
|
+
|
|
214
|
+
Lấy các video liên quan cho một video YouTube cụ thể.
|
|
215
|
+
|
|
216
|
+
**Tham số:**
|
|
217
|
+
|
|
218
|
+
- `trackURL` (string): URL của video YouTube để lấy video liên quan
|
|
219
|
+
- `opts` (object, tùy chọn):
|
|
220
|
+
- `limit` (number): Số lượng video liên quan tối đa (mặc định: 5)
|
|
221
|
+
- `offset` (number): Số lượng video bỏ qua từ đầu (mặc định: 0)
|
|
222
|
+
- `history` (Track[]): Mảng các track để loại trừ khỏi kết quả
|
|
223
|
+
|
|
224
|
+
**Trả về:** `Promise<Track[]>`
|
|
225
|
+
|
|
226
|
+
### `handleMixPlaylist(mixUrl, requestedBy, limit?)`
|
|
227
|
+
|
|
228
|
+
Xử lý YouTube Mix playlist (RD) và tạo danh sách các video liên quan.
|
|
229
|
+
|
|
230
|
+
**Tham số:**
|
|
231
|
+
|
|
232
|
+
- `mixUrl` (string): URL của playlist Mix YouTube
|
|
233
|
+
- `requestedBy` (string): ID của user yêu cầu
|
|
234
|
+
- `limit` (number, tùy chọn): Số lượng track tối đa (mặc định: 10)
|
|
235
|
+
|
|
236
|
+
**Trả về:** `Promise<SearchResult>`
|
|
237
|
+
|
|
238
|
+
### `canHandle(query)`
|
|
239
|
+
|
|
240
|
+
Kiểm tra xem plugin có thể xử lý query này không.
|
|
241
|
+
|
|
242
|
+
**Tham số:**
|
|
243
|
+
|
|
244
|
+
- `query` (string): Query để kiểm tra
|
|
245
|
+
|
|
246
|
+
**Trả về:** `boolean`
|
|
247
|
+
|
|
248
|
+
### `validate(url)`
|
|
249
|
+
|
|
250
|
+
Xác thực URL YouTube.
|
|
251
|
+
|
|
252
|
+
**Tham số:**
|
|
253
|
+
|
|
254
|
+
- `url` (string): URL để xác thực
|
|
255
|
+
|
|
256
|
+
**Trả về:** `boolean`
|
|
257
|
+
|
|
258
|
+
## ⚠️ Lưu Ý Quan Trọng
|
|
259
|
+
|
|
260
|
+
- **KHÔNG hỗ trợ streaming**: Plugin này chỉ dành cho tìm kiếm metadata, không tạo stream audio
|
|
261
|
+
- **KHÔNG hỗ trợ fallback**: Không có phương thức fallback streaming
|
|
262
|
+
- **Chỉ metadata**: Trả về thông tin về video/playlist/channel, không phải audio stream
|
|
263
|
+
- **Sử dụng với plugin khác**: Có thể kết hợp với YouTubePlugin để có cả tìm kiếm nâng cao và streaming
|
|
264
|
+
|
|
265
|
+
## 🔧 Tích Hợp Với Plugin Khác
|
|
266
|
+
|
|
267
|
+
```javascript
|
|
268
|
+
const { YTSRPlugin, YouTubePlugin } = require("ziplayer/plugins");
|
|
269
|
+
|
|
270
|
+
// Sử dụng YTSRPlugin để tìm kiếm nâng cao
|
|
271
|
+
const ytsrPlugin = new YTSRPlugin();
|
|
272
|
+
const searchResult = await ytsrPlugin.search("music", "user123", {
|
|
273
|
+
duration: "medium",
|
|
274
|
+
sortBy: "viewCount",
|
|
275
|
+
});
|
|
276
|
+
|
|
277
|
+
// Lấy video liên quan
|
|
278
|
+
const relatedTracks = await ytsrPlugin.getRelatedTracks(searchResult.tracks[0].url, {
|
|
279
|
+
limit: 3,
|
|
280
|
+
history: searchResult.tracks,
|
|
281
|
+
});
|
|
282
|
+
|
|
283
|
+
// Sử dụng YouTubePlugin để tạo stream
|
|
284
|
+
const youtubePlugin = new YouTubePlugin();
|
|
285
|
+
const stream = await youtubePlugin.getStream(searchResult.tracks[0]);
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
## 🧪 Testing
|
|
289
|
+
|
|
290
|
+
```bash
|
|
291
|
+
# Chạy test cho YTSRPlugin
|
|
292
|
+
npm test tests/plugins/ytsrplugin.test.js
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
## 📝 Ví Dụ Hoàn Chỉnh
|
|
296
|
+
|
|
297
|
+
Xem file `examples/ytsr-example.js` để có ví dụ chi tiết về cách sử dụng plugin.
|
|
298
|
+
|
|
299
|
+
## 🤝 Đóng Góp
|
|
300
|
+
|
|
301
|
+
Nếu bạn muốn đóng góp vào plugin này, vui lòng:
|
|
302
|
+
|
|
303
|
+
1. Fork repository
|
|
304
|
+
2. Tạo branch mới cho feature
|
|
305
|
+
3. Commit changes
|
|
306
|
+
4. Tạo Pull Request
|
|
307
|
+
|
|
308
|
+
## 📄 License
|
|
309
|
+
|
|
310
|
+
MIT License - xem file LICENSE để biết thêm chi tiết.
|
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
import { BasePlugin, Track, SearchResult } from "ziplayer";
|
|
2
|
+
/**
|
|
3
|
+
* Plugin YTSR để tìm kiếm nâng cao trên YouTube mà không cần tạo stream.
|
|
4
|
+
*
|
|
5
|
+
* Plugin này cung cấp các tính năng tìm kiếm nâng cao cho YouTube bao gồm:
|
|
6
|
+
* - Tìm kiếm video với nhiều tùy chọn lọc
|
|
7
|
+
* - Tìm kiếm playlist và channel
|
|
8
|
+
* - Hỗ trợ các loại tìm kiếm khác nhau (video, playlist, channel)
|
|
9
|
+
* - Không tạo stream, chỉ trả về metadata
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* const ytsrPlugin = new YTSRPlugin();
|
|
13
|
+
*
|
|
14
|
+
* // Tìm kiếm video
|
|
15
|
+
* const videoResult = await ytsrPlugin.search("Never Gonna Give You Up", "user123");
|
|
16
|
+
*
|
|
17
|
+
* // Tìm kiếm playlist
|
|
18
|
+
* const playlistResult = await ytsrPlugin.searchPlaylist("chill music playlist", "user123");
|
|
19
|
+
*
|
|
20
|
+
* // Tìm kiếm channel
|
|
21
|
+
* const channelResult = await ytsrPlugin.searchChannel("PewDiePie", "user123");
|
|
22
|
+
*
|
|
23
|
+
* @since 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
export declare class YTSRPlugin extends BasePlugin {
|
|
26
|
+
name: string;
|
|
27
|
+
version: string;
|
|
28
|
+
/**
|
|
29
|
+
* Tạo một instance mới của YTSRPlugin.
|
|
30
|
+
*
|
|
31
|
+
* Plugin này không cần khởi tạo bất kỳ client nào vì sử dụng youtube-sr
|
|
32
|
+
* để tìm kiếm thông tin từ YouTube.
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* const plugin = new YTSRPlugin();
|
|
36
|
+
* // Plugin sẵn sàng sử dụng ngay lập tức
|
|
37
|
+
*/
|
|
38
|
+
constructor();
|
|
39
|
+
/**
|
|
40
|
+
* Xác định xem plugin có thể xử lý query này không.
|
|
41
|
+
*
|
|
42
|
+
* @param query - Query tìm kiếm hoặc URL để kiểm tra
|
|
43
|
+
* @returns `true` nếu plugin có thể xử lý query, `false` nếu không
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* plugin.canHandle("Never Gonna Give You Up"); // true
|
|
47
|
+
* plugin.canHandle("https://www.youtube.com/watch?v=dQw4w9WgXcQ"); // true
|
|
48
|
+
* plugin.canHandle("spotify:track:123"); // false
|
|
49
|
+
*/
|
|
50
|
+
canHandle(query: string): boolean;
|
|
51
|
+
/**
|
|
52
|
+
* Xác thực xem URL có phải là URL YouTube hợp lệ không.
|
|
53
|
+
*
|
|
54
|
+
* @param url - URL để xác thực
|
|
55
|
+
* @returns `true` nếu URL hợp lệ, `false` nếu không
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* plugin.validate("https://www.youtube.com/watch?v=dQw4w9WgXcQ"); // true
|
|
59
|
+
* plugin.validate("https://youtu.be/dQw4w9WgXcQ"); // true
|
|
60
|
+
* plugin.validate("https://spotify.com/track/123"); // false
|
|
61
|
+
*/
|
|
62
|
+
validate(url: string): boolean;
|
|
63
|
+
/**
|
|
64
|
+
* Tìm kiếm video trên YouTube với các tùy chọn nâng cao.
|
|
65
|
+
*
|
|
66
|
+
* @param query - Query tìm kiếm
|
|
67
|
+
* @param requestedBy - ID của user yêu cầu tìm kiếm
|
|
68
|
+
* @param options - Tùy chọn tìm kiếm nâng cao
|
|
69
|
+
* @param options.limit - Số lượng kết quả tối đa (mặc định: 10)
|
|
70
|
+
* @param options.type - Loại tìm kiếm: "video", "playlist", "channel", "all" (mặc định: "video")
|
|
71
|
+
* @param options.duration - Lọc theo thời lượng: "short", "medium", "long", "all" (mặc định: "all")
|
|
72
|
+
* @param options.sortBy - Sắp xếp theo: "relevance", "uploadDate", "viewCount", "rating" (mặc định: "relevance")
|
|
73
|
+
* @param options.uploadDate - Lọc theo ngày upload: "hour", "today", "week", "month", "year", "all" (mặc định: "all")
|
|
74
|
+
* @returns SearchResult chứa các track được tìm thấy
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* // Tìm kiếm video cơ bản
|
|
78
|
+
* const result = await plugin.search("Never Gonna Give You Up", "user123");
|
|
79
|
+
*
|
|
80
|
+
* // Tìm kiếm với tùy chọn nâng cao
|
|
81
|
+
* const advancedResult = await plugin.search("chill music", "user123", {
|
|
82
|
+
* limit: 5,
|
|
83
|
+
* duration: "medium",
|
|
84
|
+
* sortBy: "viewCount",
|
|
85
|
+
* uploadDate: "month"
|
|
86
|
+
* });
|
|
87
|
+
*/
|
|
88
|
+
search(query: string, requestedBy: string, options?: {
|
|
89
|
+
limit?: number;
|
|
90
|
+
type?: "video" | "playlist" | "channel" | "all";
|
|
91
|
+
duration?: "short" | "medium" | "long" | "all";
|
|
92
|
+
sortBy?: "relevance" | "uploadDate" | "viewCount" | "rating";
|
|
93
|
+
uploadDate?: "hour" | "today" | "week" | "month" | "year" | "all";
|
|
94
|
+
}): Promise<SearchResult>;
|
|
95
|
+
/**
|
|
96
|
+
* Tìm kiếm playlist trên YouTube.
|
|
97
|
+
*
|
|
98
|
+
* @param query - Query tìm kiếm playlist
|
|
99
|
+
* @param requestedBy - ID của user yêu cầu tìm kiếm
|
|
100
|
+
* @param limit - Số lượng playlist tối đa (mặc định: 5)
|
|
101
|
+
* @returns SearchResult chứa các playlist được tìm thấy
|
|
102
|
+
*
|
|
103
|
+
* @example
|
|
104
|
+
* const playlists = await plugin.searchPlaylist("chill music playlist", "user123", 3);
|
|
105
|
+
* console.log(`Tìm thấy ${playlists.tracks.length} playlist`);
|
|
106
|
+
*/
|
|
107
|
+
searchPlaylist(query: string, requestedBy: string, limit?: number): Promise<SearchResult>;
|
|
108
|
+
/**
|
|
109
|
+
* Tìm kiếm channel trên YouTube.
|
|
110
|
+
*
|
|
111
|
+
* @param query - Query tìm kiếm channel
|
|
112
|
+
* @param requestedBy - ID của user yêu cầu tìm kiếm
|
|
113
|
+
* @param limit - Số lượng channel tối đa (mặc định: 5)
|
|
114
|
+
* @returns SearchResult chứa các channel được tìm thấy
|
|
115
|
+
*
|
|
116
|
+
* @example
|
|
117
|
+
* const channels = await plugin.searchChannel("PewDiePie", "user123", 3);
|
|
118
|
+
* console.log(`Tìm thấy ${channels.tracks.length} channel`);
|
|
119
|
+
*/
|
|
120
|
+
searchChannel(query: string, requestedBy: string, limit?: number): Promise<SearchResult>;
|
|
121
|
+
/**
|
|
122
|
+
* Tìm kiếm video theo ID cụ thể.
|
|
123
|
+
*
|
|
124
|
+
* @param videoId - ID của video YouTube
|
|
125
|
+
* @param requestedBy - ID của user yêu cầu
|
|
126
|
+
* @returns Track object của video
|
|
127
|
+
*
|
|
128
|
+
* @example
|
|
129
|
+
* const video = await plugin.getVideoById("dQw4w9WgXcQ", "user123");
|
|
130
|
+
* console.log(video.title);
|
|
131
|
+
*/
|
|
132
|
+
getVideoById(videoId: string, requestedBy: string): Promise<Track | null>;
|
|
133
|
+
/**
|
|
134
|
+
* Lấy thông tin chi tiết của video từ ID.
|
|
135
|
+
*
|
|
136
|
+
* @param videoId - ID của video YouTube
|
|
137
|
+
* @returns Video object hoặc null nếu không tìm thấy
|
|
138
|
+
*/
|
|
139
|
+
private getVideoByIdInternal;
|
|
140
|
+
/**
|
|
141
|
+
* Xây dựng Track object từ Video object của youtube-sr.
|
|
142
|
+
*
|
|
143
|
+
* @param video - Video object từ youtube-sr
|
|
144
|
+
* @param requestedBy - ID của user yêu cầu
|
|
145
|
+
* @returns Track object
|
|
146
|
+
*/
|
|
147
|
+
private buildTrackFromVideo;
|
|
148
|
+
/**
|
|
149
|
+
* Xây dựng Track object từ Playlist object của youtube-sr.
|
|
150
|
+
*
|
|
151
|
+
* @param playlist - Playlist object từ youtube-sr
|
|
152
|
+
* @param requestedBy - ID của user yêu cầu
|
|
153
|
+
* @returns Track object
|
|
154
|
+
*/
|
|
155
|
+
private buildTrackFromPlaylist;
|
|
156
|
+
/**
|
|
157
|
+
* Xây dựng Track object từ Channel object của youtube-sr.
|
|
158
|
+
*
|
|
159
|
+
* @param channel - Channel object từ youtube-sr
|
|
160
|
+
* @param requestedBy - ID của user yêu cầu
|
|
161
|
+
* @returns Track object
|
|
162
|
+
*/
|
|
163
|
+
private buildTrackFromChannel;
|
|
164
|
+
/**
|
|
165
|
+
* Xử lý playlist Mix (RD) của YouTube (internal).
|
|
166
|
+
*
|
|
167
|
+
* @param url - URL của playlist Mix
|
|
168
|
+
* @param requestedBy - ID của user yêu cầu
|
|
169
|
+
* @param limit - Số lượng track tối đa
|
|
170
|
+
* @returns SearchResult chứa các track từ Mix
|
|
171
|
+
*/
|
|
172
|
+
private handleMixPlaylistInternal;
|
|
173
|
+
/**
|
|
174
|
+
* Kiểm tra xem listId có phải là Mix playlist không.
|
|
175
|
+
*
|
|
176
|
+
* @param listId - ID của playlist
|
|
177
|
+
* @returns true nếu là Mix playlist
|
|
178
|
+
*/
|
|
179
|
+
private isMixListId;
|
|
180
|
+
/**
|
|
181
|
+
* Trích xuất playlist ID từ URL YouTube.
|
|
182
|
+
*
|
|
183
|
+
* @param input - URL chứa playlist ID
|
|
184
|
+
* @returns Playlist ID hoặc null nếu không tìm thấy
|
|
185
|
+
*/
|
|
186
|
+
private extractListId;
|
|
187
|
+
/**
|
|
188
|
+
* Trích xuất video ID từ URL YouTube.
|
|
189
|
+
*
|
|
190
|
+
* @param input - URL hoặc string chứa video ID
|
|
191
|
+
* @returns Video ID hoặc null nếu không tìm thấy
|
|
192
|
+
*/
|
|
193
|
+
private extractVideoId;
|
|
194
|
+
/**
|
|
195
|
+
* Plugin này không hỗ trợ tạo stream, chỉ dành cho tìm kiếm metadata.
|
|
196
|
+
*
|
|
197
|
+
* @param track - Track object
|
|
198
|
+
* @throws Error vì plugin này không hỗ trợ streaming
|
|
199
|
+
*/
|
|
200
|
+
getStream(track: Track): Promise<any>;
|
|
201
|
+
/**
|
|
202
|
+
* Xử lý playlist Mix (RD) của YouTube.
|
|
203
|
+
*
|
|
204
|
+
* @param mixUrl - URL của playlist Mix YouTube
|
|
205
|
+
* @param requestedBy - ID của user yêu cầu
|
|
206
|
+
* @param limit - Số lượng track tối đa (mặc định: 10)
|
|
207
|
+
* @returns SearchResult chứa các track từ Mix playlist
|
|
208
|
+
*
|
|
209
|
+
* @example
|
|
210
|
+
* const mixResult = await plugin.handleMixPlaylist(
|
|
211
|
+
* "https://www.youtube.com/watch?v=dQw4w9WgXcQ&list=RDMWGnHCaqxdU&start_radio=1",
|
|
212
|
+
* "user123",
|
|
213
|
+
* 15
|
|
214
|
+
* );
|
|
215
|
+
* console.log(`Mix playlist: ${mixResult.playlist?.name}`);
|
|
216
|
+
* console.log(`Tìm thấy ${mixResult.tracks.length} track trong Mix`);
|
|
217
|
+
*/
|
|
218
|
+
handleMixPlaylist(mixUrl: string, requestedBy: string, limit?: number): Promise<SearchResult>;
|
|
219
|
+
/**
|
|
220
|
+
* Lấy các video liên quan cho một video YouTube cụ thể.
|
|
221
|
+
*
|
|
222
|
+
* @param trackURL - URL của video YouTube để lấy video liên quan
|
|
223
|
+
* @param opts - Tùy chọn cho việc lọc và giới hạn kết quả
|
|
224
|
+
* @param opts.limit - Số lượng video liên quan tối đa (mặc định: 5)
|
|
225
|
+
* @param opts.offset - Số lượng video bỏ qua từ đầu (mặc định: 0)
|
|
226
|
+
* @param opts.history - Mảng các track để loại trừ khỏi kết quả
|
|
227
|
+
* @returns Mảng các Track object liên quan
|
|
228
|
+
*
|
|
229
|
+
* @example
|
|
230
|
+
* const related = await plugin.getRelatedTracks(
|
|
231
|
+
* "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
|
|
232
|
+
* { limit: 3, history: [currentTrack] }
|
|
233
|
+
* );
|
|
234
|
+
* console.log(`Tìm thấy ${related.length} video liên quan`);
|
|
235
|
+
*/
|
|
236
|
+
getRelatedTracks(trackURL: string, opts?: {
|
|
237
|
+
limit?: number;
|
|
238
|
+
offset?: number;
|
|
239
|
+
history?: Track[];
|
|
240
|
+
}): Promise<Track[]>;
|
|
241
|
+
/**
|
|
242
|
+
* Plugin này không hỗ trợ fallback stream.
|
|
243
|
+
*
|
|
244
|
+
* @param track - Track object
|
|
245
|
+
* @throws Error vì plugin này không hỗ trợ streaming
|
|
246
|
+
*/
|
|
247
|
+
getFallback(track: Track): Promise<any>;
|
|
248
|
+
}
|
|
249
|
+
//# sourceMappingURL=YTSRPlugin.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"YTSRPlugin.d.ts","sourceRoot":"","sources":["../src/YTSRPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAG3D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACzC,IAAI,SAAU;IACd,OAAO,SAAW;IAElB;;;;;;;;;OASG;;IAKH;;;;;;;;;;OAUG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAuBjC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAU9B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,MAAM,CACX,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE;QACR,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,KAAK,CAAC;QAChD,QAAQ,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC;QAC/C,MAAM,CAAC,EAAE,WAAW,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;QAC7D,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;KAC7D,GACJ,OAAO,CAAC,YAAY,CAAC;IAyExB;;;;;;;;;;;OAWG;IACG,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,GAAE,MAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAIlG;;;;;;;;;;;OAWG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,GAAE,MAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAIjG;;;;;;;;;;OAUG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAS/E;;;;;OAKG;YACW,oBAAoB;IAUlC;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB;IAoB3B;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;IAsB9B;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB;IAsB7B;;;;;;;OAOG;YACW,yBAAyB;IA0CvC;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAKnB;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IASrB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAwBtB;;;;;OAKG;IACG,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAI3C;;;;;;;;;;;;;;;;OAgBG;IACG,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,YAAY,CAAC;IAIvG;;;;;;;;;;;;;;;;OAgBG;IACG,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAA;KAAO,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAwC7H;;;;;OAKG;IACG,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;CAG7C"}
|