Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion content/en/docs/Endpoints/getalbum.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "getAlbum"
linkTitle: "getAlbum"
linkTitle: "getAlbum [OS]"
categories:
- Browsing
description: >
Expand Down Expand Up @@ -47,6 +47,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"created": "2021-07-22T02:09:31+00:00",
"duration": 4248,
"playCount": 0,
"totalPlayCount": 0,
"userPlayCount": 0,
"artistId": "100000036",
"artist": "Comfort Fit",
"year": 2005,
Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/Endpoints/getalbumlist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "getAlbumList"
linkTitle: "getAlbumList"
linkTitle: "getAlbumList [OS]"
categories:
- Lists
description: >
Expand Down Expand Up @@ -55,6 +55,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"created": "2021-07-22T02:09:31+00:00",
"duration": 4248,
"playCount": 0,
"totalPlayCount": 0,
"userPlayCount": 0,
"artistId": "100000036",
"artist": "Comfort Fit",
"year": 2005,
Expand All @@ -72,6 +74,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"created": "2021-02-24T01:44:21+00:00",
"duration": 1879,
"playCount": 0,
"totalPlayCount": 0,
"userPlayCount": 0,
"artistId": "100000019",
"artist": "Various Artists",
"year": 2012,
Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/Endpoints/getalbumlist2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "getAlbumList2"
linkTitle: "getAlbumList2"
linkTitle: "getAlbumList2 [OS]"
categories:
- Lists
description: >
Expand Down Expand Up @@ -53,6 +53,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"created": "2021-07-22T02:09:31+00:00",
"duration": 4248,
"playCount": 0,
"totalPlayCount": 0,
"userPlayCount": 0,
"artistId": "100000036",
"artist": "Comfort Fit",
"year": 2005,
Expand All @@ -68,6 +70,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"created": "2021-02-24T01:44:21+00:00",
"duration": 1879,
"playCount": 0,
"totalPlayCount": 0,
"userPlayCount": 0,
"artistId": "100000019",
"artist": "Various Artists",
"year": 2012,
Expand Down
4 changes: 3 additions & 1 deletion content/en/docs/Endpoints/getartist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "getArtist"
linkTitle: "getArtist"
linkTitle: "getArtist [OS]"
categories:
- Browsing
description: >
Expand Down Expand Up @@ -63,6 +63,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"created": "2021-02-23T04:24:48+00:00",
"duration": 4568,
"playCount": 1,
"totalPlayCount": 1,
"userPlayCount": 0,
"artistId": "100000002",
"artist": "Synthetic",
"year": 2007,
Expand Down
4 changes: 3 additions & 1 deletion content/en/docs/Endpoints/getbookmarks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "getBookmarks"
linkTitle: "getBookmarks"
linkTitle: "getBookmarks [OS]"
categories:
- Bookmarks
description: >
Expand Down Expand Up @@ -90,6 +90,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"channelCount": 2,
"path": "The Polish Ambassador/First Words/17 - Ill with the Skills.mp3",
"playCount": 1,
"totalPlayCount": 1,
"userPlayCount": 0,
"played": "2023-03-15T15:23:37Z",
"created": "2023-03-25T11:44:51Z",
"albumId": "dc8d8889a6fe08d8da7698c7ee1de61c",
Expand Down
4 changes: 3 additions & 1 deletion content/en/docs/Endpoints/getsong.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "getSong"
linkTitle: "getSong"
linkTitle: "getSong [OS]"
categories:
- Browsing
description: >
Expand Down Expand Up @@ -56,6 +56,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"channelCount": 2,
"path": "The New Deal/Live at The Casbah - 2005-04-29/04 - \"polar expedition\".flac",
"playCount": 8,
"totalPlayCount": 8,
"userPlayCount": 1,
"played": "2023-03-26T22:27:46Z",
"discNumber": 1,
"created": "2023-03-14T17:51:22.112827504Z",
Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/Endpoints/getstarred.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "getStarred"
linkTitle: "getStarred"
linkTitle: "getStarred [OS]"
categories:
- Lists
description: >
Expand Down Expand Up @@ -57,6 +57,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"created": "2021-07-22T02:09:31+00:00",
"duration": 4248,
"playCount": 0,
"totalPlayCount": 0,
"userPlayCount": 0,
"artistId": "100000036",
"artist": "Comfort Fit",
"year": 2005,
Expand Down Expand Up @@ -85,6 +87,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"channelCount": 2,
"path": "The New Deal/Live at The Casbah - 2005-04-29/04 - \"polar expedition\".flac",
"playCount": 8,
"totalPlayCount": 8,
"userPlayCount": 1,
"discNumber": 1,
"created": "2023-03-14T17:51:22.112827504Z",
"albumId": "e8a0685e3f3ec6f251649af2b58b8617",
Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/Endpoints/getstarred2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "getStarred2"
linkTitle: "getStarred2"
linkTitle: "getStarred2 [OS]"
categories:
- Lists
description: >
Expand Down Expand Up @@ -57,6 +57,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"starred": "2023-03-22T01:51:06Z",
"duration": 1954,
"playCount": 97,
"totalPlayCount": 97,
"userPlayCount": 10,
"genre": "Hip-Hop",
"created": "2023-03-10T02:19:35.784818075Z",
"artistId": "91c3901ac465b9efc439e4be4270c2b6",
Expand Down Expand Up @@ -85,6 +87,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"channelCount": 2,
"path": "The New Deal/Live at The Casbah - 2005-04-29/04 - \"polar expedition\".flac",
"playCount": 8,
"totalPlayCount": 8,
"userPlayCount": 1,
"discNumber": 1,
"created": "2023-03-14T17:51:22.112827504Z",
"albumId": "e8a0685e3f3ec6f251649af2b58b8617",
Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/Endpoints/search2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "search2"
linkTitle: "search2"
linkTitle: "search2 [OS]"
categories:
- Searching
description: >
Expand Down Expand Up @@ -65,6 +65,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"created": "2021-07-22T02:09:31+00:00",
"duration": 4248,
"playCount": 0,
"totalPlayCount": 0,
"userPlayCount": 0,
"artistId": "100000036",
"artist": "Comfort Fit",
"year": 2005,
Expand Down Expand Up @@ -93,6 +95,8 @@ A [`subsonic-response`](../../responses/subsonic-response) element with a nested
"channelCount": 2,
"path": "The New Deal/Live at The Casbah - 2005-04-29/04 - \"polar expedition\".flac",
"playCount": 8,
"totalPlayCount": 8,
"userPlayCount": 1,
"discNumber": 1,
"created": "2023-03-14T17:51:22.112827504Z",
"albumId": "e8a0685e3f3ec6f251649af2b58b8617",
Expand Down
4 changes: 4 additions & 0 deletions content/en/docs/Endpoints/search3.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ A [`subsonic-response`](../../responses/subsonic-response) with a nested [`searc
"starred": "2023-03-22T01:51:06Z",
"duration": 1954,
"playCount": 97,
"totalPlayCount": 97,
"userPlayCount": 10,
"played": "2023-03-28T00:45:13Z",
"created": "2023-03-10T02:19:35.784818075Z",
"artistId": "91c3901ac465b9efc439e4be4270c2b6",
Expand Down Expand Up @@ -100,6 +102,8 @@ A [`subsonic-response`](../../responses/subsonic-response) with a nested [`searc
"channelCount": 2,
"path": "The New Deal/Live at The Casbah - 2005-04-29/04 - \"polar expedition\".flac",
"playCount": 8,
"totalPlayCount": 8,
"userPlayCount": 1,
"played": "2023-03-26T22:27:46Z",
"discNumber": 1,
"created": "2023-03-14T17:51:22.112827504Z",
Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/Responses/AlbumID3.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ description: >
"starred": "2023-03-22T01:51:06Z",
"duration": 1954,
"playCount": 97,
"totalPlayCount": 97,
"userPlayCount": 10,
"genre": "Hip-Hop",
"created": "2023-03-10T02:19:35.784818075Z",
"artistId": "91c3901ac465b9efc439e4be4270c2b6",
Expand Down Expand Up @@ -112,7 +114,9 @@ description: >
| `coverArt` | `string` | No | | A covertArt id. |
| `songCount` | `int` | **Yes** | | Number of songs |
| `duration` | `int` | **Yes** | | Total duration of the album in seconds |
| `playCount` | `long` | No | | Number of play of the album |
| `playCount` | `long` | No | | Number of plays of the album (Deprecated in OS) |
| `totalPlayCount` | `long` | No | **Yes** | Number of plays of the album for all users |
| `userPlayCount` | `long` | No | **Yes** | Number of plays of the album for your user |
| `created` | `string` | **Yes** | | Date the album was added. [ISO 8601]|
| `starred` | `string` | No | | Date the album was starred. [ISO 8601]|
| `year` | `int` | No | | The album year|
Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/Responses/AlbumID3WithSongs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ description: >
"starred": "2023-03-22T01:51:06Z",
"duration": 1954,
"playCount": 97,
"totalPlayCount": 97,
"userPlayCount": 10,
"genre": "Hip-Hop",
"created": "2023-03-10T02:19:35.784818075Z",
"artistId": "91c3901ac465b9efc439e4be4270c2b6",
Expand Down Expand Up @@ -225,7 +227,9 @@ description: >
| `coverArt` | `string` | No | | A covertArt id. |
| `songCount` | `int` | **Yes** | | Number of songs |
| `duration` | `int` | **Yes** | | Total duration of the album in seconds |
| `playCount` | `long` | No | | Number of play of the album |
| `playCount` | `long` | No | | Number of plays of the album (Deprecated in OS) |
| `totalPlayCount` | `long` | No | **Yes** | Number of plays of the album for all users |
| `userPlayCount` | `long` | No | **Yes** | Number of plays of the album for your user |
| `created` | `string` | **Yes** | | Date the album was added. [ISO 8601]|
| `starred` | `string` | No | | Date the album was starred. [ISO 8601]|
| `year` | `int` | No | | The album year|
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/Responses/ArtistWithAlbumsID3.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ description: >
"created": "2021-02-23T04:24:48+00:00",
"duration": 4568,
"playCount": 1,
"totalPlayCount": 1,
"userPlayCount": 0,
"artistId": "100000002",
"artist": "Synthetic",
"year": 2007,
Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/Responses/Child.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ description: >
"channelCount": 2,
"path": "The New Deal/Live at The Casbah - 2005-04-29/04 - \"polar expedition\".flac",
"playCount": 8,
"totalPlayCount": 8,
"userPlayCount": 1,
"played": "2023-03-26T22:27:46Z",
"discNumber": 1,
"created": "2023-03-14T17:51:22.112827504Z",
Expand Down Expand Up @@ -177,7 +179,9 @@ description: >
| `isVideo` | `boolean` | No | | Media is a video |
| `userRating` | `int` | No | | The user rating of the media [1-5] |
| `averageRating` | `number` | No | | The average rating of the media [1.0-5.0] |
| `playCount` | `long` | No | | The play count. |
| `playCount` | `long` | No | | Item play count (Deprecated in OS) |
| `totalPlayCount` | `long` | No | **Yes** | Item play count for all users |
| `userPlayCount` | `long` | No | **Yes** | Item play count for your user |
| `discNumber` | `int` | No | | The disc number. |
| `created` | `string` | No | | Date the media was created. [ISO 8601] |
| `starred` | `string` | No | | Date the media was starred. [ISO 8601] |
Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/Responses/albumList.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "albumList"
linkTitle: "albumList"
linkTitle: "albumList [OS]"
description: >
Album list.
---
Expand All @@ -21,6 +21,8 @@ description: >
"created": "2021-07-22T02:09:31+00:00",
"duration": 4248,
"playCount": 0,
"totalPlayCount": 0,
"userPlayCount": 0,
"artistId": "100000036",
"artist": "Comfort Fit",
"year": 2005,
Expand All @@ -37,6 +39,8 @@ description: >
"created": "2021-02-24T01:44:21+00:00",
"duration": 1879,
"playCount": 0,
"totalPlayCount": 0,
"userPlayCount": 0,
"artistId": "100000019",
"artist": "Various Artists",
"year": 2012,
Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/Responses/albumList2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "albumList2"
linkTitle: "albumList2"
linkTitle: "albumList2 [OS]"
description: >
Album list.
---
Expand All @@ -20,6 +20,8 @@ description: >
"created": "2021-07-22T02:09:31+00:00",
"duration": 4248,
"playCount": 0,
"totalPlayCount": 0,
"userPlayCount": 0,
"artistId": "100000036",
"artist": "Comfort Fit",
"year": 2005,
Expand All @@ -35,6 +37,8 @@ description: >
"created": "2021-02-24T01:44:21+00:00",
"duration": 1879,
"playCount": 0,
"totalPlayCount": 0,
"userPlayCount": 0,
"artistId": "100000019",
"artist": "Various Artists",
"year": 2012,
Expand Down
4 changes: 3 additions & 1 deletion content/en/docs/Responses/bookmarks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "bookmarks"
linkTitle: "bookmarks"
linkTitle: "bookmarks [OS]"
description: >
Bookmarks list.
---
Expand Down Expand Up @@ -65,6 +65,8 @@ description: >
"channelCount": 2,
"path": "The Polish Ambassador/First Words/17 - Ill with the Skills.mp3",
"playCount": 1,
"totalPlayCount": 1,
"userPlayCount": 0,
"played": "2023-03-15T15:23:37Z",
"created": "2023-03-25T11:44:51Z",
"albumId": "dc8d8889a6fe08d8da7698c7ee1de61c",
Expand Down
4 changes: 3 additions & 1 deletion content/en/docs/Responses/directory.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,7 @@ description: >
| `starred` | `string` | No | | Starred date [ISO 8601] |
| `userRating` | `int` | No | | The user rating [1-5] |
| `averageRating` | `number` | No | | The average rating [1.0-5.0] |
| `playCount` | `long` | No | | The play count |
| `playCount` | `long` | No | | Item play count (Deprecated in OS) |
| `totalPlayCount` | `long` | No | **Yes** | Item play count for all users |
| `userPlayCount` | `long` | No | **Yes** | Item play count for your user |
| `child` | Array of [`Child`](../child) | No | | The directory content |
6 changes: 5 additions & 1 deletion content/en/docs/Responses/searchResult2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "searchResult2"
linkTitle: "searchResult2"
linkTitle: "searchResult2 [OS]"
description: >
searchResult2.
---
Expand Down Expand Up @@ -30,6 +30,8 @@ description: >
"created": "2021-07-22T02:09:31+00:00",
"duration": 4248,
"playCount": 0,
"totalPlayCount": 0,
"userPlayCount": 0,
"artistId": "100000036",
"artist": "Comfort Fit",
"year": 2005,
Expand Down Expand Up @@ -58,6 +60,8 @@ description: >
"channelCount": 2,
"path": "The New Deal/Live at The Casbah - 2005-04-29/04 - \"polar expedition\".flac",
"playCount": 8,
"totalPlayCount": 8,
"userPlayCount": 1,
"discNumber": 1,
"created": "2023-03-14T17:51:22.112827504Z",
"albumId": "e8a0685e3f3ec6f251649af2b58b8617",
Expand Down
Loading