SqueezeCenter Driver

The Squeezebox Server Driver interfaces with Logitech Squeezebox products such as the Duet, Transporter, Radio, and Touch. Each player is accessible through the driver as a zone.

Manufacturer: Logitech

Primary Communications Port: Network

Table of Contents [Hide/Show] Configuration Settings Events    Zone Name Changed    Zone Player Connected State Changed    Zone Mode Changed    Zone Playlist Name Changed    Zone Playlist Modification State Changed    Zone Shuffle State Changed    Zone Shuffle Modes Changed    Zone Repeat Mode Changed    Zone Current Track Genre Changed    Zone Current Track Album Changed    Zone Current Track Artist Changed    Zone Current Track Title Changed    Zone Is a Remote Stream State Changed    Zone Playlist Position Changed    Zone Playlist Length Changed    Power State Changed    Zone Volume Changed    Zone Mute State Changed    Zone Play Rate Changed    Ready State Changed    Status Update    Track Changed Instance Properties    ZoneNames    ZonePlayerConnected    Connected    ZoneCount    ZoneTransportModes    ZonePlaylistNames    ZonePlaylistModificationState    ZoneShuffleStates    ZoneShuffleModes    ZoneRepeatModes    ZoneCurrentTrackPositions    ZoneCurrentTrackGenres    ZoneCurrentTrackAlbums    ZoneCurrentTrackArtists    ZoneCurrentTrackTitles    ZoneCurrentTrackDurations    ZoneCurrentTrackIsRemoteStream    ZoneCurrentTrackPaths    ZonePlaylistPositions    ZonePlaylistLengths    ZonePowerStates    ZoneVolumes    ZoneMuteStates    ZonePlayRates    ZoneSignalStrengths    ZoneSleepCountDowns    ZoneCurrentTrackCoverArts    DeviceDisplayName    DeviceStartTime    DeviceLifecycleStage    DeviceIsRunningAndReady Instance Methods    PlayZone ( Number )    StopZone ( Number )    PauseZone ( Number )    UnpauseZone ( Number )    ToggleZonePause ( Number )    SetZoneTransportMode ( Number, String )    PlayZoneItem ( Number, String )    PlayZoneItems ( Number, Array )    PlayZoneItem ( Number, String, String, String )    AppendPlaylist ( Number, String, String, String )    InsertPlaylist ( Number, String, String, String )    RemoveFromPlaylist ( Number, String, String, String )    ClearZonePlaylist ( Number )    AppendZonePlaylistItem ( Number, String )    InsertZonePlaylistItem ( Number, String )    RemoveZonePlaylistItem ( Number, Number )    MoveZonePlaylistItem ( Number, Number, Number )    ShuffleCycle ( Number )    RepeatCycle ( Number )    SetZoneCurrentTrackPosition ( Number, TimeSpan )    OffsetZoneCurrentTrackPosition ( Number, Number )    OffsetZonePlaylistPosition ( Number, Number )    PlayNextZoneTrack ( Number )    PlayPreviousZoneTrack ( Number )    SetZoneVolume ( Number, Number )    OffsetZoneVolume ( Number, Number )    MuteZone ( Number )    UnmuteZone ( Number )    SetPropertyForDuration ( String, TimeSpan, Object, Object )    SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Configuration Settings

• Host Name : The host name or ip address of the Squeezebox Server.
• Port : (optional) The port to connect to. Defaults to 9090.
• Player IDs : (optional) A comma delimited list of unique player identifiers, usually (but not guaranteed to be) the MAC address of the players. This can be found using the Squeezebox Server web page, under Settings, then under the Players tab. The driver will auto-discover players even if they are not listed here, but the zone order will be random.
  

Events

Zone Name Changed

Occurs when a zone name changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Player Connected State Changed

Occurs when the connection state of a zone changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Mode Changed

Occurs when the player's mode changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Playlist Name Changed

Occurs when the name of the currently playing playlist changes on a zone.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Playlist Modification State Changed

Occurs when the modification state of the saved playlist last loaded into the Now Playing playlist changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Shuffle State Changed

Occurs when the shuffle state of the player changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Shuffle Modes Changed

Occurs when the shuffle mode of the player changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Repeat Mode Changed

Occurs when the repeat mode of the player changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Current Track Genre Changed

Occurs when the current track's album changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Current Track Album Changed

Occurs when the current track's album changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Current Track Artist Changed

