AVTransport service

Service that controls stuff related to transport (play/pause/next/special URLs)

The AVTransport service is available on these models: v2-S1 / v2-S13 / v2-S14 / v2-S18 / v2-S21 / v2-S27 / v2-S3 / v2-S33 / v2-S38 / v2-S6 / v2-S9 / v2-Sub.

const SonosDevice = require('@svrooij/sonos').SonosDevice
const sonos = new SonosDevice('192.168.x.x')
sonos.AVTransportService.OneOfTheMethodsBelow({...})

All actions that require input expect an object with the specified parameters, even if it only requires one parameter.

1. AddMultipleURIsToQueue
2. AddURIToQueue
3. AddURIToSavedQueue
4. BackupQueue
5. BecomeCoordinatorOfStandaloneGroup
6. BecomeGroupCoordinator
7. BecomeGroupCoordinatorAndSource
8. ChangeCoordinator
9. ChangeTransportSettings
10. ConfigureSleepTimer
11. CreateSavedQueue
12. DelegateGroupCoordinationTo
13. EndDirectControlSession
14. GetCrossfadeMode
15. GetCurrentTransportActions
16. GetDeviceCapabilities
17. GetMediaInfo
18. GetPositionInfo
19. GetRemainingSleepTimerDuration
20. GetRunningAlarmProperties
21. GetTransportInfo
22. GetTransportSettings
23. Next
24. NotifyDeletedURI
25. Pause
26. Play
27. Previous
28. RemoveAllTracksFromQueue
29. RemoveTrackFromQueue
30. RemoveTrackRangeFromQueue
31. ReorderTracksInQueue
32. ReorderTracksInSavedQueue
33. RunAlarm
34. SaveQueue
35. Seek
36. SetAVTransportURI
37. SetCrossfadeMode
38. SetNextAVTransportURI
39. SetPlayMode
40. SnoozeAlarm
41. StartAutoplay
42. Stop
43. AVTransportService event

AddMultipleURIsToQueue

const result = await sonos.AVTransportService.AddMultipleURIsToQueue({ InstanceID:..., UpdateID:..., NumberOfURIs:..., EnqueuedURIs:..., EnqueuedURIsMetaData:..., ContainerURI:..., ContainerMetaData:..., DesiredFirstTrackNumberEnqueued:..., EnqueueAsNext:... });

Input object:

Output object:

AddURIToQueue

Adds songs to the SONOS queue

const result = await sonos.AVTransportService.AddURIToQueue({ InstanceID:..., EnqueuedURI:..., EnqueuedURIMetaData:..., DesiredFirstTrackNumberEnqueued:..., EnqueueAsNext:... });

Input object:

Output object:

Remarks In NORMAL play mode the songs are added prior to the specified DesiredFirstTrackNumberEnqueued.

AddURIToSavedQueue

const result = await sonos.AVTransportService.AddURIToSavedQueue({ InstanceID:..., ObjectID:..., UpdateID:..., EnqueuedURI:..., EnqueuedURIMetaData:..., AddAtIndex:... });

Input object:

Output object:

BackupQueue

