Add systemproperties doc Change-Id: Ie50af1417c801f158599966e0d071666f9f99268
diff --git a/plugin/CobaltPlugin.json b/plugin/CobaltPlugin.json index 49583a2..ce9567b 100644 --- a/plugin/CobaltPlugin.json +++ b/plugin/CobaltPlugin.json
@@ -8,6 +8,47 @@ "description": "The Cobalt plugin provides web browsing functionality based on the Cobalt engine.", "version": "1.0" }, + "definitions": { + "systemproperties": { + "description": "Configure some properties queried with Starboard System API", + "type": "object", + "required": [], + "properties": { + "modelname": { + "type": "string", + "description": "The production model number of the device" + }, + "brandname": { + "type": "string", + "description": "The name of the brand under which the device is being sold" + }, + "modelyear": { + "type": "string", + "description": "The year the device was launched" + }, + "chipsetmodelnumber": { + "type": "string", + "description": "The full model number of the main platform chipset" + }, + "firmwareversion": { + "type": "string", + "description": "The production firmware version number which the device is currently running" + }, + "integratorname": { + "type": "string", + "description": "Original manufcature of the device" + }, + "friendlyname": { + "type": "string", + "description": "A friendly name for this actual device" + }, + "devicetype": { + "type": "string", + "description": "Type of the device. Possible values [SetTopBox, OverTheTopBox, TV]" + } + } + } + }, "configuration": { "type": "object", "properties": { @@ -30,6 +71,13 @@ "autosuspenddelay": { "type": "number", "description": "Applicable when pre-loading. Number of seconds to wait before suspending the app" + }, + "gstdebug": { + "type": "string", + "description": "Configure GST_DEBUG environment variable, default: 'gstplayer:4,2'" + }, + "systemproperties": { + "$ref": "#/definitions/systemproperties" } } }
diff --git a/plugin/doc/CobaltPlugin.md b/plugin/doc/CobaltPlugin.md index 37c2912..b9ff671 100644 --- a/plugin/doc/CobaltPlugin.md +++ b/plugin/doc/CobaltPlugin.md
@@ -81,6 +81,16 @@ | configuration?.language | string | <sup>*(optional)*</sup> POSIX-style Language(Locale) ID. Example: 'en_US' | | configuration?.preload | boolean | <sup>*(optional)*</sup> Enable pre-loading of application | | configuration?.autosuspenddelay | number | <sup>*(optional)*</sup> Applicable when pre-loading. Number of seconds to wait before suspending the app | +| configuration?.gstdebug | string | <sup>*(optional)*</sup> Configure GST_DEBUG environment variable, default: 'gstplayer:4,2' | +| configuration?.systemproperties | object | <sup>*(optional)*</sup> Configure some properties queried with Starboard System API | +| configuration?.systemproperties?.modelname | string | <sup>*(optional)*</sup> The production model number of the device | +| configuration?.systemproperties?.brandname | string | <sup>*(optional)*</sup> The name of the brand under which the device is being sold | +| configuration?.systemproperties?.modelyear | string | <sup>*(optional)*</sup> The year the device was launched | +| configuration?.systemproperties?.chipsetmodelnumber | string | <sup>*(optional)*</sup> The full model number of the main platform chipset | +| configuration?.systemproperties?.firmwareversion | string | <sup>*(optional)*</sup> The production firmware version number which the device is currently running | +| configuration?.systemproperties?.integratorname | string | <sup>*(optional)*</sup> Original manufcature of the device | +| configuration?.systemproperties?.friendlyname | string | <sup>*(optional)*</sup> A friendly name for this actual device | +| configuration?.systemproperties?.devicetype | string | <sup>*(optional)*</sup> Type of the device. Possible values [SetTopBox, OverTheTopBox, TV] | <a name="head.Methods"></a> # Methods