Occurs when the current track's artist changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Current Track Title Changed

Occurs when the current track's title changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Is a Remote Stream State Changed

Occurs when the current songs changes to or from a remote stream.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Playlist Position Changed

Occurs when the index of the currently playing song changes on a zone.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Playlist Length Changed

Occurs when the total number of tracks in a zone's playlist changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Power State Changed

Occurs when the power state of player changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Volume Changed

Occurs when the current volume setting for the player changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Mute State Changed

Occurs when the current mute setting for the player changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Zone Play Rate Changed

Occurs when the current play rate for the player changes.

Whenever Filter:

• PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.
  

EventArgs:

• Number Index : The index within the property array.
• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Ready State Changed

The device's running and ready state changed.

Whenever Filter:


EventArgs:

• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Status Update

Occurs when the a status update is received, such as a new song, volume, etc.

Whenever Filter:

• ZoneID : (optional) The zone ID.
  

EventArgs:

• Number ZoneID : The zone ID.
  

Track Changed

Occurs when the currently playing song changes.

Whenever Filter:

• ZoneID : (optional) The zone ID.
  

EventArgs:

• String CurrentTitle : The title of the new track.
• Number ZoneID : The zone ID.
• Number PlaylistIndex : The playlist index of the new track.
  

Instance Properties

ZoneNames

Gets the name of all zones.

Accessibility : Read Only

Type: Array

ZonePlayerConnected

Gets the connection state of all zones, true or false depending on the state of the TCP connection to the player. SLIMP3 players, since they use UDP, always return true.

Accessibility : Read Only

Type: Array

Connected

Gets a value indicating if a connection is established with the Squeezebox Server.

Accessibility : Read Only

Type: Boolean

ZoneCount

Gets the number of zones supported by this media player driver.

Accessibility : Read Only

Type: Number

ZoneTransportModes

Gets or sets a zone's transport mode as 'play', 'stop' or 'pause'.

Accessibility : Read Only

Type: Array

ZonePlaylistNames

Gets the playlist name that is currently playing by zone.

Accessibility : Read Only

Type: Array

ZonePlaylistModificationState

Gets the modification state of the saved playlist last loaded into each zone, if any. If true, the playlist has been modified since it was loaded.

Accessibility : Read Only

Type: Array

ZoneShuffleStates

Gets or set the shuffle state of a zone playlist.

Accessibility : Read Only

Type: Array

ZoneShuffleModes

Gets or set the shuffle mode of a zone playlist. A value of '0' indicates that the playlist is not shuffled, '1' indicates that the playlist is shuffled by song, and '2' indicates that the playlist is shuffled by album.

Accessibility : Read Only

Type: Array

ZoneRepeatModes

Gets or sets the repeat mode which indicates if the player will stop playing at the end of the zone's playlist, repeat the current song indefinitely, or repeat the zone's playlist indefinitely. A value of '0' indicates that the player will stop at the end of the playlist, '1' indicates that the player will repeat the current song indefinitely and a value of '2' indicates that the player will repeat the entire playlist indefinitely.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackPositions

Gets or sets the current time position that the each zone's current song has been playing.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackGenres

Gets the current track's album property for all zones.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackAlbums

Gets the current track's album property for all zones.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackArtists

Gets the current track's artist property for all zones.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackTitles

Gets the current track's title property for all zones.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackDurations

Gets the duration of a zone's currently playing song.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackIsRemoteStream

Gets a value indicating if a zone's current song is a remote stream.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackPaths

Gets the path for the currently playing track for each zone.

Accessibility : Read Only

Type: Array

ZonePlaylistPositions

Gets or sets the playlist song position that is currently playing by index. When setting, a one-based value may be used to indicate which song to play.

Accessibility : Read Only

Type: Array

ZonePlaylistLengths

Gets the total number of tracks in each zone's playlist.

Accessibility : Read Only

Type: Array

ZonePowerStates

Gets or sets the power state (on/off) of each player zone.

Accessibility : Read Only

Type: Array

ZoneVolumes

Gets or sets the current volume setting for the player zones. The scale is 0 to 100.

Accessibility : Read Only

Type: Array

ZoneMuteStates

Gets or sets a value indicating if a zone's volume setting for the player is muted.

Accessibility : Read Only

Type: Array

ZonePlayRates

Gets or sets the current play rate for the player zones. 1 is normal, 2 is 2x fast forward, 0 is paused, -1 is rewind, etc.

