camera.listFiles
Overview
Acquires a list of still image files and movie files.
Parameters
Name | Type | Description |
---|---|---|
fileType | String | File types to acquire (all: All types, image: Still image, video: Movie) |
startPosition | Integer | (Optional) Position to start acquiring the file list. If a number larger than the number of existing files is specified, a null list is acquired. Default is the top of the list. |
_startFileUrl | String | (Optional) First file to return to the list. The list is acquired starting from the specified file position. (RICOH THETA V or later) |
entryCount | Integer | Number of still image and movie files to acquire. If the number of existing files is smaller than the specified number of files, all available files are only acquired. Note that a thumbnail can be acquired for a single file only. |
maxThumbSize | Integer | Thumbnail (640: Acquire thumbnail, 0: Do not acquire thumbnail) Be sure to specify this parameter regardless of the value of _detail. |
_detail | Boolean | (Optional) Specifies whether or not to acquire the file details. Default is “true”. If set to “false”, “name”, “fileUrl”, “size”, and “dateTime” can only be acquired. |
_sort | String | (Optional) Specifies the sort order. Choose from “newest” (in the descending order of the shooting date/time) and “oldest” (in the ascending order of the shooting date/time). Default is “newest”. |
Results
Name | Type | Description |
---|---|---|
entries | Object | The list of still image files and movie files acquired. Refer to the next section for details. |
totalEntries | Integer | Number of still image files and movie files stored in the camera. |
entries object
Name | Type | Description |
---|---|---|
name | String | File name |
fileUrl | String | File URL |
size | Integer | File sizes (bytes) |
dateTimeZone | String | File creation or update time with the time zone. Can be acquired when “_detail” is “true”. |
dateTime | String | File creation or update time. Local time. Can be acquired when “_detail” is “false”. |
lat | Number | Latitude Can be obtained for data shot with GPS enabled. |
lng | Number | Longitude Can be obtained for data shot with GPS enabled. |
width | Integer | Horizontal size of image (pixels) |
height | Integer | Vertical size of image (pixels) |
thumbnail | String | Thumbnail Can be acquired if Base64- encoded maxThumbSize is enabled. |
_thumbSize | Integer | Thumbnail file size (bytes) Can be acquired if maxThumbSize is enabled. |
_intervalCaptureGroupId | String | Group ID of a still image shot by interval shooting. Can be obtained if a still image was shot by interval shooting. |
_compositeShootingGroupId | String | Group ID of a still image shot by interval composite shooting. Can be obtained if a still image was shot by interval composite shooting. (RICOH THETA Z1, RICOH THETA S firmware v01.82 or later and RICOH THETA SC firmware v1.10 or later) |
_autoBracketGroupId | String | Group ID of a still image shot by multi bracket shooting. Can be obtained if a still image was shot by multi bracket shooting. (RICOH THETA Z1, RICOH THETA V, RICOH THETA S firmware v01.82 or later and RICOH THETA SC firmware v1.10 or later) |
_recordTime | Integer | Video shooting time (sec) Can be obtained for a movie file. |
isProcessed | Boolean | Whether or not image processing has been completed. |
previewUrl | String | URL of the file being processed |
_codec | String | Codec “H.264/MPEG-4 AVC” (RICOH THETA V or later) |
_projectionType | String | Projection type of movie file “Equirectangular” or “Dual-Fisheye”. (RICOH THETA V or later) |
Restriction
Cannot be run while shooting a movie.
Example
Parameters
{
"fileType": "all",
"entryCount": 3,
"maxThumbSize": 640
}
Results
{
"entries": [
{
"name": "R0010017.JPG",
"fileUrl": "http://192.168.1.1/files/abcde/100RICOH/R0010017.JPG",
"size": 4051440,
"dateTimeZone": "2015:07:10 11:05:18+09:00",
"lat": 50.5324,
"lng": -120.2332,
"width": 5376,
"height": 2688,
"isProcessed": true,
"previewUrl": "",
"thumbnail": "(base64_binary)",
"_thumbSize": 3348,
}
],
"totalEntries": 16
}
Example (when “_detail” is “true” and thumbnail is not acquired)
Parameters
{
"fileType": "all",
"entryCount": 3,
"maxThumbSize": 0
}
Results
{
"entries": [
{
"name": "R0011607.JPG",
"fileUrl": "http://192.168.1.1/files/abcde/100RICOH/R0011607.JPG",
"size": 4051440,
"dateTimeZone": "2016:06:29 17:06:58+09:00",
"width": 5376,
"height": 2688,
"isProcessed": true,
"previewUrl": ""
},
{
"name": "R0011606.JPG",
"fileUrl": "http://192.168.1.1/files/abcde/100RICOH/R0011606.JPG",
"size": 4065630,
"dateTimeZone": "2016:06:29 16:58:47+09:00",
"width": 5376,
"height": 2688,
"isProcessed": true,
"previewUrl": ""
},
{
"name": "R0011605.JPG",
"fileUrl": "http://192.168.1.1/files/abcde/100RICOH/R0011605.JPG",
"size": 4057882,
"dateTimeZone": "2016:06:29 16:55:26+09:00",
"width": 5376,
"height": 2688,
"isProcessed": true,
"previewUrl": ""
}
],
"totalEntries": 30
}
Example (when “_detail” is “false”)
Parameters
{
"fileType": "all",
"entryCount": 3,
"maxThumbSize": 640,
"_detail": false
}
Results
{
"entries": [
{
"name": "R0010034.JPG",
"fileUrl": "http://192.168.1.1/files/abcde/100RICOH/R0010034.JPG",
"size": 4134436,
"dateTime": "2015:07:17 14:13:14"
},
{
"name": "R0010033.JPG",
"fileUrl": "http://192.168.1.1/files/abcde/100RICOH/R0010033.JPG",
"size": 4167440,
"dateTime": "2015:07:16 14:15:22"
},
{
"name": "R0010032.JPG",
"fileUrl": "http://192.168.1.1/files/abcde/100RICOH/R0010032.JPG",
"size": 4138995,
"dateTime": "2015:07:16 14:15:00"
}
],
"totalEntries": 34
}