Link Search Menu Expand Document
Sonos

AudioIn service

Control line in

The AudioIn service is available on these models: v2-S6.

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

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

  1. GetAudioInputAttributes
  2. GetLineInLevel
  3. SelectAudio
  4. SetAudioInputAttributes
  5. SetLineInLevel
  6. StartTransmissionToGroup
  7. StopTransmissionToGroup
  8. AudioInService event

GetAudioInputAttributes 

const result = await sonos.AudioInService.GetAudioInputAttributes();

Output object:

property type description
CurrentName string  
CurrentIcon string  

GetLineInLevel 

const result = await sonos.AudioInService.GetLineInLevel();

Output object:

property type description
CurrentLeftLineInLevel number  
CurrentRightLineInLevel number  

SelectAudio 

const result = await sonos.AudioInService.SelectAudio({ ObjectID:... });

Input object:

property type description
ObjectID string  

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

SetAudioInputAttributes 

const result = await sonos.AudioInService.SetAudioInputAttributes({ DesiredName:..., DesiredIcon:... });

Input object:

property type description
DesiredName string  
DesiredIcon string  

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

SetLineInLevel 

const result = await sonos.AudioInService.SetLineInLevel({ DesiredLeftLineInLevel:..., DesiredRightLineInLevel:... });

Input object:

property type description
DesiredLeftLineInLevel number  
DesiredRightLineInLevel number  

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

StartTransmissionToGroup 

const result = await sonos.AudioInService.StartTransmissionToGroup({ CoordinatorID:... });

Input object:

property type description
CoordinatorID string  

Output object:

property type description
CurrentTransportSettings string  

StopTransmissionToGroup 

const result = await sonos.AudioInService.StopTransmissionToGroup({ CoordinatorID:... });

Input object:

property type description
CoordinatorID string  

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

AudioInService event 

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

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

parameter type possible values
AudioInputName string  
Icon string  
LeftLineInLevel number  
LineInConnected boolean  
Playing boolean  
RightLineInLevel number  

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