Add sorting support for theme media playback #5714
Conversation
ItsAllAboutTheCode
force-pushed
the
theme-media-shuffle
branch
2 times, most recently
from
050d57c to
cfa4480
Compare
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
src/apps/experimental/routes/user/display/hooks/useDisplaySettings.ts
Outdated
Show resolved
Hide resolved
src/apps/experimental/routes/user/display/hooks/useDisplaySettings.ts
Outdated
Show resolved
Hide resolved
ItsAllAboutTheCode
force-pushed
the
theme-media-shuffle
branch
from
cfa4480 to
a2aa5d6
Compare
|
To me it doesn't make sense to add an option for this, just making it random by default should be sufficient. |
The reason I added an option is that I noticed that when multiple audio files existing within a So the "SortName" option still allows users to control the order in which theme music and videos play via how they name their files within a "theme-music" or "backdrops" folder. I didn't set the option to default to "Random" in order to maintain the current behavior, however I wouldn't be averse to changing the default to be "Random" instead of "SortName" if it is OK to not maintain backwards compatibility? |
|
I kept the order selection options, but changed the default to be "Random". |
|
This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged. |
The `GetThemeMedia, `GetThemeVideos` and `GetThemeSongs` functions can optionally sort the results based based on passing an ItemSortBy type and a SortOrder. This is intended to be used by jellyfin-web in order to allow users to control the order of theme playback. See PR: jellyfin/jellyfin-web#5714
|
This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged. |
* Changed `GetThemeMedia` to support SortBy/Order options The `GetThemeMedia, `GetThemeVideos` and `GetThemeSongs` functions can optionally sort the results based based on passing an ItemSortBy type and a SortOrder. This is intended to be used by jellyfin-web in order to allow users to control the order of theme playback. See PR: jellyfin/jellyfin-web#5714 * Update MediaBrowser.Controller/Entities/BaseItem.cs Fix the `GetThemeVideos` two argument overload having both parameters defaulted. For the two argument overload, both parameters are required.
ItsAllAboutTheCode
changed the title
ItsAllAboutTheCode
changed the title
|
I have updated the PR to use the new GetThemeMedia Library api to perform the sorting and verified by locally generated the jellyfin SDK and testing the changes. When this repo is eventually updated to use the jellyfin SDK which contains the change from commit jellyfin/jellyfin@24f355a, then the sort options will work transparently. Until then the current behavior of not performing any sorting still occurs without error. |
|
I've merged the latest unstable version of the SDK via #5747. You should be able to update your branch now and use the API changes. |
Thanks for updating the API version. I'll wait until the next the API updates to test changes again. |
I just tested using the latest jellyffin SDK unstable version update from the yesterday and the changes are all working as intended. |
|
This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged. |
thornbill
added
discussion needed
|
This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged. |
|
I have opened up a discussion for this feature at #5958 |
ItsAllAboutTheCode
force-pushed
the
theme-media-shuffle
branch
3 times, most recently
from
a5c74b4 to
9a5563f
Compare
ItsAllAboutTheCode
force-pushed
the
theme-media-shuffle
branch
from
9a5563f to
77b1abf
Compare
Cloudflare Pages deployment
|
I have updated the PR to incorporate the changes to the UI provided by @erikbucik. |
ItsAllAboutTheCode
force-pushed
the
theme-media-shuffle
branch
from
77b1abf to
1819717
Compare
ItsAllAboutTheCode
force-pushed
the
theme-media-shuffle
branch
from
1819717 to
a9f06de
Compare
|
|
This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged. |
The ThemeMusicPlayer has been updated to support the "SortName" and "Random" Sort By options to allow sorting theme media for playback by either the sorted name or at random depending on the number of items. The "Ascending" and "Descending" Sort Order options were also added, which adds support to playback the theme media in reverse order of the sorted name. This is only supported for the "SortName" option Updated the Display settings for both the current and experimental display mode to add the "Theme media sort by" and "Theme media sort order" drop-down which allows users to modify the ThemeMusicPlayer sort options. The Display Settings are only shown if either the "Theme songs" or "Theme videos" checkboxes are checked. This is the implementation for the feature request located https://features.jellyfin.org/posts/2740/select-audio-from-the-theme-music-folder-at-random
Updated the themeMediaPlayer to use lodash `shuffle` function to randomly shuffle the Theme media array Changed the default theme mediasort by option to be "Random". Therefore theme music and theme videos from a folder will play in a random order.
The LibraryApi `getThemeMedia` is now forwarded the theme SortBy/SortOrder options to perform the sorting of theme media on the server. Updated the both the current display settings and experimental displaySettings to also allow sorting by Album, AlbumArtist, Artist, DateCreated, DatePlayed, PlayCount and Runtime. This is in addition to supporting Random and SortName(Track Name) sort fields. Verified changes locally by 1. generating latest openapi.json file based on commit jellyfin/jellyfin@24f355a 2. Using the [jellyfin-sdk-typescript](https://github.com/jellyfin/jellyfin-sdk-typescript) package to generate the new client api and build an updated jellyfin SDK 3. Using the `npm install --save <path-to-local-sdk>` command to use the local jellyfin SDK
The lodash shuffle import and jellyfin sdk ItemSortBy and SortOrder imports were left over from the original client side implementation.
…sion jellyfin#5958 The Theme Media and Backdrop settings has been moved to separate popover component in the experimental layout. For the classic layout the settings were moved to a separate "Background Playback" settings menu. Consolidated the widgets to select the Sort By/ Sort Order options for playing theme media to be one a single row with a \<select> (dropdown) widget providing the Sort by options followed by an \<IconButton> with arrow icons which indicates the Sort Order direction.
Also addressed other eslint changes such as changing single quotes to double quotes.
ItsAllAboutTheCode
force-pushed
the
theme-media-shuffle
branch
from
a9f06de to
5a38089
Compare
|
Changes
The ThemeMusicPlayer code has been updated to support the following SortBy options.
The Sort By options sorts theme media based on the selected option on the server.
Furthermore the Sort Order options were also added.
The Sort Order options support all Sort By options with the exception of "Random".
Ex. Sorting by Runtime + Descending
This will add the theme media to the play queue in order of longest runtime to shortest
Ex. Sorting by Album Artist + Ascending
This will add the theme media to the play queue in order in language order by Album Artist name
Ex. Sorting by Random
This will add the theme media to the play queue in random order
Updated the Display settings for both the current and experimental display mode to add a Background Playback Settings menu which groups the "Backdrop", "Theme Music" and "Theme Video" settings into one menu along with a Sort By dropdown and an arrow icon for selecting which category to sort theme media by and whether they should be sorted in ascending or descending order.
Issues
This is the implementation for the feature request located https://features.jellyfin.org/posts/2740/select-audio-from-the-theme-music-folder-at-random.
#5958
Preview
Legacy Background Playback Menu
BackgroundPlaybackMenu_v2.mp4
Experimental Background Playback Popover
ExperimentalBackgroundPlaybackMenu_v2.mp4