const result = await sonos.AVTransportService.BackupQueue({ InstanceID:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

BecomeCoordinatorOfStandaloneGroup

Leave the current group and revert to a single player.

const result = await sonos.AVTransportService.BecomeCoordinatorOfStandaloneGroup({ InstanceID:... });

Input object:

Output object:

BecomeGroupCoordinator

const result = await sonos.AVTransportService.BecomeGroupCoordinator({ InstanceID:..., CurrentCoordinator:..., CurrentGroupID:..., OtherMembers:..., TransportSettings:..., CurrentURI:..., CurrentURIMetaData:..., SleepTimerState:..., AlarmState:..., StreamRestartState:..., CurrentQueueTrackList:..., CurrentVLIState:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

BecomeGroupCoordinatorAndSource

const result = await sonos.AVTransportService.BecomeGroupCoordinatorAndSource({ InstanceID:..., CurrentCoordinator:..., CurrentGroupID:..., OtherMembers:..., CurrentURI:..., CurrentURIMetaData:..., SleepTimerState:..., AlarmState:..., StreamRestartState:..., CurrentAVTTrackList:..., CurrentQueueTrackList:..., CurrentSourceState:..., ResumePlayback:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

ChangeCoordinator

const result = await sonos.AVTransportService.ChangeCoordinator({ InstanceID:..., CurrentCoordinator:..., NewCoordinator:..., NewTransportSettings:..., CurrentAVTransportURI:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

ChangeTransportSettings

const result = await sonos.AVTransportService.ChangeTransportSettings({ InstanceID:..., NewTransportSettings:..., CurrentAVTransportURI:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

ConfigureSleepTimer

Stop playing after set sleep timer or cancel

const result = await sonos.AVTransportService.ConfigureSleepTimer({ InstanceID:..., NewSleepTimerDuration:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Remarks Send to non-coordinator returns error code 800

CreateSavedQueue

const result = await sonos.AVTransportService.CreateSavedQueue({ InstanceID:..., Title:..., EnqueuedURI:..., EnqueuedURIMetaData:... });

Input object:

Output object:

DelegateGroupCoordinationTo

Delegates the coordinator role to another player in the same group

const result = await sonos.AVTransportService.DelegateGroupCoordinationTo({ InstanceID:..., NewCoordinator:..., RejoinGroup:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Remarks Send to non-coordinator has no results - should be avoided.

EndDirectControlSession

const result = await sonos.AVTransportService.EndDirectControlSession({ InstanceID:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

GetCrossfadeMode

Get crossfade mode

const result = await sonos.AVTransportService.GetCrossfadeMode({ InstanceID:... });

Input object:

Output object:

Remarks Send to non-coordinator may return wrong value as only the coordinator value in a group

GetCurrentTransportActions

Get current transport actions such as Set, Stop, Pause, Play, X_DLNA_SeekTime, Next, X_DLNA_SeekTrackNr

const result = await sonos.AVTransportService.GetCurrentTransportActions({ InstanceID:... });

Input object:

Output object:

Remarks Send to non-coordinator returns only Start and Stop since it cannot control the stream.

GetDeviceCapabilities

const result = await sonos.AVTransportService.GetDeviceCapabilities({ InstanceID:... });

Input object:

Output object:

GetMediaInfo

Get information about the current playing media (queue)

const result = await sonos.AVTransportService.GetMediaInfo({ InstanceID:... });

Input object:

Output object:

GetPositionInfo

Get information about current position (position in queue and time in current song)

const result = await sonos.AVTransportService.GetPositionInfo({ InstanceID:... });

Input object:

Output object:

GetRemainingSleepTimerDuration

Get time left on sleeptimer.

const result = await sonos.AVTransportService.GetRemainingSleepTimerDuration({ InstanceID:... });

Input object:

Output object:

Remarks Send to non-coordinator returns error code 800

GetRunningAlarmProperties

const result = await sonos.AVTransportService.GetRunningAlarmProperties({ InstanceID:... });

Input object:

Output object:

GetTransportInfo

Get current transport status, speed and state such as PLAYING, STOPPED, PLAYING, PAUSED_PLAYBACK, TRANSITIONING, NO_MEDIA_PRESENT

const result = await sonos.AVTransportService.GetTransportInfo({ InstanceID:... });

Input object:

Output object:

Remarks Send to non-coordinator always returns PLAYING

GetTransportSettings

Get transport settings

const result = await sonos.AVTransportService.GetTransportSettings({ InstanceID:... });

Input object:

Output object:

Remarks Send to non-coordinator returns the settings of it’s queue

Next

Go to next song

const result = await sonos.AVTransportService.Next({ InstanceID:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Remarks Possibly not supported at the moment see GetCurrentTransportActions

NotifyDeletedURI

const result = await sonos.AVTransportService.NotifyDeletedURI({ InstanceID:..., DeletedURI:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Pause

Pause playback

const result = await sonos.AVTransportService.Pause({ InstanceID:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Play

Start playing the set TransportURI

const result = await sonos.AVTransportService.Play({ InstanceID:..., Speed:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Previous

Go to previous song

const result = await sonos.AVTransportService.Previous({ InstanceID:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Remarks Possibly not supported at the moment see GetCurrentTransportActions

RemoveAllTracksFromQueue

Flushes the SONOS queue.

const result = await sonos.AVTransportService.RemoveAllTracksFromQueue({ InstanceID:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Remarks If queue is already empty it throw error 804. Send to non-coordinator returns error code 800.

RemoveTrackFromQueue

const result = await sonos.AVTransportService.RemoveTrackFromQueue({ InstanceID:..., ObjectID:..., UpdateID:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

RemoveTrackRangeFromQueue

Removes the specified range of songs from the SONOS queue.

const result = await sonos.AVTransportService.RemoveTrackRangeFromQueue({ InstanceID:..., UpdateID:..., StartingIndex:..., NumberOfTracks:... });

Input object:

Output object:

ReorderTracksInQueue

const result = await sonos.AVTransportService.ReorderTracksInQueue({ InstanceID:..., StartingIndex:..., NumberOfTracks:..., InsertBefore:..., UpdateID:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

ReorderTracksInSavedQueue

const result = await sonos.AVTransportService.ReorderTracksInSavedQueue({ InstanceID:..., ObjectID:..., UpdateID:..., TrackList:..., NewPositionList:... });

Input object:

Output object:

RunAlarm

const result = await sonos.AVTransportService.RunAlarm({ InstanceID:..., AlarmID:..., LoggedStartTime:..., Duration:..., ProgramURI:..., ProgramMetaData:..., PlayMode:..., Volume:..., IncludeLinkedZones:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

SaveQueue

Saves the current SONOS queue as a SONOS playlist and outputs objectID

const result = await sonos.AVTransportService.SaveQueue({ InstanceID:..., Title:..., ObjectID:... });

Input object:

Output object:

Remarks Send to non-coordinator returns error code 800

Seek

Seek track in queue, time delta or absolute time in song

const result = await sonos.AVTransportService.Seek({ InstanceID:..., Unit:..., Target:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Remarks Returns error code 701 in case that content does not support Seek or send to non-coordinator

SetAVTransportURI

Set the transport URI to a song, a stream, the queue, another player-rincon and a lot more

const result = await sonos.AVTransportService.SetAVTransportURI({ InstanceID:..., CurrentURI:..., CurrentURIMetaData:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Remarks If set to another player RINCON, the player is grouped with that one.

SetCrossfadeMode

Set crossfade mode

const result = await sonos.AVTransportService.SetCrossfadeMode({ InstanceID:..., CrossfadeMode:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Remarks Send to non-coordinator returns error code 800. Same for content, which does not support crossfade mode.

SetNextAVTransportURI

const result = await sonos.AVTransportService.SetNextAVTransportURI({ InstanceID:..., NextURI:..., NextURIMetaData:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

SetPlayMode

Set the PlayMode

const result = await sonos.AVTransportService.SetPlayMode({ InstanceID:..., NewPlayMode:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Remarks Send to non-coordinator returns error code 712. If SONOS queue is not activated returns error code 712.

SnoozeAlarm

Snooze the current alarm for some time.

const result = await sonos.AVTransportService.SnoozeAlarm({ InstanceID:..., Duration:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

StartAutoplay

const result = await sonos.AVTransportService.StartAutoplay({ InstanceID:..., ProgramURI:..., ProgramMetaData:..., Volume:..., IncludeLinkedZones:..., ResetVolumeAfter:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

Stop

Stop playback

const result = await sonos.AVTransportService.Stop({ InstanceID:... });

Input object:

This actions returns a boolean whether or not the requests succeeded.

AVTransportService event

const SonosDevice = require('@svrooij/sonos').SonosDevice
const sonos = new SonosDevice('192.168.x.x')
sonos.AVTransportService.Events('serviceEvent', (data) => {
  console.log(data);
});

The AVTransportService emits events with these properties. Not all properties are emitted every time.

This file is automatically generated with @svrooij/sonos-docs, do not edit manually.