API reference - Ricoh Theta

/osc/state response

	Definitions
Type	`object`

Examples:

"Theta X"

{
    "fingerprint": "FIG_0264",
    "state": {
        "_apiVersion": 2,
        "_batteryInsert": true,
        "batteryLevel": 0.64,
        "_batteryState": "charging",
        "_batteryTemp": 27,
        "_boardTemp": 26,
        "_cameraError": [],
        "_captureStatus": "idle",
        "_capturedPictures": 0,
        "_currentMicrophone": "Internal",
        "_currentStorage": "IN",
        "_externalGpsInfo": {
            "gpsInfo": {
                "_altitude": 10.0,
                "_dateTimeZone": "2024:04:18 13:50:45+09:00",
                "_datum": "WGS84",
                "lat": 35.0,
                "lng": 135.0
            }
        },
        "_function": "normal",
        "_internalGpsInfo": {
            "gpsInfo": {
                "_altitude": 12.3,
                "_dateTimeZone": "2024:04:25 07:55:10+09:00",
                "_datum": "WGS84",
                "lat": 35.0,
                "lng": 135.0
            }
        },
        "_latestFileUrl": "http://192.168.1.10/files/100RICOH/R0010208.MP4",
        "_mySettingChanged": false,
        "_pluginRunning": false,
        "_pluginWebServer": false,
        "_recordableTime": 23325,
        "_recordedTime": 0,
        "_storageID": "412176649172527ab3d5edabb50a7d69",
        "storageUri": "http://192.168.1.10/files/"
    }
}

"Theta Z1"

{
    "fingerprint": "FIG_0021",
    "state": {
        "_apiVersion": 2,
        "batteryLevel": 0.65,
        "_batteryState": "charging",
        "_batteryTemp": 33,
        "_boardTemp": 33,
        "_cameraError": [],
        "_captureStatus": "idle",
        "_capturedPictures": 0,
        "_compositeShootingElapsedTime": 0,
        "_externalGpsInfo": {
            "gpsInfo": {
                "_altitude": 10.20000457763672,
                "_dateTimeZone": "2024:04:24 23:35:18+00:00",
                "_datum": "WGS84",
                "lat": 35.0,
                "lng": 135.0
            }
        },
        "_function": "normal",
        "_internalGpsInfo": {},
        "_latestFileUrl": "http://192.168.1.22/files/150100524436344d420152c268132500/100RICOH/R0010492.JPG",
        "_mySettingChanged": false,
        "_pluginRunning": false,
        "_pluginWebServer": false,
        "_recordableTime": 0,
        "_recordedTime": 0,
        "storageUri": "http://192.168.1.22/files/150100524436344d420152c268132500/"
    }
}

Property	Type	Required	Description
fingerprint	string	yes	Unique value identifies the current state. See /osc/checkForUpdates
state	object	yes	State of Theta

fingerprint

	Definitions
Type	`string`

Description: Unique value identifies the current state. See /osc/checkForUpdates

state

	Definitions
Type	`object`

Description: State of Theta

