Get announcement settings displayed in standby

• Feature enables/disables displaying video announcement in standby
• This feature is available in AA-14FBS/FBIS.

Maximum fullscreen video size is 800x1280px. Maximum video size for partial_screen mode is 680x620px.

Responses

• 200
• 401
• 403
• 404

---

OK

application/json

• Schema
• Example (from schema)
• A A-14 F B S/ F B I S

---

Schema

• is_enabled boolean

  Determines whether the feature is enabled

• content

  Media content. For GET request returns info in two formats:

  • '/api/v1/files?videoPath=ads-resource.mp4' for local file.
  • 'https://remote.server/ads-resource.mp4' for remote resource. This field is not required when uploading local video file.
• timeout integer

  Possible values: >= 15 and <= 3600

  Timeout in seconds

• mode string

  Possible values: [partial_screen, full_screen]

  In AA-14 panels threre is two modes. In full_screen mode ads will be disaplayed in full screen. In partial_screen mode additional text can be added to announcement video.

• available_modes string[]

  Possible values: [partial_screen, full_screen]

  List of available displaying options

• text string

  Possible values: <= 750 characters

  Optional text can be added to announcement video.

{
  "is_enabled": true,
  "timeout": 30,
  "mode": "full_screen",
  "available_modes": [
    "full_screen"
  ],
  "text": "Additional info about announcement"
}

{
  "is_enabled": true,
  "content": "/api/v1/files?videoPath=ads-resource.mp4",
  "timeout": 15,
  "mode": "partial_screen",
  "available_modes": [
    "partial_screen",
    "full_screen"
  ],
  "text": "Announcement title"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

This feature is disabled on your device

Loading...