Skip to main content

Speaker display settings

This API is based on the Device Configuration API framework. For guidance on how to use these APIs, please refer to Device Configuration APIs.

The VAPIX® Speaker display settings API enables configurations for the appearance and availability of the display clock, display brightness and localization.

Authentication​

For detailed information on how to authenticate requests to this API, please refer to Authentication.

Use cases​

Get all settings​

This example will show you how to retrieve the full collection of settings.

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/speaker-display-settings/v1"
200 OK
Content-Type: application/json

{
    "status": "success",
    "data": {
        "appearance": {
            "backgroundColor": "#000000",
            "fontColor": "#670f0f",
            "language": "en",
            "showDate": true,
            "showSeconds": false,
            "use24HourClock": true
        },
        "brightness": {
            "adaptiveBrightness": true,
            "manualLevel": 6,
            "maxAdaptiveLevel": 6,
            "minAdaptiveLevel": 1
        },
        "powerSave": {
            "mode": "presenceDetection",
            "presenceDetection": {
                "powerSaveTimerMinutes": 20
            },
            "schedule": {
                "invert": false,
                "scheduleId": "com.axis.schedules.office_hours"
            }
        }
    }
}

Set appearance settings​

This example will show you how to apply the appearance settings.

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/speaker-display-settings/v1/appearance" \
  --data '{
    "data": {
        "backgroundColor": "#000000",
        "fontColor": "#670f0f",
        "language": "en",
        "showDate": true,
        "showSeconds": false,
        "use24HourClock": true
    }
}'
200 OK
Content-Type: application/json

{
    "status": "success"
}

Set brightness settings​

This example will show you how to apply the brightness settings.

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/speaker-display-settings/v1/brightness" \
  --data '{
    "data": {
        "adaptiveBrightness": true,
        "manualLevel": 6,
        "maxAdaptiveLevel": 5,
        "minAdaptiveLevel": 4
    }
}'
200 OK
Content-Type: application/json

{
    "status": "success"
}

Set power saving settings​

This example will show you how to apply the power saving settings.

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/speaker-display-settings/v1/powerSave" \
  --data '{
    "data": {
        "mode": "alwaysOff",
        "presenceDetection": {
            "powerSaveTimerMinutes": 40
        },
        "schedule": {
            "invert": true,
            "scheduleId": "com.axis.schedules.office_hours"
        }
    }
}'
200 OK
Content-Type: application/json

{
    "status": "success"
}

API definition​

Structure​

speaker-display-settings.v1 (Root Entity)
    ├── appearance (Entity)
        ├── backgroundColor (Property)
        ├── fontColor (Property)
        ├── language (Property)
        ├── showDate (Property)
        ├── showSeconds (Property)
        ├── use24HourClock (Property)
    ├── brightness (Entity)
        ├── adaptiveBrightness (Property)
        ├── manualLevel (Property)
        ├── maxAdaptiveLevel (Property)
        ├── minAdaptiveLevel (Property)
    ├── powerSave (Entity)
        ├── mode (Property)
        ├── presenceDetection (Property)
        ├── schedule (Property)

Entities​

speaker-display-settings.v1​

  • Description: Speaker Display Settings Root Entity.
  • Type: Singleton
  • Operations
    • Get
    • Set
  • Attributes
    • Dynamic Support: No

Properties

This entity has no properties.

Actions

This entity has no actions.

speaker-display-settings.v1.appearance​

  • Description: Speaker Display Appearance Entity.
  • Type: Singleton
  • Operations
    • Get
    • Set
  • Properties: backgroundColor, fontColor, language, showDate, showSeconds, use24HourClock
  • Attributes
    • Dynamic Support: No

Properties

