API reference - Ricoh Theta

camera._listPlugins command response on successful completion

	Definitions
Type	object

Example:

{
    "results": {
        "plugins": [
            {
                "boot": false,
                "bootOptions": "",
                "exitStatus": "success",
                "force": false,
                "foreground": false,
                "message": "",
                "packageName": "com.theta.remoteplayback",
                "pluginName": "Remote Playback",
                "running": false,
                "type": "system",
                "version": "3.80.2",
                "webServer": false
            },
            {
                "boot": true,
                "bootOptions": "",
                "exitStatus": "success",
                "force": false,
                "foreground": false,
                "message": "",
                "packageName": "com.theta360.timeshiftshooting",
                "pluginName": "Time Shift Shooting",
                "running": false,
                "type": "user",
                "version": "1.0.2",
                "webServer": true
            }
        ]
    },
    "name": "camera._listPlugins",
    "state": "done"
}

Property	Type	Required	Description
name	const	yes	Executed command name
state	const	yes	Command execution status
results	object	yes	-

name

	Definitions
Type	const

Description: Executed command name

Specific value: "camera._listPlugins"

state

	Definitions
Type	const

Description: Command execution status

Specific value: "done"

results

	Definitions
Type	object

Property	Type	Required	Description
plugins	array	yes	List of the plugins installed in Theta

plugins

	Definitions
Type	array

Description: List of the plugins installed in Theta

	Array restrictions
Min items	N/A
Max items	N/A

Each item of this array must be	Description
plugin	Plugin information

plugin

	Definitions
Type	object

Description: Plugin information

Property	Type	Required	Description
pluginName	string	yes	Plugin name
packageName	string	yes	Package name
version	string	yes	Plugin version
type	enum (of string)	yes	The type of plugin. system Pre-installed plugin user User-added plugin
running	boolean	yes	Plugin power status. true running false stopping
foreground	boolean	yes	Process status. true foreground false background
boot	boolean	yes	Boot selection. true to be started false not to be started
force	boolean	yes	If true, starts the specified plugin when the power is turned on from power off or sleep. This setting can only be enabled for one plugin and defaults to false. After enabling this option, the specified plugin will always start. Make sure that the plugin that specifies this option can start and stop correctly before setting it.
bootOptions	string	yes	An option to pass to the plugin when the plugin starts.
webServer	boolean	yes	Existence of web server. true Has WebUI false Not have WebUI
exitStatus	string	yes	Exit status
message	string	yes	Message

pluginName

	Definitions
Type	string

Description: Plugin name

packageName

	Definitions
Type	string

Description: Package name

version

	Definitions
Type	string

Description: Plugin version

type

	Definitions
Type	enum (of string)

Description: The type of plugin.

system

Pre-installed plugin

user

User-added plugin

Must be one of:

• “system”
• “user”

running

	Definitions
Type	boolean

Description: Plugin power status.

true

running

false

stopping

foreground

	Definitions
Type	boolean

Description: Process status.

true

foreground

false

background

boot

	Definitions
Type	boolean

Description: Boot selection.

true

to be started

false

not to be started

force

	Definitions
Type	boolean

Description: If true, starts the specified plugin when the power is turned on from power off or sleep. This setting can only be enabled for one plugin and defaults to false.
After enabling this option, the specified plugin will always start. Make sure that the plugin that specifies this option can start and stop correctly before setting it.

bootOptions

	Definitions
Type	string

Description: An option to pass to the plugin when the plugin starts.

Restrictions
Max length	1536

webServer

	Definitions
Type	boolean

Description: Existence of web server.

true

Has WebUI

false

Not have WebUI

exitStatus

	Definitions
Type	string

Description: Exit status

message

	Definitions
Type	string

Description: Message

---