tunzo-player 1.0.3 → 1.0.4
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/README.md +55 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,51 +1,78 @@
|
|
|
1
1
|
# Tunzo Player 🎵
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@kulasekaran/tunzo-player)
|
|
4
|
-
[](https://www.npmjs.com/package/@kulasekaran/tunzo-player)
|
|
5
|
-
[](LICENSE)
|
|
6
|
-
[](https://www.npmjs.com/package/@kulasekaran/tunzo-player)
|
|
4
|
+
[](https://www.npmjs.com/package/@kulasekaran/tunzo-player)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
[](#)
|
|
7
|
+
[](#)
|
|
8
|
+
[](#)
|
|
7
9
|
|
|
8
|
-
>
|
|
10
|
+
> Built for the **Tunzo Music App** — now available as a reusable npm package
|
|
11
|
+
> A feature-rich audio playback utility for Angular + Ionic applications
|
|
9
12
|
|
|
10
|
-
|
|
13
|
+
<!-- 
|
|
14
|
+
*(Consider adding a real screenshot or animated GIF here)* -->
|
|
11
15
|
|
|
12
|
-
##
|
|
16
|
+
## ✨ Features
|
|
13
17
|
|
|
14
|
-
|
|
15
|
-
|
|
18
|
+
| Category | Features |
|
|
19
|
+
|----------------|--------------------------------------------------------------------------|
|
|
20
|
+
| **Playback** | Queue management, Shuffle, Repeat, Crossfade |
|
|
21
|
+
| **Quality** | Dynamic stream quality (12kbps to 320kbps) |
|
|
22
|
+
| **UI** | Dark/Light theme support with auto-detection |
|
|
23
|
+
| **Storage** | Firestore & localStorage integration for favorites |
|
|
24
|
+
| **Modular** | Reusable service classes with clean API |
|
|
16
25
|
|
|
17
|
-
---
|
|
18
26
|
|
|
19
|
-
##
|
|
27
|
+
## 💻 Basic Usage
|
|
20
28
|
|
|
21
29
|
```bash
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
🧱 Usage Example:
|
|
26
|
-
|
|
27
|
-
import {
|
|
30
|
+
import {
|
|
28
31
|
TunzoPlayer,
|
|
29
|
-
StreamSettings,
|
|
32
|
+
StreamSettings,
|
|
30
33
|
ThemeManager,
|
|
31
34
|
Favorites,
|
|
32
35
|
TunzoPlayerAPI
|
|
33
36
|
} from '@kulasekaran/tunzo-player';
|
|
34
37
|
|
|
38
|
+
// Initialize components
|
|
35
39
|
const player = new TunzoPlayer();
|
|
36
40
|
const api = new TunzoPlayerAPI();
|
|
37
41
|
|
|
38
|
-
//
|
|
39
|
-
|
|
42
|
+
// Example workflow
|
|
43
|
+
async function playMusic() {
|
|
44
|
+
// Search songs
|
|
45
|
+
const results = await api.searchSongs('popular songs');
|
|
46
|
+
|
|
47
|
+
// Play first result
|
|
48
|
+
player.playSong(results[0]);
|
|
49
|
+
|
|
50
|
+
// Like the song
|
|
51
|
+
Favorites.like(results[0]);
|
|
52
|
+
|
|
53
|
+
// Set quality to High
|
|
54
|
+
StreamSettings.setQuality(3);
|
|
55
|
+
|
|
56
|
+
// Enable dark mode
|
|
57
|
+
ThemeManager.toggleDarkMode(true);
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## 🚀 Installation
|
|
40
62
|
|
|
41
|
-
|
|
42
|
-
player
|
|
63
|
+
```bash
|
|
64
|
+
npm i tunzo-player
|
|
65
|
+
# or
|
|
66
|
+
yarn add tunzo-player
|
|
67
|
+
```
|
|
43
68
|
|
|
44
|
-
|
|
45
|
-
Favorites.like(songs[0]);
|
|
69
|
+
## 🎚️ Stream Quality Options
|
|
46
70
|
|
|
47
|
-
|
|
48
|
-
|
|
71
|
+
| Value | Label |
|
|
72
|
+
| ----- | ----------------- |
|
|
73
|
+
| 0 | Very Low (12kbps) |
|
|
74
|
+
| 1 | Low (48kbps) |
|
|
75
|
+
| 2 | Medium (96kbps) |
|
|
76
|
+
| 3 | High (160kbps) |
|
|
77
|
+
| 4 | Ultra (320kbps) |
|
|
49
78
|
|
|
50
|
-
// Set quality to Ultra (320kbps)
|
|
51
|
-
StreamSettings.setQuality(3);
|