Audio control service API

The Audio Control service provides mechanisms for adjusting the foreground and background volume for a device.

Foreground volume will set the volume for high priority audio, such as audio clips and VoIP (Voice over Internet Protocol).

Background volume is audio at a lower priority, for example ACAP Audio Players playing background music or a line in when available. Foreground audio is always prioritized over background audio.

Please note that this API has been deprecated as of firmware version 10.12 and will no longer receive any updates.

Identification

JSON and simplified key-value requests

In some VAPIX API:s requests can be constructed using JSON or a simplified key-value format.

The simplified key-value format is a flattened structure with key=value  strings. Levels in the structure are indicated by underscores (_).

• Boolean values are encoded as true and false.

• The NULL value is encoded as null.

• Strings are URL-encoded and may start and end with quotation marks. Example: "a+string%0A".

• Array keys are encoded as _index_ where index is an integer starting from 0.

Simple cURL examples

$ curl -anyauth -s "http://root:pass@192.168.0.90/vapix/audiocontrol"
   -d'{"axac:GetVolume":{}}'
{
  "Volume": {
    "ForegroundVolume": -20,
    "ForegroundVolumeUnit": "dB",
    "ForegroundVolumeMute": false,
    "BackgroundVolume": -20,
    "BackgroundVolumeUnit": "dB",
    "BackgroundVolumeMute": false
  }
}

$ curl --anyauth "http://root:pass@192.168.0.90/vapix/audiocontrol? ...
  format=simple&action=axac:GetVolume"


Volume_ForegroundVolume=-20
Volume_ForegroundVolumeUnit="dB"
Volume_ForegroundVolumeMute=false
Volume_BackgroundVolume=-20
Volume_BackgroundVolumeUnit="dB"
Volume_BackgroundVolumeMute=false

Adjust volume

{
  "axac:SetVolume": {
    "Volume": {
      "ForegroundVolume":-21,
      "BackgroundVolumeMute"= true
    }
  }
}

{}

$ curl --anyauth "http://root:pass@192.168.0.90/vapix/audiocontrol? ...
format=simple&action=axac:SetVolume&Volume_ForegroundVolume=-21&Volume_BackgroundVolumeMute=true

Adjust InputConfiguration

{
  "axac:SetInputConfiguration": {
    "InputConfiguration":{
      "InputId": "analog_1",
      "ChannelId": "Background",
      "Enabled": true
    }
  }
}

{}

The GetControlCapabilities call can be used to retrieve the capabilities of the service, to handle future extensions.

Range

Describes a range of valid values and the unit.

Control Capabilities

The structure of ServiceCapabilities reflects the optional functionality of a service. The information is static and does not change during device operation.

GetControlCapabilities Command

This operation returns the capabilities of the service.

{}

The request is empty.

{
  "Capabilities": {
    "ControlCapabilities"
  }
}

Volume

The configuration of foreground and background volumes for a device. Valid parameter values may be defined by the service capabilities. The following fields are available, some of which are optional:

SetVolume Command

Requests that a Volume should be set. All members of the Volume are optional, so a Volume with all members empty will be accepted, but won’t change anything.

{
  "Volume": {
    "Volume"
  }
}

GetVolume command

Returns the Volume of the Audio Relay network.

{}

The request is empty.

{
  "Volume": {
    "Volume"
  }
}