tunzo-player 1.0.0 → 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.
Files changed (2) hide show
  1. package/README.md +78 -0
  2. package/package.json +8 -2
package/README.md ADDED
@@ -0,0 +1,78 @@
1
+ # Tunzo Player 🎵
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@kulasekaran/tunzo-player.svg?style=for-the-badge)](https://www.npmjs.com/package/@kulasekaran/tunzo-player)
4
+ [![npm downloads](https://img.shields.io/npm/dt/@kulasekaran/tunzo-player.svg?style=for-the-badge)](https://www.npmjs.com/package/@kulasekaran/tunzo-player)
5
+ [![License](https://img.shields.io/npm/l/@kulasekaran/tunzo-player.svg?style=for-the-badge)](LICENSE)
6
+ [![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg?style=for-the-badge)](#)
7
+ [![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white)](#)
8
+ [![Ionic](https://img.shields.io/badge/Ionic-3880FF?style=for-the-badge&logo=ionic&logoColor=white)](#)
9
+
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
12
+
13
+ <!-- ![Tunzo Player Demo](https://via.placeholder.com/800x400?text=Tunzo+Player+Demo+GIF/Image)
14
+ *(Consider adding a real screenshot or animated GIF here)* -->
15
+
16
+ ## ✨ Features
17
+
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 |
25
+
26
+
27
+ ## 💻 Basic Usage
28
+
29
+ ```bash
30
+ import {
31
+ TunzoPlayer,
32
+ StreamSettings,
33
+ ThemeManager,
34
+ Favorites,
35
+ TunzoPlayerAPI
36
+ } from '@kulasekaran/tunzo-player';
37
+
38
+ // Initialize components
39
+ const player = new TunzoPlayer();
40
+ const api = new TunzoPlayerAPI();
41
+
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
62
+
63
+ ```bash
64
+ npm i tunzo-player
65
+ # or
66
+ yarn add tunzo-player
67
+ ```
68
+
69
+ ## 🎚️ Stream Quality Options
70
+
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) |
78
+
package/package.json CHANGED
@@ -1,13 +1,19 @@
1
1
  {
2
2
  "name": "tunzo-player",
3
- "version": "1.0.0",
3
+ "version": "1.0.4",
4
4
  "description": "A music playback service for Angular and Ionic apps with native audio control support.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "scripts": {
8
8
  "build": "tsc"
9
9
  },
10
- "keywords": ["music", "player", "angular", "ionic", "audio"],
10
+ "keywords": [
11
+ "music",
12
+ "player",
13
+ "angular",
14
+ "ionic",
15
+ "audio"
16
+ ],
11
17
  "author": "Kulasekaran",
12
18
  "license": "MIT",
13
19
  "publishConfig": {