mirror of
https://github.com/Mastermindzh/tidal-hifi.git
synced 2025-05-14 23:03:03 +02:00
Merge pull request #424 from Times-Z/master
doc: update swagger with all routes
This commit is contained in:
GitHub
commit
8b09759e5e
@ -3,7 +3,110 @@ import fs from "fs";
|
||||
import { mediaInfo } from "../../../scripts/mediaInfo";
|
||||
|
||||
export const addCurrentInfo = (expressApp: Router) => {
|
||||
/**
|
||||
* @swagger
|
||||
* tags:
|
||||
* name: current
|
||||
* description: The current media info API
|
||||
* components:
|
||||
* schemas:
|
||||
* MediaInfo:
|
||||
* type: object
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* artists:
|
||||
* type: string
|
||||
* album:
|
||||
* type: string
|
||||
* icon:
|
||||
* type: string
|
||||
* format: uri
|
||||
* playingFrom:
|
||||
* type: string
|
||||
* status:
|
||||
* type: string
|
||||
* url:
|
||||
* type: string
|
||||
* format: uri
|
||||
* current:
|
||||
* type: string
|
||||
* currentInSeconds:
|
||||
* type: integer
|
||||
* duration:
|
||||
* type: string
|
||||
* durationInSeconds:
|
||||
* type: integer
|
||||
* image:
|
||||
* type: string
|
||||
* format: uri
|
||||
* favorite:
|
||||
* type: boolean
|
||||
* player:
|
||||
* type: object
|
||||
* properties:
|
||||
* status:
|
||||
* type: string
|
||||
* shuffle:
|
||||
* type: boolean
|
||||
* repeat:
|
||||
* type: string
|
||||
* artist:
|
||||
* type: string
|
||||
* example:
|
||||
* title: "Sample Title"
|
||||
* artists: "Sample Artist"
|
||||
* album: "Sample Album"
|
||||
* icon: "/path/to/sample/icon.jpg"
|
||||
* playingFrom: "Sample Playlist"
|
||||
* status: "playing"
|
||||
* url: "https://tidal.com/browse/track/sample"
|
||||
* current: "1:23"
|
||||
* currentInSeconds: 83
|
||||
* duration: "3:45"
|
||||
* durationInSeconds: 225
|
||||
* image: "https://example.com/sample-image.jpg"
|
||||
* favorite: true
|
||||
* player:
|
||||
* status: "playing"
|
||||
* shuffle: true
|
||||
* repeat: "one"
|
||||
* artist: "Sample Artist"
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /current:
|
||||
* get:
|
||||
* summary: Get current media info
|
||||
* tags: [current]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Current media info
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/MediaInfo'
|
||||
*/
|
||||
expressApp.get("/current", (req, res) => res.json({ ...mediaInfo, artist: mediaInfo.artists }));
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /current/image:
|
||||
* get:
|
||||
* summary: Get current media image
|
||||
* tags: [current]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Current media image
|
||||
* content:
|
||||
* image/png:
|
||||
* schema:
|
||||
* type: string
|
||||
* format: binary
|
||||
* 404:
|
||||
* description: Not found
|
||||
*/
|
||||
expressApp.get("/current/image", getCurrentImage);
|
||||
};
|
||||
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import { BrowserWindow } from "electron";
|
||||
import { Router } from "express";
|
||||
import { globalEvents } from "../../../constants/globalEvents";
|
||||
@ -12,19 +11,148 @@ export const addPlaybackControl = (expressApp: Router, mainWindow: BrowserWindow
|
||||
const windowEvent = handleWindowEvent(mainWindow);
|
||||
const createRoute = (route: string) => `/player${route}`;
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* tags:
|
||||
* name: player
|
||||
* description: The player control API
|
||||
* components:
|
||||
* schemas:
|
||||
* OkResponse:
|
||||
* type: string
|
||||
* example: "OK"
|
||||
*/
|
||||
const createPlayerAction = (route: string, action: string) => {
|
||||
expressApp.post(createRoute(route), (req, res) => windowEvent(res, action));
|
||||
};
|
||||
|
||||
if (settingsStore.get(settings.playBackControl)) {
|
||||
/**
|
||||
* @swagger
|
||||
* /player/play:
|
||||
* post:
|
||||
* summary: Play the current media
|
||||
* tags: [player]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
createPlayerAction("/play", globalEvents.play);
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /player/favorite/toggle:
|
||||
* post:
|
||||
* summary: Add the current media to your favorites, or remove it if its already added to your favorites
|
||||
* tags: [player]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
createPlayerAction("/favorite/toggle", globalEvents.toggleFavorite);
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /player/pause:
|
||||
* post:
|
||||
* summary: Pause the current media
|
||||
* tags: [player]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
createPlayerAction("/pause", globalEvents.pause);
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /player/next:
|
||||
* post:
|
||||
* summary: Play the next song
|
||||
* tags: [player]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
createPlayerAction("/next", globalEvents.next);
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /player/previous:
|
||||
* post:
|
||||
* summary: Play the previous song
|
||||
* tags: [player]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
createPlayerAction("/previous", globalEvents.previous);
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /player/shuffle/toggle:
|
||||
* post:
|
||||
* summary: Play the previous song
|
||||
* tags: [player]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
createPlayerAction("/shuffle/toggle", globalEvents.toggleShuffle);
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /player/repeat/toggle:
|
||||
* post:
|
||||
* summary: Toggle the repeat status, toggles between "off" , "single" and "all"
|
||||
* tags: [player]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
createPlayerAction("/repeat/toggle", globalEvents.toggleRepeat);
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /player/playpause:
|
||||
* post:
|
||||
* summary: Start playing the media if paused, or pause the media if playing
|
||||
* tags: [player]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
expressApp.post(createRoute("/playpause"), (req, res) => {
|
||||
if (mediaInfo.status === MediaStatus.playing) {
|
||||
windowEvent(res, globalEvents.pause);
|
||||
|
||||
@ -13,19 +13,132 @@ import { getCurrentImage } from "./features/current";
|
||||
* @param mainWindow
|
||||
*/
|
||||
export const addLegacyApi = (expressApp: Router, mainWindow: BrowserWindow) => {
|
||||
/**
|
||||
* @swagger
|
||||
* /image:
|
||||
* get:
|
||||
* summary: Get current image
|
||||
* tags: [legacy]
|
||||
* deprecated: true
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Current image
|
||||
* content:
|
||||
* image/png:
|
||||
* schema:
|
||||
* type: string
|
||||
* format: binary
|
||||
* 404:
|
||||
* description: Not found
|
||||
*/
|
||||
expressApp.get("/image", getCurrentImage);
|
||||
|
||||
if (settingsStore.get(settings.playBackControl)) {
|
||||
addLegacyControls();
|
||||
}
|
||||
function addLegacyControls() {
|
||||
/**
|
||||
* @swagger
|
||||
* /play:
|
||||
* get:
|
||||
* summary: Play the current media
|
||||
* tags: [legacy]
|
||||
* deprecated: true
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Action performed
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
expressApp.get("/play", ({ res }) => handleGlobalEvent(res, globalEvents.play));
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /favorite/toggle:
|
||||
* get:
|
||||
* summary: Add the current media to your favorites, or remove it if its already added to your favorites
|
||||
* tags: [legacy]
|
||||
* deprecated: true
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
expressApp.post("/favorite/toggle", (req, res) =>
|
||||
handleGlobalEvent(res, globalEvents.toggleFavorite)
|
||||
);
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /pause:
|
||||
* get:
|
||||
* summary: Pause the current media
|
||||
* tags: [legacy]
|
||||
* deprecated: true
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
expressApp.get("/pause", (req, res) => handleGlobalEvent(res, globalEvents.pause));
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /next:
|
||||
* get:
|
||||
* summary: Play the next song
|
||||
* tags: [legacy]
|
||||
* deprecated: true
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
expressApp.get("/next", (req, res) => handleGlobalEvent(res, globalEvents.next));
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /previous:
|
||||
* get:
|
||||
* summary: Play the previous song
|
||||
* tags: [legacy]
|
||||
* deprecated: true
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
expressApp.get("/previous", (req, res) => handleGlobalEvent(res, globalEvents.previous));
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /playpause:
|
||||
* get:
|
||||
* summary: Toggle play/pause
|
||||
* tags: [legacy]
|
||||
* deprecated: true
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Ok
|
||||
* content:
|
||||
* text/plain:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/OkResponse'
|
||||
*/
|
||||
expressApp.get("/playpause", (req, res) => {
|
||||
if (mediaInfo.status === MediaStatus.playing) {
|
||||
handleGlobalEvent(res, globalEvents.pause);
|
||||
|
||||
@ -18,6 +18,210 @@
|
||||
"url": "swagger.json"
|
||||
},
|
||||
"paths": {
|
||||
"/current": {
|
||||
"get": {
|
||||
"summary": "Get current media info",
|
||||
"tags": [
|
||||
"current"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Current media info",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/MediaInfo"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/current/image": {
|
||||
"get": {
|
||||
"summary": "Get current media image",
|
||||
"tags": [
|
||||
"current"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Current media image",
|
||||
"content": {
|
||||
"image/png": {
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"format": "binary"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not found"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/player/play": {
|
||||
"post": {
|
||||
"summary": "Play action",
|
||||
"tags": [
|
||||
"player"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/player/favorite/toggle": {
|
||||
"post": {
|
||||
"summary": "Add the current song to your favorites, or remove it if its already added to your favorites",
|
||||
"tags": [
|
||||
"player"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/player/pause": {
|
||||
"post": {
|
||||
"summary": "Pause action",
|
||||
"tags": [
|
||||
"player"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/player/next": {
|
||||
"post": {
|
||||
"summary": "Play the next song",
|
||||
"tags": [
|
||||
"player"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/player/previous": {
|
||||
"post": {
|
||||
"summary": "Play the previous song",
|
||||
"tags": [
|
||||
"player"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/player/shuffle/toggle": {
|
||||
"post": {
|
||||
"summary": "Previous action",
|
||||
"tags": [
|
||||
"player"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/player/repeat/toggle": {
|
||||
"post": {
|
||||
"summary": "Toggle the repeat status, toggles between \"off\" , \"single\" and \"all\"",
|
||||
"tags": [
|
||||
"player"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/player/playpause": {
|
||||
"post": {
|
||||
"summary": "Toggle play/pause",
|
||||
"tags": [
|
||||
"player"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/settings/skipped-artists": {
|
||||
"get": {
|
||||
"summary": "get a list of artists that TIDAL Hi-Fi will skip if skipping is enabled",
|
||||
@ -105,10 +309,250 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/image": {
|
||||
"get": {
|
||||
"summary": "Get current image",
|
||||
"tags": [
|
||||
"legacy"
|
||||
],
|
||||
"deprecated": true,
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Current image",
|
||||
"content": {
|
||||
"image/png": {
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"format": "binary"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not found"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/play": {
|
||||
"get": {
|
||||
"summary": "Play action",
|
||||
"tags": [
|
||||
"legacy"
|
||||
],
|
||||
"deprecated": true,
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Action performed",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/favorite/toggle": {
|
||||
"get": {
|
||||
"summary": "Add the current song to your favorites, or remove it if its already added to your favorites",
|
||||
"tags": [
|
||||
"legacy"
|
||||
],
|
||||
"deprecated": true,
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/pause": {
|
||||
"get": {
|
||||
"summary": "Pause action",
|
||||
"tags": [
|
||||
"legacy"
|
||||
],
|
||||
"deprecated": true,
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/next": {
|
||||
"get": {
|
||||
"summary": "Play the next song",
|
||||
"tags": [
|
||||
"legacy"
|
||||
],
|
||||
"deprecated": true,
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/previous": {
|
||||
"get": {
|
||||
"summary": "Play the previous song",
|
||||
"tags": [
|
||||
"legacy"
|
||||
],
|
||||
"deprecated": true,
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/playpause": {
|
||||
"get": {
|
||||
"summary": "Toggle play/pause",
|
||||
"tags": [
|
||||
"legacy"
|
||||
],
|
||||
"deprecated": true,
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Ok",
|
||||
"content": {
|
||||
"text/plain": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OkResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"MediaInfo": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string"
|
||||
},
|
||||
"artists": {
|
||||
"type": "string"
|
||||
},
|
||||
"album": {
|
||||
"type": "string"
|
||||
},
|
||||
"icon": {
|
||||
"type": "string",
|
||||
"format": "uri"
|
||||
},
|
||||
"playingFrom": {
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"format": "uri"
|
||||
},
|
||||
"current": {
|
||||
"type": "string"
|
||||
},
|
||||
"currentInSeconds": {
|
||||
"type": "integer"
|
||||
},
|
||||
"duration": {
|
||||
"type": "string"
|
||||
},
|
||||
"durationInSeconds": {
|
||||
"type": "integer"
|
||||
},
|
||||
"image": {
|
||||
"type": "string",
|
||||
"format": "uri"
|
||||
},
|
||||
"favorite": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"player": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string"
|
||||
},
|
||||
"shuffle": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"repeat": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"artist": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"example": {
|
||||
"title": "Sample Title",
|
||||
"artists": "Sample Artist",
|
||||
"album": "Sample Album",
|
||||
"icon": "/path/to/sample/icon.jpg",
|
||||
"playingFrom": "Sample Playlist",
|
||||
"status": "playing",
|
||||
"url": "https://tidal.com/browse/track/sample",
|
||||
"current": "1:23",
|
||||
"currentInSeconds": 83,
|
||||
"duration": "3:45",
|
||||
"durationInSeconds": 225,
|
||||
"image": "https://example.com/sample-image.jpg",
|
||||
"favorite": true,
|
||||
"player": {
|
||||
"status": "playing",
|
||||
"shuffle": true,
|
||||
"repeat": "one"
|
||||
},
|
||||
"artist": "Sample Artist"
|
||||
}
|
||||
},
|
||||
"OkResponse": {
|
||||
"type": "string",
|
||||
"example": "OK"
|
||||
},
|
||||
"StringArray": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
@ -122,6 +566,14 @@
|
||||
}
|
||||
},
|
||||
"tags": [
|
||||
{
|
||||
"name": "current",
|
||||
"description": "The current media info API"
|
||||
},
|
||||
{
|
||||
"name": "player",
|
||||
"description": "The player control API"
|
||||
},
|
||||
{
|
||||
"name": "settings",
|
||||
"description": "The settings management API"
|
||||
|
||||
@ -147,7 +147,7 @@
|
||||
<p class="group__title">API</p>
|
||||
<div class="group__description">
|
||||
<p>
|
||||
TIDAL Hi-Fi has a built-in web API to allow users to get current song information.
|
||||
TIDAL Hi-Fi has a built-in web API to allow users to get current media information.
|
||||
You can optionally enable playback control as well.
|
||||
</p>
|
||||
</div>
|
||||
@ -246,7 +246,7 @@
|
||||
<div class="group__option" class="hidden">
|
||||
<div class="group__description">
|
||||
<h4>Show song</h4>
|
||||
<p>Show the current song in the Discord client</p>
|
||||
<p>Show the current media in the Discord client</p>
|
||||
</div>
|
||||
<label class="switch">
|
||||
<input id="discord_show_song" type="checkbox" />
|
||||
|
||||
@ -74,7 +74,7 @@ const elements = {
|
||||
},
|
||||
|
||||
/**
|
||||
* Get the icon of the current song
|
||||
* Get the icon of the current media
|
||||
*/
|
||||
getSongIcon: function () {
|
||||
const figure = this.get("media");
|
||||
@ -90,7 +90,7 @@ const elements = {
|
||||
},
|
||||
|
||||
/**
|
||||
* returns an array of all artists in the current song
|
||||
* returns an array of all artists in the current media
|
||||
* @returns {Array} artists
|
||||
*/
|
||||
getArtistsArray: function () {
|
||||
@ -195,7 +195,7 @@ function getUpdateFrequency() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Play or pause the current song
|
||||
* Play or pause the current media
|
||||
*/
|
||||
function playPause() {
|
||||
const play = elements.get("play");
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user