Property	Type	Required	Description
_batterylnsert	boolean	no	Is a battery inserted or not. Theta X only.
batteryLevel	number	no	Battery level from 0.0 to 1.0. When using an external power source, 1.0
_batteryState	enum (of string)	yes	Charging state: charging On charge charged Charging completed disconnect Not charging
_batteryTemp	integer	yes	Current temperature inside the battery in degree Celsius
_boardTemp	integer	yes	Current temperature inside the camera in degree Celsius
_cameraError	array of enum (of string)	yes	Current error information of Theta
_capturedPictures	integer	yes	Number of still images captured during continuous shooting
_captureStatus	enum (of string)	yes	Continuously shoots state: bracket shooting Performing multi bracket shooting continuous shooting Performing continuous shooting. Theta X only converting Converting post file idle In standby retrospective image recording Waiting for retrospective video. Theta X only self-timer countdown Self-timer is operating timeShift shooting Performing time shift shooting
_compositeShootingElapsedTime	integer	no	Elapsed time for interval composite shooting (seconds). Theta Z1 only
_currentMicrophone	enum (of string)	no	Identifies the microphone used while recording video when _microphone option is set to “AUTO”. Theta X only. Internal Use the built-in microphone External Use the external microphone
_currentStorage	enum (of string)	no	Theta X only. IN Record to internal memory SD Record to SD card
_externalGpsInfo	object	no	Location data is obtained through an external device using WebAPI or BLE-API.
_function	enum (of string)	yes	Shooting function status: normal Normal shooting function mySetting My setting shooting function selfTimer Self-timer shooting function. Theta Z1 only
_internalGpsInfo	object	no	Location data is obtained through an internal GPS module.
_latestFileUrl	string	yes	URL of the last saved file. In the case of Theta Z1, DNG format files are not displayed except for burst shooting.
_mySettingChanged	boolean	yes	My setting changed state: true Shooting function status is “mySetting” and some my setting properties are changed. false Not changed.
_pluginRunning	boolean	no	Plugin running state: true running false stopped
_pluginWebServer	boolean	no	Plugin web server state: true running false stopped
_recordedTime	integer	yes	Shooting time of movie (seconds)
_recordableTime	integer	yes	Remaining time of movie (seconds)
_storageID	string	no	Storage ID. Theta X only
storageUri	string	yes	Storage URL
_apiVersion	const	no	API version. 2 means v2.1

_batterylnsert

	Definitions
Type	`boolean`

Description: Is a battery inserted or not. Theta X only.

batteryLevel

	Definitions
Type	`number`

Description: Battery level from 0.0 to 1.0.
When using an external power source, 1.0

	Restrictions
Minimum	≥ 0
Maximum	≤ 1

_batteryState

	Definitions
Type	`enum (of string)`

Description: Charging state:

charging: On charge
charged: Charging completed
disconnect: Not charging

Must be one of:

“charging”
“charged”
“disconnect”

_batteryTemp

	Definitions
Type	`integer`

Description: Current temperature inside the battery in degree Celsius

	Restrictions
Minimum	≥ -10
Maximum	≤ 100

_boardTemp

	Definitions
Type	`integer`

Description: Current temperature inside the camera in degree Celsius

	Restrictions
Minimum	≥ -10
Maximum	≤ 100

_cameraError

	Definitions
Type	`array of enum (of string)`

Description: Current error information of Theta

	Array restrictions
Min items	0
Max items	N/A

Each item of this array must be	Description
_cameraError items	Error code. See _cameraError descriptions for the meaning.

_cameraError items

	Definitions
Type	`enum (of string)`

Description: Error code. See _cameraError descriptions for the meaning.

Must be one of:

“BATTERY_CHARGE_FAIL”
“BATTERY_HIGH_TEMPERATURE”
“CANNOT_RECORDING”
“CANNOT_RECORD_LOWBAT”
“CAPTURE_HW_FAILED”
“CAPTURE_SW_FAILED”
“ELECTRONIC_COMPASS_CALIBRATION”
“FILE_NUMBER_OVER”
“HIGH_TEMPERATURE”
“HIGH_TEMPERATURE_WARNING”
“INTERNAL_MEM_ACCESS_FAIL”
“INVALID_FILE”
“IN_PROGRESS_ERROR”
“MEDIA_NOT_READY”
“NOT_ENOUGH_BATTERY”
“NOT_SUPPORTED_FILE_SYSTEM”
“NOT_SUPPORTED_MEDIA_TYPE”
“NO_DATE_SETTING”
“NO_MEMORY”
“PLUGIN_BOOT_ERROR”
“READ_ERROR”
“UNEXPECTED_ERROR”

_capturedPictures

	Definitions
Type	`integer`

Description: Number of still images captured during continuous shooting

	Restrictions
Minimum	≥ 0

_captureStatus

	Definitions
Type	`enum (of string)`

Description: Continuously shoots state:

bracket shooting: Performing multi bracket shooting
continuous shooting: Performing continuous shooting. Theta X only
converting: Converting post file
idle: In standby
retrospective image recording: Waiting for retrospective video. Theta X only
self-timer countdown: Self-timer is operating
timeShift shooting: Performing time shift shooting