Accessibility : Read Only

Type: Array

ZoneSignalStrengths

Gets the wireless signal strength for the player, range is 1 to 100. Returns 0 if not connected wirelessly.

Accessibility : Read Only

Type: Array

ZoneSleepCountDowns

Gets or sets the amount of time to continue playing before powering off a player zone.

Accessibility : Read Only

Type: Array

ZoneCurrentTrackCoverArts

Gets the cover art for the each zone's current track.

Accessibility : Read Only

Type: Array

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

PlayZone ( Number )

Starts playing the a zone's playlist.

Syntax


Parameters

StopZone ( Number )

Stops playing the a zone's playlist.

Syntax


Parameters

PauseZone ( Number )

Pauses the playing of a zone's playlist.

Syntax


Parameters

UnpauseZone ( Number )

Unpauses the playing of a zone's playlist.

Syntax


Parameters

ToggleZonePause ( Number )

Toggles the pause state of a zone's playlist.

Syntax


Parameters

SetZoneTransportMode ( Number, String )

Set's a zone's transport mode as 'play', 'stop' or 'pause'.

Syntax


Parameters

PlayZoneItem ( Number, String )

Adds the specified song URL, playlist or directory contents into a zone's playlist and plays starting at the first item. Any songs previously in the playlist are discarded.

Syntax


Parameters

PlayZoneItems ( Number, Array )

Adds the specified song URLs, playlists or directory contents into a zone's playlist and plays starting at the first item. Any songs previously in the playlist are discarded.

Syntax


Parameters

PlayZoneItem ( Number, String, String, String )

Puts songs matching the specified genre artist and album criteria on the playlist. Songs previously in the playlist are discarded.

Syntax


Parameters

AppendPlaylist ( Number, String, String, String )

Appends all songs matching the specified criteria onto the end of the playlist. Songs currently playing or already on the playlist are not affected.

Syntax


Parameters

InsertPlaylist ( Number, String, String, String )

Inserts all songs matching the specified criteria at the top of the playlist. Songs already on the playlist are not affected.

Syntax


Parameters

RemoveFromPlaylist ( Number, String, String, String )

Removes songs matching the specified genre artist and album criteria from the playlist.

Syntax


Parameters

ClearZonePlaylist ( Number )

Clears a zone's playlist and stops the player.

Syntax


Parameters

AppendZonePlaylistItem ( Number, String )

Adds the specified song URL, playlist or directory contents to the end of a zone's playlist.

Syntax


Parameters

InsertZonePlaylistItem ( Number, String )

Inserts the specified song URL, playlist or directory contents to be played immediately after the current song in a zone's playlist.

Syntax


Parameters

RemoveZonePlaylistItem ( Number, Number )

Removes the song at the specified index from a zone's playlist.

Syntax


Parameters

MoveZonePlaylistItem ( Number, Number, Number )

Moves the song at the specified index to a new index in a zone's playlist.

Syntax


Parameters

ShuffleCycle ( Number )

Cycles to the next the shuffling state in a zone.

Syntax


Parameters

RepeatCycle ( Number )

Cycles to the next repeat state in a zone.

Syntax


Parameters

SetZoneCurrentTrackPosition ( Number, TimeSpan )

Set's a zone's track position.

Syntax


Parameters

OffsetZoneCurrentTrackPosition ( Number, Number )

Jump to a relative position within a zone's currently playing track based on the current position by specifying the number of seconds to jump.

Syntax


Parameters

OffsetZonePlaylistPosition ( Number, Number )

Offsets the a zone's currently playing track by the specified number of tracks. -1 to play the previous track, 1 to play the next track.

Syntax


Parameters

PlayNextZoneTrack ( Number )

Plays the next track in a zone's playlist.

Syntax


Parameters

PlayPreviousZoneTrack ( Number )

Plays the previous track in a zone's playlist.

Syntax


Parameters

SetZoneVolume ( Number, Number )

Change the Volume for a Zone.

Syntax


Parameters

OffsetZoneVolume ( Number, Number )

Offsets the current volume setting for the player. Positive numbers increase the volume by the specified number and negative numbers decrease the volume. The full volume scale is 0 to 100.

Syntax


Parameters

MuteZone ( Number )

Turn the mute on for a zone.

Syntax


Parameters

UnmuteZone ( Number )

Turn the mute off for a zone.

Syntax


Parameters

SetPropertyForDuration ( String, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax


Parameters

SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax


Parameters