Link Search Menu Expand Document
Sonos

ConnectionManagerService

The ConnectionManagerService is available on these models: v1-S1 / v1-S5 / v1-S9.

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

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

  1. GetCurrentConnectionIDs
  2. GetCurrentConnectionInfo
  3. GetProtocolInfo
  4. ConnectionManagerService event

GetCurrentConnectionIDs 

const result = await sonos.ConnectionManagerService.GetCurrentConnectionIDs();

Output object:

property type description
ConnectionIDs string  

GetCurrentConnectionInfo 

const result = await sonos.ConnectionManagerService.GetCurrentConnectionInfo({ ConnectionID:... });

Input object:

property type description
ConnectionID number  

Output object:

property type description
RcsID number  
AVTransportID number  
ProtocolInfo string  
PeerConnectionManager string  
PeerConnectionID number  
Direction string Possible values: Input / Output
Status string Possible values: OK / ContentFormatMismatch / InsufficientBandwidth / UnreliableChannel / Unknown

GetProtocolInfo 

const result = await sonos.ConnectionManagerService.GetProtocolInfo();

Output object:

property type description
Source string  
Sink string  

ConnectionManagerService event 

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

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

parameter type possible values
CurrentConnectionIDs string  
SinkProtocolInfo string  
SourceProtocolInfo string  

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