JavaScript and RICOH THETA API

jcasman · May 18, 2023, 8:40pm

@erikrod1 and I are working on building a repo with many JavaScript examples to control RICOH THETA cameras through the WebAPI.

I personally am just learning JavaScript. This repo focuses on API commands for controlling THETAs.

If you want to try it, it’s here: GitHub - theta360developers/theta-javascript: Building JavaScript examples to control RICOH THETA cameras through the WebAPI

Coolness! You can test it without a THETA

There is a cloud API called fake-theta that allows you to test API commands without a THETA. We forked it and added some good THETA X test images.

I am using Node.js, so I can run JavaScript programs from the command line. I’m running version 18.15.0. I am on a MacBook Air, running Node.js from the Terminal. I connect directly to my THETA X by Wi-Fi.

Contributions or comments are welcome. Please try using it yourself.

Notes

If you do a Pull Request with a .js file, it must be runnable as-is.
Your JavaScript must use ES Modules. As of ES6 (ES2015), JavaScript supports a native module format called ES Modules, or ECMAScript Modules. This approach uses the export and import keywords, instead of the older CommonJS syntax of module.exports and require.
@erikrod1 and I will be adding more protocols, commands, and options from the THETA API to the repo, so if you don’t see what you’re looking for - well, first of all, feel free to add it yourself! - please ask or come back again soon and see what’s been added!

craig · May 18, 2023, 9:32pm

suggest you add sub-directories for commands specific to the X, Z1, and SC2.

See this issue assigned to you.

github.com/theta360developers/theta-javascript

organize sub-directories

opened 06:31PM - 10 May 23 UTC

codetricity

enhancement

top-level * fake-theta * real-theta * x - specific to x, like cameraControl…Source * sc2 * z1 Organize scripts into the same sub-directory system as the API documentation https://github.com/ricohapi/theta-api-specs/tree/main/theta-web-api-v2.1 if the file is blank, do something like ``` // TODO: erik ``` The folders under fake-theta and real-theta should be: * commands * options * protocols * examples Under protocols: * protocols * info.js * state.js under commands: * commands * listFiles.js * takePicture.js * getLivePreview.js under options * options * getOptions.js - put a good set of options here * setOffDelay.disable.js * setOffDelay.enable.js - set to default value * sleepDelay.disable.js * sleepDelay.enable.js - set to default value * videoStitching.js * captureMode.image.js * captureMode.video.js * examples * downloadImage.js - with known URL hardcoded * downloadLastImage.js

For example, for the THETA, there are two file formats for video that I was not aware of before.

github.com

ricohapi/theta-api-specs/blob/main/theta-web-api-v2.1/options/file_format.md

# fileFormat

### Overview

Image format used in shooting.

Can be acquired by [camera.getOptions](../commands/camera.get_options.md) and set by [camera.setOptions](../commands/camera.set_options.md).

### Support value

The supported value depends on the shooting mode ([captureMode](capture_mode.md)).

#### For RICOH THETA X or later

| Shooting mode | Supported value |
|:--|:--|
| image | {"type": "jpeg","width": 11008,"height": 5504}<br>{"type": "jpeg","width": 5504,"height": 2752} |
| video | {"type": "mp4","width": 7680,"height": 3840, "_codec": "H.264/MPEG-4 AVC", "_frameRate": 10}<br>{“type”: “mp4”,”width”: 7680,”height”: 3840, “_codec”: “H.264/MPEG-4 AVC”, “_frameRate”: 5}<br>{“type”: “mp4”,”width”: 7680,”height”: 3840, “_codec”: “H.264/MPEG-4 AVC”, “_frameRate”: 2}<br>{"type": "mp4","width": 5760,"height": 2880, "_codec": "H.264/MPEG-4 AVC", "_frameRate": 30}<br>{“type”: “mp4”,”width”: 5760,”height”: 2880, “_codec”: “H.264/MPEG-4 AVC”, “_frameRate”: 5}<br>{“type”: “mp4”,”width”: 5760,”height”: 2880, “_codec”: “H.264/MPEG-4 AVC”, “_frameRate”: 2}<br>{"type": "mp4","width": 3840,"height": 1920, "_codec": "H.264/MPEG-4 AVC", "_frameRate": 60}<br>{"type": "mp4","width": 3840,"height": 1920, "_codec": "H.264/MPEG-4 AVC", "_frameRate": 30}<br>{"type": "mp4","width": 1920,"height": 960, "_codec": "H.264/MPEG-4 AVC", "_frameRate": 60}<br>{"type": "mp4","width": 1920,"height": 960, "_codec": "H.264/MPEG-4 AVC", "_frameRate": 30} |
| \_liveStreaming | Not supported |

This file has been truncated. show original

“type”: “mp4”,”width”: 5760,”height”: 2880, “_codec”: “H.264/MPEG-4 AVC”, “_frameRate”: 5}
{“type”: “mp4”,”width”: 5760,”height”: 2880, “_codec”: “H.264/MPEG-4 AVC”, “_frameRate”: 2}

These files look like they may contain IMU data in CAMM format. Can you check?

Also, can you compare the file size to the 8K 2fps and 8K 5fps videos?

the preview format is also different.

github.com

ricohapi/theta-api-specs/blob/main/theta-web-api-v2.1/options/preview_format.md

# previewFormat

### Overview

Format of live view ([camera.getLivePreview](../commands/camera.get_live_preview.md)).

Can be acquired by [camera.getOptions](../commands/camera.get_options.md) and set by [camera.setOptions](../commands/camera.set_options.md).

### Support model

| X | Z1 | V | SC | S |
|:--|:--|:--|:--|:--|
| All | All | All | All | All |

### Support value

#### For RICOH THETA X

{"width": 1024, "height": 512, "framerate": 30}

This file has been truncated. show original

I’m put some of the commands from the repo you’re building into React Native Expo apps.

React Native Expo Super Beginner Intro with RICOH THETA API - No Camera Needed - Pt. 1

React Native Expo Beginner Tutorial with RICOH THETA Images - Pt. 2

jcasman · May 18, 2023, 9:32pm

Just adding X-specific, Z1-specific, and SC2-specific directors. So far, I’ve only put in _cameraControlSource in the X directory. This turns off the LCD while you’re controlling it with your mobile app. If you’re programming with an X, you should probably be using this option, which is set using camera.setOptions.

craig · May 18, 2023, 10:03pm

In the bitrate settings, the 2.00.0 firmware of the X has a lower bitrate setting. It would be good to test the save of the video file at different bitrates. This might be something that Erik could do.

github.com

ricohapi/theta-api-specs/blob/main/theta-web-api-v2.1/options/_bitrate.md

# \_bitrate

### Overview

Movie bit rate.

Can be acquired by [camera.getOptions](../commands/camera.get_options.md) and set by [camera.setOptions](../commands/camera.set_options.md).

### Support model

| X | Z1 | V | SC | S |
|:--|:--|:--|:--|:--|
| All | All | v2.50.1 or later | --- | --- |

### Support value

The supported value depends on the shooting mode ([captureMode](capture_mode.md)).

| Shooting mode | Supported value |
|:--|:--|

This file has been truncated. show original