@nuclearplayer/plugin-sdk 1.2.0 → 2.1.0
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 +16 -0
- package/dist/index.d.ts +713 -19
- package/dist/index.js +2914 -221
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -100,6 +100,22 @@ export default {
|
|
|
100
100
|
};
|
|
101
101
|
```
|
|
102
102
|
|
|
103
|
+
## Domain APIs
|
|
104
|
+
|
|
105
|
+
The `api` object passed to lifecycle hooks provides access to these domain APIs:
|
|
106
|
+
|
|
107
|
+
| API | Description |
|
|
108
|
+
|-----|-------------|
|
|
109
|
+
| `api.Settings` | Define, read, and persist plugin settings |
|
|
110
|
+
| `api.Queue` | Read and manipulate the playback queue |
|
|
111
|
+
| `api.Favorites` | Manage the user's favorite tracks |
|
|
112
|
+
| `api.Providers` | Register and unregister providers |
|
|
113
|
+
| `api.Streaming` | Resolve audio stream URLs for tracks |
|
|
114
|
+
| `api.Metadata` | Search and fetch artist/album/track details |
|
|
115
|
+
| `api.Dashboard` | Fetch dashboard content (top tracks, new releases, etc.) |
|
|
116
|
+
|
|
117
|
+
See the [full documentation](https://docs.nuclearplayer.com/nuclear-xrd) for detailed guides on each API.
|
|
118
|
+
|
|
103
119
|
## Permissions
|
|
104
120
|
|
|
105
121
|
Declare what your plugin does in the `permissions` array. Permissions are currently informational. Future versions might show UI for this.
|