Updated theme media playback to play in Random order

[ItsAllAboutTheCode]

Changes

The ThemeMusicPlayer code has been updated to playback theme media using the Random sort order which causes theme media to be added to the play queue in a Random 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

[github-actions]

ESLint doesn't pass. Please fix all ESLint issues.

[nielsvanvelzen]

To me it doesn't make sense to add an option for this, just making it random by default should be sufficient.

[ItsAllAboutTheCode]

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 theme-music/* directory, it plays ALL the songs in sequential order.

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?

[dmitrylyzo]

My review in case you keep the order selection.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[ItsAllAboutTheCode]

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 theme-music/* directory, it plays ALL the songs in sequential order.

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".

[jellyfin-bot]

This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged.

[jellyfin-bot]

This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged.

[github-actions]

ESLint doesn't pass. Please fix all ESLint issues.

[ItsAllAboutTheCode]

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.

[nielsvanvelzen]

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.

[ItsAllAboutTheCode]

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.
Unfortunately it seems the jellyfin-sdk-typescript unstable was just updated before the LibraryController.cs changes were submitted, therefore it doesn't have the API changes.

I'll wait until the next the API updates to test changes again.

[ItsAllAboutTheCode]

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. Unfortunately it seems the jellyfin-sdk-typescript unstable was just updated before the LibraryController.cs changes were submitted, therefore it doesn't have the API changes.

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.
Thanks!

[jellyfin-bot]

This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged.

[mihawk90]

Ex. Sorting by Random

This will add the theme media to the play queue in random order

Just for clarification and documentation purposes:
As I'm reading this, this is actually a shuffle, not random, correct?
As in, shuffle takes the list of themes, randomises them, then puts them in the queue, but from that point on the order is set.
Randomised would mean that after each theme ends, a new one is randomly selected, which in theory could also lead to the same theme being played twice. It would also mean this allowed for "endless" playback (which right now is also not possible as far as I know, once the theme(s) played, the player stops and the fanart is shown).

[ItsAllAboutTheCode]

Ex. Sorting by Random

This will add the theme media to the play queue in random order

Just for clarification and documentation purposes: As I'm reading this, this is actually a shuffle, not random, correct? As in, shuffle takes the list of themes, randomises them, then puts them in the queue, but from that point on the order is set. Randomised would mean that after each theme ends, a new one is randomly selected, which in theory could also lead to the same theme being played twice. It would also mean this allowed for "endless" playback (which right now is also not possible as far as I know, once the theme(s) played, the player stops and the fanart is shown).

You are correct, this will take the list of themes and shuffle them before adding them to the play queue.
Once they are added to the play queue, their order is not changed.
So it is form of static randomization before the themes are added to the play queue and not a form of on-demand randomization where the next theme is chosen at random.

[thornbill]

To me it doesn't make sense to add an option for this, just making it random by default should be sufficient.

I agree with this. This is such a niche feature (really a niche of a niche of a niche as it requires people to have theme media, have multiple theme media, and care about the order they are played) that I find it hard to justify adding and maintaining 600 lines of code for it.

[ItsAllAboutTheCode]

To me it doesn't make sense to add an option for this, just making it random by default should be sufficient.

I agree with this. This is such a niche feature (really a niche of a niche of a niche as it requires people to have theme media, have multiple theme media, and care about the order they are played) that I find it hard to justify adding and maintaining 600 lines of code for it.

I can update this PR to change the default sort order to random and revert all of the UI and settings changes.

[github-actions]

ESLint doesn't pass. Please fix all ESLint issues.

[ItsAllAboutTheCode]

To me it doesn't make sense to add an option for this, just making it random by default should be sufficient.

I agree with this. This is such a niche feature (really a niche of a niche of a niche as it requires people to have theme media, have multiple theme media, and care about the order they are played) that I find it hard to justify adding and maintaining 600 lines of code for it.

I can update this PR to change the default sort order to random and revert all of the UI and settings changes.

I have updated the PR to set the theme media player to default to random playback.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[thornbill]

Could you update the PR title and description to reflect the update? Thanks!

[ItsAllAboutTheCode]

Could you update the PR title and description to reflect the update? Thanks!

Done.

Stale