Skip to content

Music Folder extension to extend musicFolderID support to more endpoints #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
dweymouth wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Music Folder extension to extend musicFolderID support to more endpoints #162

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f222b47
Music Folder extension MD docs update
dweymouth Jun 27, 2025
61f03b4
add suggested additional endpoints
dweymouth Jul 13, 2025
374109a
fix musicfolder.md
dweymouth Jul 13, 2025
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
5 changes: 4 additions & 1 deletion content/en/docs/Endpoints/getgenres.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ Returns all genres.

### Parameters

Takes no extra parameters.
Takes no extra parameters, unless the server supports the [Music Folder](../../extensions/musicfolder) extension, in which case the following parameter is supported.

| Parameter | Req. | OpenS. | Default | Comment |
| `musicFolderId` | No| **Yes** | | Include only genres for which at least one song in the specified music folder is tagged with that genre. Servers **should** calculate and return `songCount` and `albumCount` relative to the specified music folder only. |

### Example

Expand Down
1 change: 1 addition & 0 deletions content/en/docs/Endpoints/getsimilarsongs2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Similar to [`getSimilarSongs`](../getsimilarsongs), but organizes music accordin
| --- | --- | --- | --- | --- |
| `id` | **Yes** | | | The artist ID. |
| `count` | No | |50 | Max number of songs to return. |
| `musicFolderId` | No | **Yes** | | Include only songs from the music folder with the given ID. The [`Music Folder`](../../extensions/musicfolder) extension marks support for this parameter. |

### Example

Expand Down
1 change: 1 addition & 0 deletions content/en/docs/Endpoints/gettopsongs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Returns top songs for the given artist, using data from [last.fm](http://last.fm
| --- | --- | --- | --- | --- |
| `artist` | **Yes** | | | The artist name. |
| `count` | No | | 50 | Max number of songs to return. |
| `musicFolderId` | No | **Yes** | | Include only songs from the music folder with the given ID. The [`Music Folder`](../../extensions/musicfolder) extension marks support for this parameter. |

### Example

Expand Down
18 changes: 18 additions & 0 deletions content/en/docs/Extensions/musicFolder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: "Music Folder
linkTitle: "Music Folder"
OpenSubsonic:
- Extension
description: >
Adds support for the `musicFolderId` parameter on more browsing APIs.
---

**OpenSubsonic version**: [1](../../opensubsonic-versions)

**OpenSubsonic extension name** `musicFolder` (As returned by [`getOpenSubsonicExtensions`](../../endpoints/getopensubsonicextensions))

When a server supports this extension, it supports the `musicFolderId` parameter on additional endpoints.

## Version 1

This version requires servers to support the `musicFolderId` parameter on calls to the following endpoints: [`getGenres`](../../endpoints/getgenres), [`getSimilarSongs2`](../../endpoints/getsimilarsongs2), and [`getTopSongs`](../../endpoints/gettopsongs). When supplied by the client, these calls must only return songs contained within the specified music folder, and only genres for which at least one song is tagged with that genre in the specified music folder.