Newbie; How to Enable Playlist API

[Puuuur]

Hello,
I am new to using UMS and am struggling to get the "add to playlist" option working.
I have edited the conf file where I have set a 12 digit key but I do not understand the information on this page as to what exactly i do after that regarding Starting the service:

https://support.universalmediaserver.co ... ternal-api

Specifically the command I need to run:

Code: Select all

curl -w "%{http_code}\n" -H "api-key: secret_password" http://localhost:5001/api/folderscanner/rescan

I have NO IDEA what I am meant to put in for the "http code and if/where I set up and api folders as such or if that is automated.

Could someone kindly post Clear Step by Step guide including exactly what I put for any manual entries like what is required for the http code and api/folderscanner etc.

I am using Linux Mint latest distro

Much Thanks
Julie

[mik_s]

I don't know anything about the API but from what I remember it was for another program to interface with UMS so this may not be what you are after.
I found this about when the API was added and how it works if this is what you are after.
This is more info about the playlist API.

That knowledge base section is not really that clear but would make more sense to programmers.
I think after the documentation was moved from a previous system some of the html formatting tags got changed in to text and is now showing things like <span class="s1"> that is not part of the code.

I'll leave a comment on that PR to see if some of this documentation can be improved and made clearer.

If you are looking for using playlists in UMS this should work work fine by putting it in a shared folder but I am not sure about being able to edit them inside UMS as it is not something I use.

[mik_s]

Reply from one of the devs

The -w "%{http_code}\n" is the http code output of the curl command on the command line. Nothing has to be put in here. In case of 200 appears, everything works ok. In case of something else like 401 (authentication failure) something went wrong.

[Puuuur]

Hello mik_s,

Yes such a shame there is a HUGE lack of support with this software to help me through enabling the playlist function.
At this stage with the lack of support I will probably stick with the media server I have been using, the extra features this one has are very complicated for the average user to set up. I have even created a shared public folder and put a folder in that with a playlist .m3u in it and referenced to it in the .conf file but it is still greyed out on the website interface. So its not like I havent read and tried. Thanks for your response but Im guessing since on the install page there is an invite to patreon then they would get priority support being paid customers.

thanks
Julie

[mik_s]

Could you give more information on how you want to use this.
Are you trying to write a program for this or just want to use a playlist?

You should not have to reference any playlist in the confs, just copy your playlist to a shared folder and UMS should read it.

If this is not working I will need to see logs (see the red section above) and I should be able to see what is wrong.

I'll also do some testing on my computer on how to set up a playlist when I have time but I don't think it needs anything special.