Set announcement settings displayed during talk

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

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",
  "text": "Additional info about announcement"
}

Validation error. Required fields are not provided.

Timeout must be in range from 15 to 3600 seconds.
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

error string
Error message

{
  "error": true
}

{
  "error": "Missed JSON body"
}

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

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

{
  "error": "Wrong content"
}

{
  "error": "Wrong text"
}

{
  "error": "Wrong mode, available values are: [full_screen, partial_screen]"
}

{
  "error": "Wrong timeout. Available values are in range: [15, 3600]"
}

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"
}

Set announcement settings displayed during talk​

Set announcement settings displayed during talk