updateNoiseMeterInstance

PUT

/api/v1/plugins/noise-meter/instances/{id}

curl --request PUT \
  --url https://example.com/api/v1/plugins/noise-meter/instances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: example' \
  --data '{ "name": "example", "message": "example", "warningLevel": 60, "loudLevel": 80, "sensitivity": 100, "triggerHoldMs": 1000, "clearHoldMs": 3000, "displayMode": "overlay", "heightPx": 96, "scheduleEnabled": false, "scheduleDaysOfWeek": [ 1 ], "scheduleStartTime": "example", "scheduleEndTime": "example", "scheduleTimezone": "UTC", "enabled": true, "targetScope": "all", "targetIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Parameters

Path Parameters

id

required

string format: uuid

Header Parameters

X-CSRF-Token

required

string

Request Body^required

Media typeapplication/json

Thresholds for the Linux Player’s room noise bar. Levels are a relative 0-100 scale measured against that player’s own microphone; they are not dB, dBA, or SPL, and no audio, sample, or microphone identifier is exchanged in either direction. warningLevel must be below loudLevel: one threshold used for both showing and hiding makes the bar flap.

object

name

required

string

>= 1 characters <= 180 characters

message

required

Replaces the bar’s own TOO LOUD label. Empty is allowed.

string

<= 120 characters

warningLevel

required

Where the yellow zone begins, and the level the room must stay below before the bar hides.

integer

default: 60 >= 1 <= 99

loudLevel

required

Where the red zone begins and the bar can appear.

integer

default: 80 >= 2 <= 100

sensitivity

required

Percentage applied to the captured signal before normalization, for a microphone that reads quiet or hot. Not a calibration.

integer

default: 100 >= 25 <= 300

triggerHoldMs

required

How long the room must stay loud before the bar appears.

integer

default: 1000 >= 100 <= 10000

clearHoldMs

required

How long it must stay below warningLevel before the bar hides.

integer

default: 3000 >= 500 <= 30000

displayMode

required

Allowed values: overlay push

heightPx

required

integer

default: 96 >= 40 <= 320

scheduleEnabled

When false the bar may show whenever the room is too loud. A window governs the bar alone; the room is measured either way.

boolean

scheduleDaysOfWeek

Days the window may start on, Sunday 0 through Saturday 6.

Array<integer>

<= 7 items unique items

scheduleStartTime

string | null

/^[0-9]{2}:[0-9]{2}$/

scheduleEndTime

At or before the start is an overnight window belonging to the start day. The window is half-open, so the end minute is outside it.

string | null

/^[0-9]{2}:[0-9]{2}$/

scheduleTimezone

string

default: UTC <= 100 characters

enabled

required

boolean

targetScope

required

Allowed values: all screens sync_groups locations

targetIds

required

Array<string>

<= 250 items unique items

Responses

200

Noise Meter instance replaced

400

Typed configuration

403

Owner or Administrator required

404

Instance not found