Skip to content
Draft
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
1 change: 1 addition & 0 deletions content/en/docs/Endpoints/getartist.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Returns details for an artist, including a list of albums. This method organizes
| Parameter | Req. | OpenS. | Default | Comment |
| --- | --- | --- | --- | --- |
| `id` | **Yes** | | | The artist ID. |
| `musicFolderId` | No | **Yes** | | Only include albums within the given top-level music folder |

### Example

Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/Endpoints/getbookmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ Returns all bookmarks for this user. A bookmark is a position within a certain m

### 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** | | Only include bookmarks within the given top-level music folder |

### Example

Expand Down
5 changes: 4 additions & 1 deletion content/en/docs/Endpoints/getgenres.md
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
6 changes: 5 additions & 1 deletion content/en/docs/Endpoints/getshares.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ Returns information about shared media this user is allowed to manage. Takes no

### 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** | | Only include shares within the given top-level music folder |

### Example

Expand Down
1 change: 1 addition & 0 deletions content/en/docs/Endpoints/getsimilarsongs2.md
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
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
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), [`getTopSongs`](../../endpoints/gettopsongs), [`getArtist`](../../endpoints/getartist), [`getShares`](../../endpoints/getshares), and [`getBookmarks`](../../endpoints/getbookmarks). 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.