API reference - Ricoh Theta

/osc/commands response in progress of execution

	Definitions
Type	object

Description: Returned when the command execution is still in progress.

Examples:

{
    "name": "camera.takePicture",
    "id": "1234",
    "state": "inProgress",
    "progress": {
        "completion": 0
    }
}

{
    "name": "camera.startCapture",
    "id": "5678",
    "state": "inProgress",
    "progress": {
        "completion": 0.1
    }
}

{
    "name": "camera._convertVideoFormats",
    "id": "9012",
    "state": "inProgress",
    "progress": {
        "completion": 0.5
    }
}

Property	Type	Required	Description
name	string	yes	Executing command. See commands.
state	const	yes	State of the command.
id	string	yes	Command ID, used to check the execution status with /osc/commands/status API.
progress	object	yes	Progress of command processing.

name

	Definitions
Type	string

Description: Executing command. See commands.

state

	Definitions
Type	const

Description: State of the command.

Specific value: "inProgress"

id

	Definitions
Type	string

Description: Command ID, used to check the execution status with /osc/commands/status API.

progress

	Definitions
Type	object

Description: Progress of command processing.

Property	Type	Required	Description
completion	number	yes	Progress rate of command processing between zero and one.

completion

	Definitions
Type	number

Description: Progress rate of command processing between zero and one.

	Restrictions
Minimum	≥ 0
Maximum	≤ 1

---