Current playback in a room

This query returns whether a Sonos room is playing right now, and what it's playing.

Developer info

API endpoint slug: sonos.current_playback
Runtime method: performQuery("sonos.current_playback"}

Query fields

Room Dropdown list

Label: Which room?
Helper text: Select a room. If the room is grouped with others, you'll get the group's playback.
Slug: room
Required: true
Can have default value: false

Ingredients

Playback state The room's playback state: playing, paused, idle, or buffering.

Slug: playback_state
Filter code: Sonos.currentPlayback.PlaybackState
Type: String
Example: playing

Is playing Either 'true' or 'false'. True while the room is playing or buffering.

Slug: is_playing
Filter code: Sonos.currentPlayback.IsPlaying
Type: String
Example: true

Track name The current track's name. Blank when nothing is loaded or the source has no track.

Slug: track_name
Filter code: Sonos.currentPlayback.TrackName
Type: String
Example: Here Comes the Sun

Artist name The current track's artist.

Slug: artist_name
Filter code: Sonos.currentPlayback.ArtistName
Type: String
Example: The Beatles

Album name The current track's album.

Slug: album_name
Filter code: Sonos.currentPlayback.AlbumName
Type: String
Example: Abbey Road

Source name What the room is playing from, such as a playlist, album, or radio station.

Slug: source_name
Filter code: Sonos.currentPlayback.SourceName
Type: String
Example: Morning Acoustic

Service name The music service the content comes from.

Slug: service_name
Filter code: Sonos.currentPlayback.ServiceName
Type: String
Example: Spotify

Room name The name of the room that was checked.

Slug: room_name
Filter code: Sonos.currentPlayback.RoomName
Type: String
Example: Living Room

Checked at When the playback was read.

Slug: checked_at
Filter code: Sonos.currentPlayback.CheckedAt
Type: Date with time (ISO8601)
Example: 2020-07-08T04:17:06+05:00