How to get playing status using API?

[HemTark 1]

I want to get the status whether the server is playing any media using the API. Is there any API endpoint which can be helpful in this scenario?

[Luke 40136]

Hi, yes I'd take a look at the /sessions API.

[HemTark 1]

In /Sessions API, I can see only three GET requests which are to get all sessions, auth providers and auth keys respectively. Others are DELETE and POST requests.

[Luke 40136]

Yes try that first one.

[HemTark 1]

 I checked the /Sessions API and found that when a media is playing/paused we get field named "NowPlayingItem" with details of the media being played. I can use this field to check whether a media is being played or not.

Thank you @Luke for help.

[Luke 40136]

Actually newer versions of the server have an IsPlaying param that you can attach. So IsPlaying=true

[HemTark 1]

How can I attach IsPlaying field? This field is not mentioned in the swagger documentation of /Sessions API.

Edited November 4, 2022 by HemTark

[Luke 40136]

IsPlaying=true. We'll get it added to swagger.

[Cheesegeezer 3102]

@HemTark Depending on what you're using (language wise)

@chef did a poster app that you can look at the JS and HTML that will let you see the process connecting, authenticating, creating a session and getting playback

hope it helps

 

[bruor 37]

On 11/4/2022 at 1:10 AM, Luke said:

Actually newer versions of the server have an IsPlaying param that you can attach. So IsPlaying=true

So glad I stumbled across this hidden param! 

 

[displayname0504 1]

Sorry to revive this old thread.  I see the NowPlayingItem, but I don't see "IsPlaying".

Is this still on the roadmap? And would it be possible to filter? In Swagger, the only options listed to filter are "DeviceId" or "ControllableByUserId"

[Luke 40136]

7 hours ago, displayname0504 said:

Sorry to revive this old thread.  I see the NowPlayingItem, but I don't see "IsPlaying".

Is this still on the roadmap? And would it be possible to filter? In Swagger, the only options listed to filter are "DeviceId" or "ControllableByUserId"

Hi, IsPlaying is a filter on the api endpoint, not a property on the output. It sounds like you have what you need.