WiiM

WiiM

integration

Play, group, and check your WiiM speakers room by room

Tier-1 integration with WiiM (LinkPlay) audio streamers and speakers. Lists the speakers on your network, reads what each one is playing, and runs playback: play a stream or station, play/pause, set volume, group speakers so they play in sync, drop a room from the group, and stop everything at once. Talks to your devices over the local WiiM HTTP API, so you provide the addresses of standalone speakers; each address also reveals any speakers already grouped with it. Built to be composed by a music agent, and chattable directly for quick "what's playing in the kitchen" or "turn it down" asks.

Source: WiiM

Tools (8)

List speakers

List every WiiM speaker on the user's network: name, multiroom role (host / member / standalone), volume, mute, and (by default) what each one is playing right now. This is the map of the system. Use it to answer 'what's playing on every speaker', to find the exact room name before acting, or to see which rooms are grouped together. Members of a group mirror their host, so they report the same track. Pass include_now_playing=false for a faster roster when you only need names and grouping.

Now playing

Report what one speaker is playing: state (playing / paused / stopped), title, artist, album, source (network, spotify, bluetooth, line-in, ...), volume, mute, and position. Pass the room name (e.g. 'Kitchen') or its IP. Omit speaker to read the hub. For the whole house at once, use list_speakers instead.

Play url

Play a direct audio stream URL on a speaker. This is how you start an internet radio station (e.g. Radio Paradise) or any direct stream or media file URL. Pass the full http(s) URL and the room name (or IP); omit speaker to play on the hub. If the speaker is the host of a group, the stream plays across the whole group in sync. This replaces whatever that speaker was playing.

Playback

Transport control for one speaker: play (resume), pause, toggle (pause/resume), stop, next, or previous. Use stop to turn off the music on a single speaker; to stop the whole house at once use stop_all. Pass the room name (or IP); omit speaker for the hub. On a group host this controls the whole group.

Set volume

Set or adjust a speaker's volume and/or mute. Pass level for an absolute volume (0-100), or change for a relative step (e.g. -10 to turn it down, +15 to turn it up). Pass mute=true/false to mute or unmute. Volume is per speaker, including individual members of a group. Pass the room name (or IP); omit speaker for the hub.

Group speakers

Sync one or more speakers to play together with a host speaker. The host keeps playing and each listed speaker joins it, so the same music plays in sync across all of them (whole-home or zone audio). Pass speakers as the rooms to add; host is the room whose music they should follow (defaults to the hub, or whichever room is already playing). To later drop one room use ungroup_speaker; to break the whole group use stop_all or ungroup each.

Ungroup speaker

Remove one speaker from its multiroom group so it stops playing the group's music while the other rooms keep going. This is how you take music out of a single room. Pass the room name (or IP). If you name the group's host, the whole group is split instead (the host can't be removed from its own group).

Stop all

Stop the music everywhere: split any multiroom group and stop playback on every speaker. Use this for 'turn off all the music' or 'stop everything'. To stop just one room, use playback with action=stop instead.

Chat with WiiM

Open chat