Skip to content

Instantly share code, notes, and snippets.

@pwt
Created October 21, 2019 08:38
Show Gist options
  • Save pwt/68125e8c5661b6a2554e47e5443359f2 to your computer and use it in GitHub Desktop.
Save pwt/68125e8c5661b6a2554e47e5443359f2 to your computer and use it in GitHub Desktop.
Output of SoCo/dev_tools/sonosdump.py run against a Sonos 10.4 system
Querying Kitchen
===============================================================================
| AlarmClock |
===============================================================================
SetFormat
~~~~~~~~~
Input
DesiredTimeFormat: string
DesiredDateFormat: string
Output
GetFormat
~~~~~~~~~
Input
Output
CurrentTimeFormat: string
CurrentDateFormat: string
SetTimeZone
~~~~~~~~~~~
Input
Index: i4
AutoAdjustDst: boolean
Output
GetTimeZone
~~~~~~~~~~~
Input
Output
Index: i4
AutoAdjustDst: boolean
GetTimeZoneAndRule
~~~~~~~~~~~~~~~~~~
Input
Output
Index: i4
AutoAdjustDst: boolean
CurrentTimeZone: string
GetTimeZoneRule
~~~~~~~~~~~~~~~
Input
Index: i4
Output
TimeZone: string
SetTimeServer
~~~~~~~~~~~~~
Input
DesiredTimeServer: string
Output
GetTimeServer
~~~~~~~~~~~~~
Input
Output
CurrentTimeServer: string
SetTimeNow
~~~~~~~~~~
Input
DesiredTime: string
TimeZoneForDesiredTime: string
Output
GetHouseholdTimeAtStamp
~~~~~~~~~~~~~~~~~~~~~~~
Input
TimeStamp: string
Output
HouseholdUTCTime: string
GetTimeNow
~~~~~~~~~~
Input
Output
CurrentUTCTime: string
CurrentLocalTime: string
CurrentTimeZone: string
CurrentTimeGeneration: ui4
CreateAlarm
~~~~~~~~~~~
Input
StartLocalTime: string
Duration: string
Recurrence: [ONCE, WEEKDAYS, WEEKENDS, DAILY]
Enabled: boolean
RoomUUID: string
ProgramURI: string
ProgramMetaData: string
PlayMode=NORMAL: [NORMAL, REPEAT_ALL, SHUFFLE_NOREPEAT, SHUFFLE]
Volume: ui2
IncludeLinkedZones: boolean
Output
AssignedID: ui4
UpdateAlarm
~~~~~~~~~~~
Input
ID: ui4
StartLocalTime: string
Duration: string
Recurrence: [ONCE, WEEKDAYS, WEEKENDS, DAILY]
Enabled: boolean
RoomUUID: string
ProgramURI: string
ProgramMetaData: string
PlayMode=NORMAL: [NORMAL, REPEAT_ALL, SHUFFLE_NOREPEAT, SHUFFLE]
Volume: ui2
IncludeLinkedZones: boolean
Output
DestroyAlarm
~~~~~~~~~~~~
Input
ID: ui4
Output
ListAlarms
~~~~~~~~~~
Input
Output
CurrentAlarmList: string
CurrentAlarmListVersion: string
SetDailyIndexRefreshTime
~~~~~~~~~~~~~~~~~~~~~~~~
Input
DesiredDailyIndexRefreshTime: string
Output
GetDailyIndexRefreshTime
~~~~~~~~~~~~~~~~~~~~~~~~
Input
Output
CurrentDailyIndexRefreshTime: string
===============================================================================
| MusicServices |
===============================================================================
GetSessionId
~~~~~~~~~~~~
Input
ServiceId: ui4
Username: string
Output
SessionId: string
ListAvailableServices
~~~~~~~~~~~~~~~~~~~~~
Input
Output
AvailableServiceDescriptorList: string
AvailableServiceTypeList: string
AvailableServiceListVersion: string
===============================================================================
| DeviceProperties |
===============================================================================
SetLEDState
~~~~~~~~~~~
Input
DesiredLEDState: [On, Off]
Output
GetLEDState
~~~~~~~~~~~
Input
Output
CurrentLEDState: [On, Off]
AddBondedZones
~~~~~~~~~~~~~~
Input
ChannelMapSet: string
Output
RemoveBondedZones
~~~~~~~~~~~~~~~~~
Input
ChannelMapSet: string
KeepGrouped: boolean
Output
CreateStereoPair
~~~~~~~~~~~~~~~~
Input
ChannelMapSet: string
Output
SeparateStereoPair
~~~~~~~~~~~~~~~~~~
Input
ChannelMapSet: string
Output
SetZoneAttributes
~~~~~~~~~~~~~~~~~
Input
DesiredZoneName: string
DesiredIcon: string
DesiredConfiguration: string
Output
GetZoneAttributes
~~~~~~~~~~~~~~~~~
Input
Output
CurrentZoneName: string
CurrentIcon: string
CurrentConfiguration: string
GetHouseholdID
~~~~~~~~~~~~~~
Input
Output
CurrentHouseholdID: string
GetZoneInfo
~~~~~~~~~~~
Input
Output
SerialNumber: string
SoftwareVersion: string
DisplaySoftwareVersion: string
HardwareVersion: string
IPAddress: string
MACAddress: string
CopyrightInfo: string
ExtraInfo: string
HTAudioIn: ui4
Flags: ui4
SetAutoplayLinkedZones
~~~~~~~~~~~~~~~~~~~~~~
Input
IncludeLinkedZones: boolean
Source: string
Output
GetAutoplayLinkedZones
~~~~~~~~~~~~~~~~~~~~~~
Input
Source: string
Output
IncludeLinkedZones: boolean
SetAutoplayRoomUUID
~~~~~~~~~~~~~~~~~~~
Input
RoomUUID: string
Source: string
Output
GetAutoplayRoomUUID
~~~~~~~~~~~~~~~~~~~
Input
Source: string
Output
RoomUUID: string
SetAutoplayVolume
~~~~~~~~~~~~~~~~~
Input
Volume: [0..100]
Source: string
Output
GetAutoplayVolume
~~~~~~~~~~~~~~~~~
Input
Source: string
Output
CurrentVolume: [0..100]
SetUseAutoplayVolume
~~~~~~~~~~~~~~~~~~~~
Input
UseVolume: boolean
Source: string
Output
GetUseAutoplayVolume
~~~~~~~~~~~~~~~~~~~~
Input
Source: string
Output
UseVolume: boolean
AddHTSatellite
~~~~~~~~~~~~~~
Input
HTSatChanMapSet: string
Output
RemoveHTSatellite
~~~~~~~~~~~~~~~~~
Input
SatRoomUUID: string
Output
EnterConfigMode
~~~~~~~~~~~~~~~
Input
Mode: string
Options: string
Output
State: string
ExitConfigMode
~~~~~~~~~~~~~~
Input
Options: string
Output
GetButtonState
~~~~~~~~~~~~~~
Input
Output
State: string
SetButtonLockState
~~~~~~~~~~~~~~~~~~
Input
DesiredButtonLockState: [On, Off]
Output
GetButtonLockState
~~~~~~~~~~~~~~~~~~
Input
Output
CurrentButtonLockState: [On, Off]
===============================================================================
| SystemProperties |
===============================================================================
SetString
~~~~~~~~~
Input
VariableName: string
StringValue: string
Output
GetString
~~~~~~~~~
Input
VariableName: string
Output
StringValue: string
Remove
~~~~~~
Input
VariableName: string
Output
GetWebCode
~~~~~~~~~~
Input
AccountType: ui4
Output
WebCode: string
ProvisionCredentialedTrialAccountX
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Input
AccountType: ui4
AccountID: string
AccountPassword: string
Output
IsExpired: boolean
AccountUDN: string
AddAccountX
~~~~~~~~~~~
Input
AccountType: ui4
AccountID: string
AccountPassword: string
Output
AccountUDN: string
AddOAuthAccountX
~~~~~~~~~~~~~~~~
Input
AccountType: ui4
AccountToken: string
AccountKey: string
OAuthDeviceID: string
AuthorizationCode: string
RedirectURI: string
UserIdHashCode: string
AccountTier: ui4
Output
AccountUDN: string
AccountNickname: string
RemoveAccount
~~~~~~~~~~~~~
Input
AccountType: ui4
AccountID: string
Output
EditAccountPasswordX
~~~~~~~~~~~~~~~~~~~~
Input
AccountType: ui4
AccountID: string
NewAccountPassword: string
Output
SetAccountNicknameX
~~~~~~~~~~~~~~~~~~~
Input
AccountUDN: string
AccountNickname: string
Output
RefreshAccountCredentialsX
~~~~~~~~~~~~~~~~~~~~~~~~~~
Input
AccountType: ui4
AccountUID: ui4
AccountToken: string
AccountKey: string
Output
EditAccountMd
~~~~~~~~~~~~~
Input
AccountType: ui4
AccountID: string
NewAccountMd: string
Output
EnableRDM
~~~~~~~~~
Input
RDMValue: boolean
Output
GetRDM
~~~~~~
Input
Output
RDMValue: boolean
ReplaceAccountX
~~~~~~~~~~~~~~~
Input
AccountUDN: string
NewAccountID: string
NewAccountPassword: string
AccountToken: string
AccountKey: string
OAuthDeviceID: string
Output
NewAccountUDN: string
===============================================================================
| ZoneGroupTopology |
===============================================================================
CheckForUpdate
~~~~~~~~~~~~~~
Input
UpdateType: [All, Software]
CachedOnly: boolean
Version: string
Output
UpdateItem: string
BeginSoftwareUpdate
~~~~~~~~~~~~~~~~~~~
Input
UpdateURL: string
Flags: ui4
ExtraOptions: string
Output
ReportUnresponsiveDevice
~~~~~~~~~~~~~~~~~~~~~~~~
Input
DeviceUUID: string
DesiredAction: [Remove, TopologyMonitorProbe, VerifyThenRemoveSystemwide]
Output
SubmitDiagnostics
~~~~~~~~~~~~~~~~~
Input
IncludeControllers: boolean
Type: string
Output
DiagnosticID: ui4
RegisterMobileDevice
~~~~~~~~~~~~~~~~~~~~
Input
MobileDeviceName: string
MobileDeviceUDN: string
MobileIPAndPort: string
Output
GetZoneGroupAttributes
~~~~~~~~~~~~~~~~~~~~~~
Input
Output
CurrentZoneGroupName: string
CurrentZoneGroupID: string
CurrentZonePlayerUUIDsInGroup: string
CurrentMuseHouseholdId: string
GetZoneGroupState
~~~~~~~~~~~~~~~~~
Input
Output
ZoneGroupState: string
===============================================================================
| GroupManagement |
===============================================================================
AddMember
~~~~~~~~~
Input
MemberID: string
BootSeq: ui4
Output
CurrentTransportSettings: string
CurrentURI: string
GroupUUIDJoined: string
ResetVolumeAfter: boolean
VolumeAVTransportURI: string
RemoveMember
~~~~~~~~~~~~
Input
MemberID: string
Output
ReportTrackBufferingResult
~~~~~~~~~~~~~~~~~~~~~~~~~~
Input
MemberID: string
ResultCode: i4
Output
SetSourceAreaIds
~~~~~~~~~~~~~~~~
Input
DesiredSourceAreaIds: string
Output
===============================================================================
| QPlay |
===============================================================================
QPlayAuth
~~~~~~~~~
Input
Seed: string
Output
Code: string
MID: string
DID: string
===============================================================================
| ContentDirectory |
===============================================================================
GetSearchCapabilities
~~~~~~~~~~~~~~~~~~~~~
Input
Output
SearchCaps: string
GetSortCapabilities
~~~~~~~~~~~~~~~~~~~
Input
Output
SortCaps: string
GetSystemUpdateID
~~~~~~~~~~~~~~~~~
Input
Output
Id: ui4
GetAlbumArtistDisplayOption
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Input
Output
AlbumArtistDisplayOption: string
GetLastIndexChange
~~~~~~~~~~~~~~~~~~
Input
Output
LastIndexChange: string
Browse
~~~~~~
Input
ObjectID: string
BrowseFlag: [BrowseMetadata, BrowseDirectChildren]
Filter: string
StartingIndex: ui4
RequestedCount: ui4
SortCriteria: string
Output
Result: string
NumberReturned: ui4
TotalMatches: ui4
UpdateID: ui4
FindPrefix
~~~~~~~~~~
Input
ObjectID: string
Prefix: string
Output
StartingIndex: ui4
UpdateID: ui4
GetAllPrefixLocations
~~~~~~~~~~~~~~~~~~~~~
Input
ObjectID: string
Output
TotalPrefixes: ui4
PrefixAndIndexCSV: string
UpdateID: ui4
CreateObject
~~~~~~~~~~~~
Input
ContainerID: string
Elements: string
Output
ObjectID: string
Result: string
UpdateObject
~~~~~~~~~~~~
Input
ObjectID: string
CurrentTagValue: string
NewTagValue: string
Output
DestroyObject
~~~~~~~~~~~~~
Input
ObjectID: string
Output
RefreshShareIndex
~~~~~~~~~~~~~~~~~
Input
AlbumArtistDisplayOption: string
Output
RequestResort
~~~~~~~~~~~~~
Input
SortOrder: string
Output
GetShareIndexInProgress
~~~~~~~~~~~~~~~~~~~~~~~
Input
Output
IsIndexing: boolean
GetBrowseable
~~~~~~~~~~~~~
Input
Output
IsBrowseable: boolean
SetBrowseable
~~~~~~~~~~~~~
Input
Browseable: boolean
Output
===============================================================================
| ConnectionManager |
===============================================================================
===============================================================================
| RenderingControl |
===============================================================================
GetMute
~~~~~~~
Input
InstanceID: ui4
Channel: [Master, LF, RF, SpeakerOnly]
Output
CurrentMute: boolean
SetMute
~~~~~~~
Input
InstanceID: ui4
Channel: [Master, LF, RF, SpeakerOnly]
DesiredMute: boolean
Output
ResetBasicEQ
~~~~~~~~~~~~
Input
InstanceID: ui4
Output
Bass: [-10..10]
Treble: [-10..10]
Loudness: boolean
LeftVolume: [0..100]
RightVolume: [0..100]
ResetExtEQ
~~~~~~~~~~
Input
InstanceID: ui4
EQType: string
Output
GetVolume
~~~~~~~~~
Input
InstanceID: ui4
Channel: [Master, LF, RF]
Output
CurrentVolume: [0..100]
SetVolume
~~~~~~~~~
Input
InstanceID: ui4
Channel: [Master, LF, RF]
DesiredVolume: [0..100]
Output
SetRelativeVolume
~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Channel: [Master, LF, RF]
Adjustment: i4
Output
NewVolume: [0..100]
GetVolumeDB
~~~~~~~~~~~
Input
InstanceID: ui4
Channel: [Master, LF, RF]
Output
CurrentVolume: i2
SetVolumeDB
~~~~~~~~~~~
Input
InstanceID: ui4
Channel: [Master, LF, RF]
DesiredVolume: i2
Output
GetVolumeDBRange
~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Channel: [Master, LF, RF]
Output
MinValue: i2
MaxValue: i2
GetBass
~~~~~~~
Input
InstanceID: ui4
Output
CurrentBass: [-10..10]
SetBass
~~~~~~~
Input
InstanceID: ui4
DesiredBass: [-10..10]
Output
GetTreble
~~~~~~~~~
Input
InstanceID: ui4
Output
CurrentTreble: [-10..10]
SetTreble
~~~~~~~~~
Input
InstanceID: ui4
DesiredTreble: [-10..10]
Output
GetEQ
~~~~~
Input
InstanceID: ui4
EQType: string
Output
CurrentValue: i2
SetEQ
~~~~~
Input
InstanceID: ui4
EQType: string
DesiredValue: i2
Output
GetLoudness
~~~~~~~~~~~
Input
InstanceID: ui4
Channel: [Master, LF, RF]
Output
CurrentLoudness: boolean
SetLoudness
~~~~~~~~~~~
Input
InstanceID: ui4
Channel: [Master, LF, RF]
DesiredLoudness: boolean
Output
GetSupportsOutputFixed
~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
CurrentSupportsFixed: boolean
GetOutputFixed
~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
CurrentFixed: boolean
SetOutputFixed
~~~~~~~~~~~~~~
Input
InstanceID: ui4
DesiredFixed: boolean
Output
GetHeadphoneConnected
~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
CurrentHeadphoneConnected: boolean
RampToVolume
~~~~~~~~~~~~
Input
InstanceID: ui4
Channel: [Master, LF, RF]
RampType: [SLEEP_TIMER_RAMP_TYPE, ALARM_RAMP_TYPE, AUTOPLAY_RAMP_TYPE]
DesiredVolume: [0..100]
ResetVolumeAfter: boolean
ProgramURI: string
Output
RampTime: ui4
RestoreVolumePriorToRamp
~~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Channel: [Master, LF, RF]
Output
SetChannelMap
~~~~~~~~~~~~~
Input
InstanceID: ui4
ChannelMap: string
Output
SetRoomCalibrationX
~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
CalibrationID: string
Coefficients: string
CalibrationMode: string
Output
GetRoomCalibrationStatus
~~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
RoomCalibrationEnabled: boolean
RoomCalibrationAvailable: boolean
SetRoomCalibrationStatus
~~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
RoomCalibrationEnabled: boolean
Output
===============================================================================
| ConnectionManager |
===============================================================================
===============================================================================
| AVTransport |
===============================================================================
SetAVTransportURI
~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
CurrentURI: string
CurrentURIMetaData: string
Output
SetNextAVTransportURI
~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
NextURI: string
NextURIMetaData: string
Output
AddURIToQueue
~~~~~~~~~~~~~
Input
InstanceID: ui4
EnqueuedURI: string
EnqueuedURIMetaData: string
DesiredFirstTrackNumberEnqueued: ui4
EnqueueAsNext: boolean
Output
FirstTrackNumberEnqueued: ui4
NumTracksAdded: ui4
NewQueueLength: ui4
AddMultipleURIsToQueue
~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
UpdateID: ui4
NumberOfURIs: ui4
EnqueuedURIs: string
EnqueuedURIsMetaData: string
ContainerURI: string
ContainerMetaData: string
DesiredFirstTrackNumberEnqueued: ui4
EnqueueAsNext: boolean
Output
FirstTrackNumberEnqueued: ui4
NumTracksAdded: ui4
NewQueueLength: ui4
NewUpdateID: ui4
ReorderTracksInQueue
~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
StartingIndex: ui4
NumberOfTracks: ui4
InsertBefore: ui4
UpdateID: ui4
Output
RemoveTrackFromQueue
~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
ObjectID: string
UpdateID: ui4
Output
RemoveTrackRangeFromQueue
~~~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
UpdateID: ui4
StartingIndex: ui4
NumberOfTracks: ui4
Output
NewUpdateID: ui4
RemoveAllTracksFromQueue
~~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
SaveQueue
~~~~~~~~~
Input
InstanceID: ui4
Title: string
ObjectID: string
Output
AssignedObjectID: string
BackupQueue
~~~~~~~~~~~
Input
InstanceID: ui4
Output
CreateSavedQueue
~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Title: string
EnqueuedURI: string
EnqueuedURIMetaData: string
Output
NumTracksAdded: ui4
NewQueueLength: ui4
AssignedObjectID: string
NewUpdateID: ui4
AddURIToSavedQueue
~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
ObjectID: string
UpdateID: ui4
EnqueuedURI: string
EnqueuedURIMetaData: string
AddAtIndex: ui4
Output
NumTracksAdded: ui4
NewQueueLength: ui4
NewUpdateID: ui4
ReorderTracksInSavedQueue
~~~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
ObjectID: string
UpdateID: ui4
TrackList: string
NewPositionList: string
Output
QueueLengthChange: i4
NewQueueLength: ui4
NewUpdateID: ui4
GetMediaInfo
~~~~~~~~~~~~
Input
InstanceID: ui4
Output
NrTracks: [0..65535]
MediaDuration: string
CurrentURI: string
CurrentURIMetaData: string
NextURI: string
NextURIMetaData: string
PlayMedium: [NONE, NETWORK]
RecordMedium: [NONE]
WriteStatus: string
GetTransportInfo
~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
CurrentTransportState: [STOPPED, PLAYING, PAUSED_PLAYBACK, TRANSITIONING]
CurrentTransportStatus: string
CurrentSpeed: [1]
GetPositionInfo
~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
Track: [0..65535]
TrackDuration: string
TrackMetaData: string
TrackURI: string
RelTime: string
AbsTime: string
RelCount: i4
AbsCount: i4
GetDeviceCapabilities
~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
PlayMedia: string
RecMedia: string
RecQualityModes: string
GetTransportSettings
~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
PlayMode=NORMAL: [NORMAL, REPEAT_ALL, REPEAT_ONE, SHUFFLE_NOREPEAT, SHUFFLE, SHUFFLE_REPEAT_ONE]
RecQualityMode: string
GetCrossfadeMode
~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
CrossfadeMode: boolean
Stop
~~~~
Input
InstanceID: ui4
Output
Play
~~~~
Input
InstanceID: ui4
Speed: [1]
Output
Pause
~~~~~
Input
InstanceID: ui4
Output
Seek
~~~~
Input
InstanceID: ui4
Unit: [TRACK_NR, REL_TIME, TIME_DELTA]
Target: string
Output
Next
~~~~
Input
InstanceID: ui4
Output
Previous
~~~~~~~~
Input
InstanceID: ui4
Output
SetPlayMode
~~~~~~~~~~~
Input
InstanceID: ui4
NewPlayMode=NORMAL: [NORMAL, REPEAT_ALL, REPEAT_ONE, SHUFFLE_NOREPEAT, SHUFFLE, SHUFFLE_REPEAT_ONE]
Output
SetCrossfadeMode
~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
CrossfadeMode: boolean
Output
NotifyDeletedURI
~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
DeletedURI: string
Output
GetCurrentTransportActions
~~~~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
Actions: string
BecomeCoordinatorOfStandaloneGroup
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
DelegatedGroupCoordinatorID: string
NewGroupID: string
DelegateGroupCoordinationTo
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
NewCoordinator: string
RejoinGroup: boolean
Output
BecomeGroupCoordinator
~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
CurrentCoordinator: string
CurrentGroupID: string
OtherMembers: string
TransportSettings: string
CurrentURI: string
CurrentURIMetaData: string
SleepTimerState: string
AlarmState: string
StreamRestartState: string
CurrentQueueTrackList: string
CurrentVLIState: string
Output
BecomeGroupCoordinatorAndSource
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
CurrentCoordinator: string
CurrentGroupID: string
OtherMembers: string
CurrentURI: string
CurrentURIMetaData: string
SleepTimerState: string
AlarmState: string
StreamRestartState: string
CurrentAVTTrackList: string
CurrentQueueTrackList: string
CurrentSourceState: string
ResumePlayback: boolean
Output
ChangeCoordinator
~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
CurrentCoordinator: string
NewCoordinator: string
NewTransportSettings: string
CurrentAVTransportURI: string
Output
ChangeTransportSettings
~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
NewTransportSettings: string
CurrentAVTransportURI: string
Output
ConfigureSleepTimer
~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
NewSleepTimerDuration: string
Output
GetRemainingSleepTimerDuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
RemainingSleepTimerDuration: string
CurrentSleepTimerGeneration: ui4
RunAlarm
~~~~~~~~
Input
InstanceID: ui4
AlarmID: ui4
LoggedStartTime: string
Duration: string
ProgramURI: string
ProgramMetaData: string
PlayMode=NORMAL: [NORMAL, REPEAT_ALL, REPEAT_ONE, SHUFFLE_NOREPEAT, SHUFFLE, SHUFFLE_REPEAT_ONE]
Volume: ui2
IncludeLinkedZones: boolean
Output
StartAutoplay
~~~~~~~~~~~~~
Input
InstanceID: ui4
ProgramURI: string
ProgramMetaData: string
Volume: ui2
IncludeLinkedZones: boolean
ResetVolumeAfter: boolean
Output
GetRunningAlarmProperties
~~~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
AlarmID: ui4
GroupID: string
LoggedStartTime: string
SnoozeAlarm
~~~~~~~~~~~
Input
InstanceID: ui4
Duration: string
Output
EndDirectControlSession
~~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
===============================================================================
| Queue |
===============================================================================
AddURI
~~~~~~
Input
QueueID: ui4
UpdateID: ui4
EnqueuedURI: string
EnqueuedURIMetaData: string
DesiredFirstTrackNumberEnqueued: ui4
EnqueueAsNext: boolean
Output
FirstTrackNumberEnqueued: ui4
NumTracksAdded: ui4
NewQueueLength: ui4
NewUpdateID: ui4
AddMultipleURIs
~~~~~~~~~~~~~~~
Input
QueueID: ui4
UpdateID: ui4
ContainerURI: string
ContainerMetaData: string
DesiredFirstTrackNumberEnqueued: ui4
EnqueueAsNext: boolean
NumberOfURIs: ui4
EnqueuedURIsAndMetaData: string
Output
FirstTrackNumberEnqueued: ui4
NumTracksAdded: ui4
NewQueueLength: ui4
NewUpdateID: ui4
AttachQueue
~~~~~~~~~~~
Input
QueueOwnerID: string
Output
QueueID: ui4
QueueOwnerContext: string
Backup
~~~~~~
Input
Output
Browse
~~~~~~
Input
QueueID: ui4
StartingIndex: ui4
RequestedCount: ui4
Output
Result: string
NumberReturned: ui4
TotalMatches: ui4
UpdateID: ui4
CreateQueue
~~~~~~~~~~~
Input
QueueOwnerID: string
QueueOwnerContext: string
QueuePolicy: string
Output
QueueID: ui4
RemoveAllTracks
~~~~~~~~~~~~~~~
Input
QueueID: ui4
UpdateID: ui4
Output
NewUpdateID: ui4
RemoveTrackRange
~~~~~~~~~~~~~~~~
Input
QueueID: ui4
UpdateID: ui4
StartingIndex: ui4
NumberOfTracks: ui4
Output
NewUpdateID: ui4
ReorderTracks
~~~~~~~~~~~~~
Input
QueueID: ui4
StartingIndex: ui4
NumberOfTracks: ui4
InsertBefore: ui4
UpdateID: ui4
Output
NewUpdateID: ui4
ReplaceAllTracks
~~~~~~~~~~~~~~~~
Input
QueueID: ui4
UpdateID: ui4
ContainerURI: string
ContainerMetaData: string
CurrentTrackIndex: ui4
NewCurrentTrackIndices: string
NumberOfURIs: ui4
EnqueuedURIsAndMetaData: string
Output
NewQueueLength: ui4
NewUpdateID: ui4
SaveAsSonosPlaylist
~~~~~~~~~~~~~~~~~~~
Input
QueueID: ui4
Title: string
ObjectID: string
Output
AssignedObjectID: string
===============================================================================
| GroupRenderingControl |
===============================================================================
GetGroupMute
~~~~~~~~~~~~
Input
InstanceID: ui4
Output
CurrentMute: boolean
SetGroupMute
~~~~~~~~~~~~
Input
InstanceID: ui4
DesiredMute: boolean
Output
GetGroupVolume
~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
CurrentVolume: [0..100]
SetGroupVolume
~~~~~~~~~~~~~~
Input
InstanceID: ui4
DesiredVolume: [0..100]
Output
SetRelativeGroupVolume
~~~~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Adjustment: i4
Output
NewVolume: [0..100]
SnapshotGroupVolume
~~~~~~~~~~~~~~~~~~~
Input
InstanceID: ui4
Output
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment