manifest.json

Estimated reading time: 5 minutes

manifest.json Structure

A manifest file manifest.json contains application information. The Web Application can define information and several settings (e.g. Application ID, Title, Splash Image, Initial URL and so on.)

Field Name Type Description
name Mandatory Application's name
default Mandatory Default Language
en_US Application name in English
ja_JP Application name in Japanese
... Application name in other languages
auid Mandatory Application's unique ID
version Mandatory Version number of the application
manifest_version Mandatory Version number of the manifest
app Application's information
launch
local_path Conditional Local path to the initial page
web_url Conditional URL to the initial page
screen
orientation Optional 0 : normal position (default)
90 : 90 degrees to the right
270 : 270 degrees to the right (90 degrees to the left)
(*)180 degrees isn't supported
bgcolor Optional Browser's background color can be specified (e.g."#FFFFFFFF")
window_close Optional Specify the behavior of the function window.close().
0: disabled (default)
1: enabled
attachkeys Optional Additional keys to be delivered to web app (see also "Integrate Remote commander")
alert_dialog Optional ignore : Does not show an alert dialog
confirm_dialog Optional yes : "Yes" is always chosen when the confirm dialog is shown
no : "No" is always chosen
prompt_dialog Optional This value is put always when the prompt dialog is shown
initial_input Optional The picture quality configuration that is applied at default.
video : picture quality configuration for video
photo : picture quality for photo
fixed_input Optional true can be specified to prevent switching picture quality configuration (which increases blinking)
true : picture quality configuration is fixed regardless actual input source
false : picture quality configuration depending on the actual input source that is applied (default)
onsleep Optional The behavior when powering off by remote occurs when the browser runs.
stop : Browser terminates its activity (default)
pause : Browser suspends its activity during a display sleeps. Browser resumes its activity once a display resumes.
continue : Browser keeps its activity.
cache_files_and_images Optional true : enable cache (default) [cache includes HTML, CSS, JavaScript, Media contents]
false : disable cache
error_page
default Optional It can define the default page of HTTP errors.
(e.g. "http://example.com/error/404.html")
detail Optional This attribute can specify the error page for for each HTTP status code.
The following is an example to define URLs of 403, 505 and timeout errors.

[ {“status_code” : “403”, “path” : “http://example.com/errordocs/403.html”} ,
{“status_code” : “500”, “path” : “file://localhost/errordocs/500.html”} ,
{“status_code” : “timeout”, “path” : “file://localhost/errordocs/timeout.html”}]

splash Optional Relative path to the splash image file
reboot Optional true : Relaunches the application automatically when the application crashed
false (default)
minimum_web_platform_version Mandatory Web Platform Version

A template manifest is shown below. The manifest file must be named “manifest.json”.

{
  "name": {
    "default": "en_US",
    "en_US": "Sample Application of BRAVIA Professional Display"
  },
  "auid": "com.example.app.myapp",
  "version": "1.0",
  "manifest_version": "1.0",
  "app": {
    "launch": {
      "web_url": "https://example.com/myapp"
    }
  },
  "splash": "splash.jpg",
  "minimum_web_platform_version": "1.0"
}
Last modified: 13 Aug 2019