Set standby settings

Configures standby settings.

When standby mode is enabled, one of three display modes can be selected:

• ip_cam_mode
• photo_frame
• clock

ip_cam_mode supports three sub-modes:

• single
• tour
• quad_splitter

Note: quad_splitter is not available on the aq07la device.

application/json

Request Body required

• enable boolean required

  Determines whether the device will show splash screen after timeout

• mode string required

  Possible values: [ip_cam_mode, photo_frame, clock]

  Splash screen mode

• ip_cam_mode object required

  IP cam mode options

  mode string required

  IP cam mode

  single object required

  This model provides camera information used for configuring splash screen

  name string required

  Camera name

  url string required

  Camera RTSP url

  uuid uuid

  Unique identifier

  tour object required

  IP cam tour mode settings

  ip_cams object[]

  Possible values: <= 32

  The model describes the list of cameras used in 'Tour' splash screen

  name string required

  Camera name

  url string required

  Camera RTSP url

  uuid uuid

  Unique identifier

  timeout integer

  Camera changing interval in seconds

  quad_splitter object required

  This model provides information used for configuring 'Quad' splash screen

  This option is disabled in AQ-07LA model

  ip_cam_1 object

  This model provides camera information used for configuring splash screen

  name string required

  Camera name

  url string required

  Camera RTSP url

  uuid uuid

  Unique identifier

  ip_cam_2 object

  This model provides camera information used for configuring splash screen

  name string required

  Camera name

  url string required

  Camera RTSP url

  uuid uuid

  Unique identifier

  ip_cam_3 object

  This model provides camera information used for configuring splash screen

  name string required

  Camera name

  url string required

  Camera RTSP url

  uuid uuid

  Unique identifier

  ip_cam_4 object

  This model provides camera information used for configuring splash screen

  name string required

  Camera name

  url string required

  Camera RTSP url

  uuid uuid

  Unique identifier

• photo_frame required

  Photo frame splash screen settings

  directory_path string

  Photo directory path

  clock_enable boolean

  Determines whether the clock will be displayed in this type of splash screen

Responses

• 200
• 400
• 401

---

OK

• Missed json body or wrong param. Response sample:

  "error": "Wrong JSON body"

• Required field is not provided. Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

• Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Base
• No value
• Wrong param type
• Quad Splitter
• Wrong Mode
• Wrong Ip Cam Mode

---

Schema

• error string

  Error information

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

{
  "error": "Wrong json: incorrect ip_cam_mode=quad_splitter. Available modes: [single, tour]"
}

{
  "error": "mode should match photo_frame or clock or ip_cam_mode"
}

{
  "error": "Ip cam mode should match: 'single' or 'tour' or 'quad_splitter'"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error information

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...