API reference - Ricoh Theta

camera.listFiles command response on successful completion

	Definitions
Type	`object`

Examples:

{
    "results": {
        "entries": [
            {
                "dateTime": "2024:04:25 08:14:34",
                "_favorite": false,
                "fileUrl": "http://192.168.1.10/files/100RICOH/R0010208.MP4",
                "isProcessed": true,
                "name": "R0010208.MP4",
                "previewUrl": "",
                "size": 6184693
            },
            {
                "dateTime": "2024:04:25 08:14:21",
                "_favorite": false,
                "fileUrl": "http://192.168.1.10/files/100RICOH/R0010207.JPG",
                "isProcessed": true,
                "name": "R0010207.JPG",
                "previewUrl": "",
                "size": 4522102
            }
        ],
        "totalEntries": 201
    },
    "name": "camera.listFiles",
    "state": "done"
}

{
    "results": {
        "entries": [
            {
                "_codec": "H.264/MPEG-4 AVC",
                "dateTimeZone": "2024:04:25 08:14:34+09:00",
                "_favorite": false,
                "fileUrl": "http://192.168.1.10/files/100RICOH/R0010208.MP4",
                "_frameRate": 30,
                "height": 960,
                "_imageDescription": "",
                "isProcessed": true,
                "lat": 35.012345678901234,
                "lng": 135.012345,
                "name": "R0010208.MP4",
                "previewUrl": "",
                "_projectionType": "Equirectangular",
                "_recordTime": 3,
                "size": 6184693,
                "_storageID": "412176649172527ab3d5edabb50a7d69",
                "_thumbSize": 9726,
                "width": 1920
            },
            {
                "dateTimeZone": "2024:04:25 08:14:21+09:00",
                "_favorite": false,
                "fileUrl": "http://192.168.1.10/files/100RICOH/R0010207.JPG",
                "height": 2752,
                "_imageDescription": "",
                "isProcessed": true,
                "lat": 35.01234567890123,
                "lng": 135.01234567890123,
                "name": "R0010207.JPG",
                "previewUrl": "",
                "_projectionType": "Equirectangular",
                "size": 4522102,
                "_storageID": "412176649172527ab3d5edabb50a7d69",
                "_thumbSize": 3182,
                "width": 5504
            }
        ],
        "totalEntries": 201
    },
    "name": "camera.listFiles",
    "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.listFiles"

state

	Definitions
Type	`const`

Description: Command execution status

Specific value: "done"

results

	Definitions
Type	`object`

Property	Type	Required	Description
totalEntries	integer	yes	Number of still image files and movie files stored in Theta.
entries	array	yes	A list of file properties.

totalEntries

	Definitions
Type	`integer`

Description: Number of still image files and movie files stored in Theta.

	Restrictions
Minimum	≥ 0

entries

	Definitions
Type	`array`

Description: A list of file properties.

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

Each item of this array must be	Description
entry	Properties of a file

entry

	Definitions
Type	`object`

Description: Properties of a file

Property	Type	Required	Description
name	string	yes	File name
fileUrl	string	yes	File URL. You can get a file by HTTP GET. To acquire a thumnail file, concatenate the URL with “?type=thumb”.
size	integer	yes	File sizes (bytes)
dateTime	string	no	File creation or update time. Local time. Can be acquired when “_detail” parameter is “false”.
dateTimeZone	string	no	File creation or update time with the time zone. Can be acquired when “_detail” parameter is “true”.
isProcessed	boolean	yes	Whether image processing has been completed.
previewUrl	string	yes	URL of the file being processed.
_favorite	boolean	no	Favorite or not. Theta X only
lat	number	no	Latitude. Can be obtained for data shot with GPS enabled. Can be acquired when “_detail” parameter is “true”.
lng	number	no	Longitude. Can be obtained for data shot with GPS enabled. Can be acquired when “_detail” parameter is “true”.
width	integer	no	Horizontal size of image (pixels). Can be acquired when “_detail” parameter is “true”.
height	integer	no	Vertical size of image (pixels). Can be acquired when “_detail” parameter is “true”.
thumbnail	string	no	Base64 encoded string for thumbnail image. Can be acquired when “_detail” parameter is “true” and “maxThumbSize” parameter is 640.
_thumbSize	integer	no	Thumbnail file size (bytes)
_intervalCaptureGroupId	string	no	Group ID of a still image shot by interval shooting. Can be obtained if a still image was shot by interval shooting. Can be acquired when “_detail” parameter is “true”.
_compositeShootingGroupId	string	no	Group ID of a still image shot by interval composite shooting. Can be obtained if a still image was shot by interval composite shooting. Can be acquired when “_detail” parameter is “true”.
_autoBracketGroupId	string	no	Group ID of a still image shot by multi bracket shooting. Can be obtained if a still image was shot by multi bracket shooting. Can be acquired when “_detail” parameter is “true”.
_continuousShootingGroupId	string	no	Group ID of a still image shot by continuous shooting. Can be obtained if a still image was shot by continuous shooting. Can be acquired when “_detail” parameter is “true”.
_recordTime	integer	no	Video shooting time (seconds). Can be obtained for a movie file. Can be acquired when “_detail” parameter is “true”.
_codec	enum (of string)	no	Codec of the movie file. Can be acquired when “_detail” parameter is “true”.
_projectionType	enum (of string)	no	Projection type of movie file. Can be acquired when “_detail” parameter is “true”. “Equirectangular” Stitched 360-degree image “Dual-Fisheye” Two fisheye images side by side “Fisheye” One fisheye image
_frameRate	integer	no	Frame rate. Can be acquired when “_detail” parameter is “true”.
_imageDescription	string	no	Image description. Can be acquired when “_detail” parameter is “true”.
_storageID	string	no	Storage ID. Can be acquired when “_detail” parameter is “true”.

name

	Definitions
Type	`string`

Description: File name

fileUrl

	Definitions
Type	`string`

Description: File URL. You can get a file by HTTP GET. To acquire a thumnail file, concatenate the URL with “?type=thumb”.

size

	Definitions
Type	`integer`

Description: File sizes (bytes)

	Restrictions
Minimum	≥ 0

dateTime

	Definitions
Type	`string`

Description: File creation or update time. Local time. Can be acquired when “_detail” parameter is “false”.

Restrictions
Must match regular expression	`[0-9]{4}:[0-9]{2}:[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}` Test

dateTimeZone

	Definitions
Type	`string`

Description: File creation or update time with the time zone. Can be acquired when “_detail” parameter is “true”.

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

isProcessed

	Definitions
Type	`boolean`

Description: Whether image processing has been completed.

previewUrl

	Definitions
Type	`string`

Description: URL of the file being processed.

_favorite

	Definitions
Type	`boolean`

Description: Favorite or not. Theta X only

lat

	Definitions
Type	`number`

Description: Latitude. Can be obtained for data shot with GPS enabled. Can be acquired when “_detail” parameter is “true”.

	Restrictions
Minimum	≥ -90
Maximum	≤ 90

lng

	Definitions
Type	`number`

Description: Longitude. Can be obtained for data shot with GPS enabled. Can be acquired when “_detail” parameter is “true”.

	Restrictions
Minimum	≥ -180
Maximum	≤ 180

width

	Definitions
Type	`integer`

Description: Horizontal size of image (pixels). Can be acquired when “_detail” parameter is “true”.

	Restrictions
Minimum	≥ 0

height

	Definitions
Type	`integer`

Description: Vertical size of image (pixels). Can be acquired when “_detail” parameter is “true”.

	Restrictions
Minimum	≥ 0

thumbnail

	Definitions
Type	`string`

Description: Base64 encoded string for thumbnail image. Can be acquired when “_detail” parameter is “true” and “maxThumbSize” parameter is 640.

_thumbSize

	Definitions
Type	`integer`

Description: Thumbnail file size (bytes)

	Restrictions
Minimum	≥ 0

_intervalCaptureGroupId

	Definitions
Type	`string`

Description: Group ID of a still image shot by interval shooting. Can be obtained if a still image was shot by interval shooting. Can be acquired when “_detail” parameter is “true”.

_compositeShootingGroupId

	Definitions
Type	`string`

Description: Group ID of a still image shot by interval composite shooting. Can be obtained if a still image was shot by interval composite shooting. Can be acquired when “_detail” parameter is “true”.

_autoBracketGroupId

	Definitions
Type	`string`

Description: Group ID of a still image shot by multi bracket shooting. Can be obtained if a still image was shot by multi bracket shooting. Can be acquired when “_detail” parameter is “true”.

_continuousShootingGroupId

	Definitions
Type	`string`

Description: Group ID of a still image shot by continuous shooting. Can be obtained if a still image was shot by continuous shooting. Can be acquired when “_detail” parameter is “true”.

_recordTime

	Definitions
Type	`integer`

Description: Video shooting time (seconds). Can be obtained for a movie file. Can be acquired when “_detail” parameter is “true”.

	Restrictions
Minimum	≥ 0

_codec

	Definitions
Type	`enum (of string)`

Description: Codec of the movie file. Can be acquired when “_detail” parameter is “true”.

Must be one of:

“H.264/MPEG-4 AVC”

_projectionType

	Definitions
Type	`enum (of string)`

Description: Projection type of movie file. Can be acquired when “_detail” parameter is “true”.

“Equirectangular”: Stitched 360-degree image
“Dual-Fisheye”: Two fisheye images side by side
“Fisheye”: One fisheye image

Must be one of:

“Equirectangular”
“Dual-Fisheye”
“Fisheye”

_frameRate

	Definitions
Type	`integer`

Description: Frame rate. Can be acquired when “_detail” parameter is “true”.

	Restrictions
Minimum	≥ 0

_imageDescription

	Definitions
Type	`string`

Description: Image description. Can be acquired when “_detail” parameter is “true”.

_storageID

	Definitions
Type	`string`

Description: Storage ID. Can be acquired when “_detail” parameter is “true”.