API reference - Ricoh Theta

camera.listFiles command request

	Definitions
Type	`object`

Example:

{
    "name": "camera.listFiles",
    "parameters": {
        "fileType": "all",
        "entryCount": 20,
        "maxThumbSize": 0,
        "_detail": false
    }
}

Property	Type	Required	Description
name	const	yes	Command to execute
parameters	object	yes	-

name

	Definitions
Type	`const`

Description: Command to execute

Specific value: "camera.listFiles"

parameters

	Definitions
Type	`object`

Property	Type	Required	Description
fileType	enum (of string)	yes	File types to acquire. all All types image Still image video Movie
startPosition	integer	no	Position to start acquiring the file list. If a number larger than the position of the last file is specified, a null list is acquired. Default is the top of the list.
_startFileUrl	string	no	First file to return to the list. The list is acquired starting from the specified file position.
entryCount	integer	yes	Number of files to acquire. If the number of existing files is smaller than the specified number of files, all available files are acquired.
maxThumbSize	enum (of integer)	yes	Maximum size of thumbnail images. Be sure to specify this parameter regardless of the value of `_detail` parameter. 0 Do not acquire thumbnail. 640 Acquire thumbnail.
_detail	boolean	no	Specifies whether to acquire the file details. If set to false, following properties can only be acquired. name fileUrl size dateTime isProcessed previewUrl _favorite
_sort	enum (of string)	no	Specifies the sort order. newest Descending order of the shooting date and time oldest Ascending order of the shooting date and time
_storage	enum (of string)	no	Specifies the storage. Theta X only. IN internal storage SD external storage (SD card) Default current storage

fileType

	Definitions
Type	`enum (of string)`

Description: File types to acquire.

all: All types
image: Still image
video: Movie

Must be one of:

“all”
“image”
“video”

startPosition

	Definitions
Type	`integer`
Default	`0`

Description: Position to start acquiring the file list. If a number larger than the position of the last file is specified, a null list is acquired. Default is the top of the list.

	Restrictions
Minimum	≥ 0

_startFileUrl

	Definitions
Type	`string`

Description: First file to return to the list. The list is acquired starting from the specified file position.

entryCount

	Definitions
Type	`integer`

Description: Number of files to acquire. If the number of existing files is smaller than the specified number of files, all available files are acquired.

	Restrictions
Minimum	≥ 0

maxThumbSize

	Definitions
Type	`enum (of integer)`

Description: Maximum size of thumbnail images. Be sure to specify this parameter regardless of the value of _detail parameter.

0: Do not acquire thumbnail.
640: Acquire thumbnail.

Must be one of:

_detail

	Definitions
Type	`boolean`
Default	`true`

Description: Specifies whether to acquire the file details. If set to false, following properties can only be acquired.

name
fileUrl
size
dateTime
isProcessed
previewUrl
_favorite

_sort

	Definitions
Type	`enum (of string)`
Default	`"newest"`

Description: Specifies the sort order.

newest: Descending order of the shooting date and time
oldest: Ascending order of the shooting date and time

Must be one of:

“newest”
“oldest”

_storage

	Definitions
Type	`enum (of string)`
Default	`"Default"`

Description: Specifies the storage. Theta X only.

IN: internal storage
SD: external storage (SD card)
Default: current storage

Must be one of:

“IN”
“SD”
“Default”