ProAmp8 API Function Reference


This document should be used in conjunction with the relevant ProAmp Product Manual and the API Documentation Overview section in the Remote Monitoring Portal.

This reference lists the ProAmp8 API functions for building third-party control system drivers. If you're an integrator or dealer rather than a programmer, use our free, pre-compiled drivers from the Remote Monitoring Portal instead of calling the API directly.

This is a public list of documented functions. There may be additional commands that exist on the device but aren't listed here — these are reserved for one-time device setup and are best done through the web interface. Contact support@pulse-eight.com if you need clarification on anything below.

Power

Controls the power state of a zone output.

amp/power/{zone}/{state}
ParameterValue
zone0–7
state1 = on, 0 = off
ExampleResponse
amp/power/0/1{"Result":true,"Message":"Changed"}

Volume

Manages the audio volume level for a zone output.

amp/volume/{zone}/[{left volume}]/[{right volume}]
ParameterValue
zone0–7
left volume, right volume0–100
If Dolby is enabled for that zone (zones 0–2 for dolbyMode 1, zones 0–3 for dolbyMode 2), the response returns a single dolbyvolume value instead of separate left/right values. Zones 4–7 always use standard stereo volume.
ExampleResponseNotes
amp/volume/0{"Result":true,"volLeft":44,"volRight":44}Reads current volume (standard mode)
amp/volume/0/50{"volLeft":50,"volRight":50,"Result":true,"Message":"Changed"}Sets both channels to 50 (standard mode)
amp/volume/0/50/40{"volLeft":50,"volRight":40,"Result":true,"Message":"Changed"}Sets left to 50, right to 40 (standard mode)
amp/volume/0/up{"volLeft":43,"volRight":43,"Result":true,"Message":"Changed"}Increments by 1
amp/volume/0/down{"volLeft":43,"volRight":43,"Result":true,"Message":"Changed"}Decrements by 1

Mute

Manages channel mute for a zone output.

amp/mute/{zone}/{channel}/[state]
ParameterValue
zone0–7
channel0 = normal, 1 = mute left, 2 = mute right, 3 = mute left and right
ExampleResponseNotes
amp/mute/0{"Result":true,"mute":0}Reads current mute state
amp/mute/0/0 or amp/mute/0/3{"Result":true,"Message":"Changed"}Toggles mute on both channels
amp/mute/0/0/1{"Result":true,"Message":"Changed"}Mutes both channels explicitly
amp/mute/0/0/0{"Result":true,"Message":"Changed"}Unmutes both channels explicitly

Zone Settings (stdzone)

Reads or updates the full settings block for a standard stereo zone. All POST fields are optional except zone.

amp/stdzone {POSTdata}
FieldValue
zone0–7
volLeft, volRight0–100 (0 = mute, 50 = midpoint between minVol and maxVol)
minVol, maxVol0–248 in 0.5dB steps (1 = -99.5dB, 200 = 0dB, 248 = +24dB)
mute0 = normal, 1 = mute left, 2 = mute right, 3 = mute both
bridgedMode0 = normal, 1 = bridged
pwrMode0 = off, 1 = on, 2 = 12V trigger, 3 = auto
autoLevelLevel the zone turns on at, 0–248 in 0.5dB steps
autoTimeSeconds of quiet before a zone auto-powers off
ExampleResponse
amp/stdzone{"zone":0,"volLeft":43,"volRight":43}{"Result":true,"Message":"Zone updated"}
amp/stdzoneReturns the settings array for all zones

Dolby Global Settings (dolbysettings)

Manages global Dolby multi-channel settings. All POST fields are optional.

amp/dolbysettings {POSTdata}
FieldValue
dolbyMode0 = standard, 1 = Dolby 3-zone, 2 = Dolby 4-zone
pcmUpMixF0 = pass-through, 1 = up-mix PCM to 5.1
volume0–100
minVol, maxVol0–248 in 0.5dB steps
bass, treble104–152 (128 = flat, 104 = -12dB, 152 = +12dB)
ExampleResponse
amp/dolbysettings{"dolbyMode":1,"pcmUpMixF":0}{"Result":true,"Message":"Dolby Settings updated"}

Dolby Zone Settings (dolbyzone)

Manages per-zone Dolby output settings. All POST fields are optional except zone.

amp/dolbyzone {POSTdata}
FieldValue
zone0 = FL/FR, 1 = SL/SR, 2 = Centre, 3 = Sub
delayLeft, delayRight0–50ms
spkrLeft, spkrRight0–248 in 0.5dB steps
eqLeft, eqRight5-band array, each 104–152 (128 = flat)
ExampleResponse
amp/dolbyzone{"zone":0,"delayLeft":0,"delayRight":0}{"Result":true,"Message":"Dolby zone updated"}

Routing

The functions in this section were confirmed directly from the device web interface and its JavaScript source rather than from prior published documentation — flagging so this can be checked against firmware behaviour before publishing.

Reads or sets the input/output routing matrix.

CommandDescription
Port/ListReturns the state of every input and output port. Suitable for continuous polling.
Port/Details/{Mode}/{Bay}Returns detail for a single input or output port. Mode is Input or Output.
Port/Set/{sourceBay}/{destBay}Routes an input to an output.
Port/SetName/{Mode}/{Bay}POST body {"Name":"..."} — renames a port.

Related Articles

Need help with the API?

We can answer questions about documented API behaviour, but we can't provide programming assistance writing your driver.

UK: 01202 413 610 | US: (858) 748-8250 | support@pulse-eight.com