Must be one of:

“bracket shooting”
“continuous shooting”
“converting”
“idle”
“retrospective image recording”
“self-timer countdown”
“shooting”
“timeShift shooting”

_compositeShootingElapsedTime

	Definitions
Type	`integer`

Description: Elapsed time for interval composite shooting (seconds). Theta Z1 only

	Restrictions
Minimum	≥ 0

_currentMicrophone

	Definitions
Type	`enum (of string)`

Description: Identifies the microphone used while recording video when _microphone option is set to “AUTO”. Theta X only.

Internal: Use the built-in microphone
External: Use the external microphone

Must be one of:

“Internal”
“External”

_currentStorage

	Definitions
Type	`enum (of string)`

Description: Theta X only.

IN: Record to internal memory
SD: Record to SD card

Must be one of:

“IN”
“SD”

_externalGpsInfo

	Definitions
Type	`object`

Description: Location data is obtained through an external device using WebAPI or BLE-API.

Property	Type	Required	Description
gpsInfo	object	no	GPS location information

gpsInfo

	Definitions
Type	`object`

Description: GPS location information

Property	Type	Required	Description
lat	number	yes	Latitude from -90 to 90. Exceptional value 65535 means GPS is disable.
lng	number	yes	Longitude from -180 to 180. Exceptional value 65535 means GPS is disable.
_altitude	number	yes	Altitude If GPS is disabled, then 0
_dateTimeZone	string	yes	Date, time and time zone If GPS is disabled, then empty string
_datum	string	yes	Geodetic reference If GPS is disabled, then empty string

lat

	Definitions
Type	`number`

Description: Latitude from -90 to 90. Exceptional value 65535 means GPS is disable.

	Restrictions
Minimum	≥ -90
Maximum	≤ 90

lng

	Definitions
Type	`number`

Description: Longitude from -180 to 180. Exceptional value 65535 means GPS is disable.

	Restrictions
Minimum	≥ -180
Maximum	≤ 180

_altitude

	Definitions
Type	`number`

Description: Altitude
If GPS is disabled, then 0

_dateTimeZone

	Definitions
Type	`string`

Description: Date, time and time zone
If GPS is disabled, then empty string

Restrictions
Must match regular expression	`([0-9]{4}:[0-9]{2}:[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}[+-][0-9]{2}:[0-9]{2})\|(^$)` Test

_datum

	Definitions
Type	`string`

Description: Geodetic reference
If GPS is disabled, then empty string

_function

	Definitions
Type	`enum (of string)`

Description: Shooting function status:

normal: Normal shooting function
mySetting: My setting shooting function
selfTimer: Self-timer shooting function. Theta Z1 only

Must be one of:

“normal”
“mySetting”
“selfTimer”

_internalGpsInfo

	Definitions
Type	`object`

Description: Location data is obtained through an internal GPS module.

Property	Type	Required	Description
gpsInfo	object	no	GPS location information

gpsInfo

	Definitions
Type	`object`
Same definition as	gpsInfo

Description: GPS location information

_latestFileUrl

	Definitions
Type	`string`

Description: URL of the last saved file.
In the case of Theta Z1, DNG format files are not displayed except for burst shooting.

_mySettingChanged

	Definitions
Type	`boolean`

Description: My setting changed state:

true: Shooting function status is “mySetting” and some my setting properties are changed.
false: Not changed.

_pluginRunning

	Definitions
Type	`boolean`

Description: Plugin running state:

true: running
false: stopped

_pluginWebServer

	Definitions
Type	`boolean`

Description: Plugin web server state:

true: running
false: stopped

_recordedTime

	Definitions
Type	`integer`

Description: Shooting time of movie (seconds)

	Restrictions
Minimum	≥ 0

_recordableTime

	Definitions
Type	`integer`

Description: Remaining time of movie (seconds)

	Restrictions
Minimum	≥ 0

_storageID

	Definitions
Type	`string`

Description: Storage ID. Theta X only

storageUri

	Definitions
Type	`string`

Description: Storage URL

_apiVersion

	Definitions
Type	`const`

Description: API version. 2 means v2.1

Specific value: 2