backgroundColor​
  • Description: Color of the background.
  • Datatype: ColorFormat
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
fontColor​
  • Description: Color of the text when idle.
  • Datatype: ColorFormat
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
language​
  • Description: Localization of the clock shown when idle.
  • Datatype: DateLanguage
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
showDate​
  • Description: If enabled, the current date will be displayed.
  • Datatype: boolean
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
showSeconds​
  • Description: If enabled, seconds will be displayed.
  • Datatype: boolean
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
use24HourClock​
  • Description: If enabled, the clock will display the 24-hour format; otherwise, it will display the 12-hour format with AM/PM.
  • Datatype: boolean
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

Actions

This entity has no actions.

speaker-display-settings.v1.brightness​

  • Description: Speaker Display Brightness Entity.
  • Type: Singleton
  • Operations
    • Get
    • Set
      • Properties: adaptiveBrightness, manualLevel, maxAdaptiveLevel, minAdaptiveLevel
  • Attributes
    • Dynamic Support: No

Properties

adaptiveBrightness​
  • Description: Adaptive display brightness enabled or disabled. If enabled, display brightness will be automatically adjusted to match ambient luminance. Adaptive display brightness is paused whenever there is an active notification.
  • Datatype: boolean
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
manualLevel​
  • Description: Manual display brightness set by user. Applicable only if adaptive brightness is disabled.
  • Datatype: BrightnessRange
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
maxAdaptiveLevel​
  • Description: Maximum display brightness for adaptive mode.
  • Datatype: BrightnessRange
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
minAdaptiveLevel​
  • Description: Minimum display brightness for adaptive mode.
  • Datatype: BrightnessRange
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

Actions

This entity has no actions.

speaker-display-settings.v1.powerSave​

  • Description: Speaker Display Power Save Entity.
  • Type: Singleton
  • Operations
    • Get
    • Set
      • Properties: mode, presenceDetection, schedule
  • Attributes
  • Dynamic Support: No

Properties

mode​
  • Description: Power saving mode can be alwaysOn, alwaysOff, schedule, or presenceDetection.
  • Datatype: PowerSaveModes
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
presenceDetection​
  • Description: Parameters belonging to the power save mode presenceDetection.
  • Datatype: PresenceDetection
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
schedule​
  • Description: Parameters belonging to the power save mode schedule.
  • Datatype: Schedule
  • Operations
    • Get (Permissions: admin)
    • Set (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

Actions

This entity has no actions.

Data types​

BrightnessRange​
  • Description: Supported brightness range.
  • Type: integer
  • Minimum Value: 1
  • Maximum Value: 7
ColorFormat​
  • Description: Colors are represented using RGB hexadecimal values.
  • Type: string
  • Pattern: ^#[0-9a-fA-F]{6}$
DateLanguage​
  • Description: String enumeration for supported localizations.
  • Type: string
  • Enum Values: "ar", "de", "en", "es", "fr", "global", "it", "ja", "ko", "th", "tr", "zh", "zh-TW"
PowerSaveModes​
  • Description: String enumeration for power save modes.
  • Type: string
  • Enum Values: "alwaysOn", "alwaysOff", "presenceDetection", "schedule"
PowerSaveTimerMinutes​
  • Description: Power save timeout in minutes.
  • Type: integer
  • Minimum Value: 1
  • Maximum Value: 60
PresenceDetection​
  • Description: Parameters belonging to the power save mode "presenceDetection".
  • Type: complex
  • Fields
    • powerSaveTimerMinutes
      • Description: Time without presence before the display turns off.
      • Type: PowerSaveTimerMinutes
      • Nullable: No / Gettable: Yes
Schedule​
  • Description: Parameters belonging to the power save mode "schedule".
  • Type: complex
  • Fields
    • invert
      • Description: When enabled, the schedule is inverted. The times it's normally active become inactive and the times it's normally inactive become active.
      • Type: boolean
      • Nullable: No / Gettable: Yes
    • scheduleId
      • Description: The identification string of a configured schedule.
      • Type: ScheduleIdStr
      • Nullable: Yes / Gettable: Yes
ScheduleIdStr​
  • Description: The identification string of a configured schedule.
  • Type: string
  • Maximum Length: 100