theta-client/com.ricoh360.thetaclient/ThetaRepository

ThetaRepository

class ThetaRepository

Repository to handle Theta web APIs.

Parameters

config

Configuration of initialize. If null, get from THETA.

timeout

Timeout of HTTP call.

Types

AccessPoint

data class AccessPoint(val ssid: String, val ssidStealth: Boolean, val authMode: ThetaRepository.AuthModeEnum, val connectionPriority: Int = 1, val usingDhcp: Boolean, val ipAddress: String?, val subnetMask: String?, val defaultGateway: String?, val proxy: ThetaRepository.Proxy?)

Access point information.

ApertureEnum

enum ApertureEnum : Enum<ThetaRepository.ApertureEnum>

Aperture value.

ArgumentException

class ArgumentException(message: String) : ThetaRepository.ThetaRepositoryException

Thrown if the argument wrong.

AuthModeEnum

enum AuthModeEnum : Enum<ThetaRepository.AuthModeEnum>

Enum for authentication mode.

BluetoothPowerEnum

enum BluetoothPowerEnum : Enum<ThetaRepository.BluetoothPowerEnum>

bluetooth power.

CameraControlSourceEnum

enum CameraControlSourceEnum : Enum<ThetaRepository.CameraControlSourceEnum>

camera control source Sets whether to lock/unlock the camera UI. The current setting can be acquired by camera.getOptions, and it can be changed by camera.setOptions.

CameraErrorEnum

enum CameraErrorEnum : Enum<ThetaRepository.CameraErrorEnum>

Camera error

CameraModeEnum

enum CameraModeEnum : Enum<ThetaRepository.CameraModeEnum>

Camera mode. The current setting can be acquired by camera.getOptions, and it can be changed by camera.setOptions.

CaptureModeEnum

enum CaptureModeEnum : Enum<ThetaRepository.CaptureModeEnum>

Shooting mode.

CaptureStatusEnum

enum CaptureStatusEnum : Enum<ThetaRepository.CaptureStatusEnum>

Capture Status

ChargingStateEnum

enum ChargingStateEnum : Enum<ThetaRepository.ChargingStateEnum>

Battery charging state

Companion

object Companion

Config

data class Config(var dateTime: String? = null, var language: ThetaRepository.LanguageEnum? = null, var offDelay: ThetaRepository.OffDelay? = null, var sleepDelay: ThetaRepository.SleepDelay? = null, var shutterVolume: Int? = null, var clientMode: DigestAuth? = null)

Configuration of THETA

Exif

data class Exif(val exifVersion: String, val dateTime: String, val imageWidth: Int?, val imageLength: Int?, val gpsLatitude: Double?, val gpsLongitude: Double?)

Exif metadata of a still image.

ExposureCompensationEnum

enum ExposureCompensationEnum : Enum<ThetaRepository.ExposureCompensationEnum>

Exposure compensation (EV).

ExposureDelayEnum

enum ExposureDelayEnum : Enum<ThetaRepository.ExposureDelayEnum>

Operating time (sec.) of the self-timer.

ExposureProgramEnum

enum ExposureProgramEnum : Enum<ThetaRepository.ExposureProgramEnum>

Exposure program. The exposure settings that take priority can be selected.

FileFormatEnum

enum FileFormatEnum : Enum<ThetaRepository.FileFormatEnum>

File format used in shooting.

FileFormatTypeEnum

enum FileFormatTypeEnum : Enum<ThetaRepository.FileFormatTypeEnum>

FileInfo

data class FileInfo(val name: String, val size: Long, val dateTime: String, val fileUrl: String, val thumbnailUrl: String, val storageID: String?)

File information in Theta.

FileTypeEnum

enum FileTypeEnum : Enum<ThetaRepository.FileTypeEnum>

File type in Theta.

FilterEnum

enum FilterEnum : Enum<ThetaRepository.FilterEnum>

Image processing filter.

GpsInfo

data class GpsInfo(val latitude: Float, val longitude: Float, val altitude: Float, val dateTimeZone: String)

GPS information

GpsTagRecordingEnum

enum GpsTagRecordingEnum : Enum<ThetaRepository.GpsTagRecordingEnum>

Turns position information assigning ON/OFF.

IsoAutoHighLimitEnum

enum IsoAutoHighLimitEnum : Enum<ThetaRepository.IsoAutoHighLimitEnum>

ISO sensitivity upper limit when ISO sensitivity is set to automatic.

IsoEnum

enum IsoEnum : Enum<ThetaRepository.IsoEnum>

ISO sensitivity.

LanguageEnum

enum LanguageEnum : Enum<ThetaRepository.LanguageEnum>

Language used in camera OS.

MaxRecordableTimeEnum

enum MaxRecordableTimeEnum : Enum<ThetaRepository.MaxRecordableTimeEnum>

Maximum recordable time (in seconds) of the camera

MicrophoneOptionEnum

enum MicrophoneOptionEnum : Enum<ThetaRepository.MicrophoneOptionEnum>

Microphone option

NetworkTypeEnum

enum NetworkTypeEnum : Enum<ThetaRepository.NetworkTypeEnum>

Network type supported by Theta V, Z1 and X.

NotConnectedException

class NotConnectedException(message: String) : ThetaRepository.ThetaRepositoryException

Thrown if the mobile device doesn't connect to Theta.

OffDelay

interface OffDelay

Length of standby time before the camera automatically powers OFF.

OffDelayEnum

enum OffDelayEnum : Enum<ThetaRepository.OffDelayEnum> , ThetaRepository.OffDelay

Length of standby time before the camera automatically powers OFF.

OffDelaySec

class OffDelaySec(val sec: Int) : ThetaRepository.OffDelay

Length of standby time before the camera automatically powers OFF.

OptionNameEnum

enum OptionNameEnum : Enum<ThetaRepository.OptionNameEnum>

Camera setting options name. options name

Options

data class Options(var aperture: ThetaRepository.ApertureEnum? = null, var bluetoothPower: ThetaRepository.BluetoothPowerEnum? = null, var cameraControlSource: ThetaRepository.CameraControlSourceEnum? = null, var cameraMode: ThetaRepository.CameraModeEnum? = null, var captureMode: ThetaRepository.CaptureModeEnum? = null, var colorTemperature: Int? = null, var dateTimeZone: String? = null, var exposureCompensation: ThetaRepository.ExposureCompensationEnum? = null, var exposureDelay: ThetaRepository.ExposureDelayEnum? = null, var exposureProgram: ThetaRepository.ExposureProgramEnum? = null, var fileFormat: ThetaRepository.FileFormatEnum? = null, var filter: ThetaRepository.FilterEnum? = null, var gpsInfo: ThetaRepository.GpsInfo? = null, var isGpsOn: Boolean? = null, var iso: ThetaRepository.IsoEnum? = null, var isoAutoHighLimit: ThetaRepository.IsoAutoHighLimitEnum? = null, var language: ThetaRepository.LanguageEnum? = null, var maxRecordableTime: ThetaRepository.MaxRecordableTimeEnum? = null, var networkType: ThetaRepository.NetworkTypeEnum? = null, var offDelay: ThetaRepository.OffDelay? = null, var password: String? = null, var powerSaving: ThetaRepository.PowerSavingEnum? = null, var previewFormat: ThetaRepository.PreviewFormatEnum? = null, var proxy: ThetaRepository.Proxy? = null, var remainingPictures: Int? = null, var remainingVideoSeconds: Int? = null, var remainingSpace: Long? = null, var shootingMethod: ThetaRepository.ShootingMethodEnum? = null, var shutterSpeed: ThetaRepository.ShutterSpeedEnum? = null, var sleepDelay: ThetaRepository.SleepDelay? = null, var timeShift: ThetaRepository.TimeShiftSetting? = null, var totalSpace: Long? = null, var shutterVolume: Int? = null, var username: String? = null, var whiteBalance: ThetaRepository.WhiteBalanceEnum? = null, var whiteBalanceAutoStrength: ThetaRepository.WhiteBalanceAutoStrengthEnum? = null, var wlanFrequency: ThetaRepository.WlanFrequencyEnum? = null)

Camera setting options. Refer to the options category

PhotoFileFormatEnum

enum PhotoFileFormatEnum : Enum<ThetaRepository.PhotoFileFormatEnum>

Photo image format used in PhotoCapture.

PluginInfo

data class PluginInfo(val name: String, val packageName: String, val version: String, val isPreInstalled: Boolean, val isRunning: Boolean, val isForeground: Boolean, val isBoot: Boolean, val hasWebServer: Boolean, val exitStatus: String, val message: String)

Plugin information

PowerSavingEnum

enum PowerSavingEnum : Enum<ThetaRepository.PowerSavingEnum>

Power saving mode

PreviewFormatEnum

enum PreviewFormatEnum : Enum<ThetaRepository.PreviewFormatEnum>

Format of live view

Proxy

data class Proxy(val use: Boolean, val url: String? = null, val port: Int? = null, val userid: String? = null, val password: String? = null)

Proxy information to be used when wired LAN is enabled.

ShootingFunctionEnum

enum ShootingFunctionEnum : Enum<ThetaRepository.ShootingFunctionEnum>

Shooting function status

ShootingMethodEnum

enum ShootingMethodEnum : Enum<ThetaRepository.ShootingMethodEnum>

Shooting method

ShutterSpeedEnum

enum ShutterSpeedEnum : Enum<ThetaRepository.ShutterSpeedEnum>

Shutter speed (sec).

SleepDelay

interface SleepDelay

Length of standby time before the camera enters the sleep mode.

SleepDelayEnum

enum SleepDelayEnum : Enum<ThetaRepository.SleepDelayEnum> , ThetaRepository.SleepDelay

Length of standby time before the camera enters the sleep mode.

SleepDelaySec

class SleepDelaySec(val sec: Int) : ThetaRepository.SleepDelay

Length of standby time before the camera enters the sleep mode.

StorageEnum

enum StorageEnum : Enum<ThetaRepository.StorageEnum>

Specifies the storage

ThetaFiles

data class ThetaFiles(val fileList: List<ThetaRepository.FileInfo>, val totalEntries: Int)

Data about files in Theta.

ThetaInfo

data class ThetaInfo(val manufacturer: String, val model: String, val serialNumber: String, val wlanMacAddress: String?, val bluetoothMacAddress: String?, val firmwareVersion: String, val supportUrl: String, val hasGps: Boolean, val hasGyro: Boolean, val uptime: Int, val api: List<String>, val endpoints: EndPoint, val apiLevel: List<Int>)

Static attributes of Theta.

ThetaModel

enum ThetaModel : Enum<ThetaRepository.ThetaModel>

Support THETA model

ThetaRepositoryException

abstract class ThetaRepositoryException(message: String) : RuntimeException

Base exception of ThetaRepository

ThetaState

data class ThetaState(val fingerprint: String, val batteryLevel: Float, val storageUri: String?, val storageID: String?, val captureStatus: ThetaRepository.CaptureStatusEnum, val recordedTime: Int, val recordableTime: Int, val capturedPictures: Int?, val compositeShootingElapsedTime: Int?, val latestFileUrl: String, val chargingState: ThetaRepository.ChargingStateEnum, val apiVersion: Int, val isPluginRunning: Boolean?, val isPluginWebServer: Boolean?, val function: ThetaRepository.ShootingFunctionEnum?, val isMySettingChanged: Boolean?, val currentMicrophone: ThetaRepository.MicrophoneOptionEnum?, val isSdCard: Boolean, val cameraError: List<ThetaRepository.CameraErrorEnum>?, val isBatteryInsert: Boolean?)

Mutable values representing Theta status.

ThetaUnauthorizedException

class ThetaUnauthorizedException(message: String) : ThetaRepository.ThetaRepositoryException

Thrown if an authentication　error occurs in client mode.

ThetaWebApiException

class ThetaWebApiException(message: String) : ThetaRepository.ThetaRepositoryException

Thrown if an error occurs on Theta Web API.

Timeout

data class Timeout(val connectTimeout: Long, val requestTimeout: Long, val socketTimeout: Long)

Timeout of HTTP call.

TimeShiftIntervalEnum

enum TimeShiftIntervalEnum : Enum<ThetaRepository.TimeShiftIntervalEnum>

Time shift interval

TimeShiftSetting

data class TimeShiftSetting(var isFrontFirst: Boolean? = null, var firstInterval: ThetaRepository.TimeShiftIntervalEnum? = null, var secondInterval: ThetaRepository.TimeShiftIntervalEnum? = null)

Time shift shooting

VideoFileFormatEnum

enum VideoFileFormatEnum : Enum<ThetaRepository.VideoFileFormatEnum>

Video image format used in VideoCapture.

WhiteBalanceAutoStrengthEnum

enum WhiteBalanceAutoStrengthEnum : Enum<ThetaRepository.WhiteBalanceAutoStrengthEnum>

White balance auto strength

WhiteBalanceEnum

enum WhiteBalanceEnum : Enum<ThetaRepository.WhiteBalanceEnum>

White balance.

WlanFrequencyEnum

enum WlanFrequencyEnum : Enum<ThetaRepository.WlanFrequencyEnum>

Wireless LAN frequency of the camera supported by Theta V, Z1 and X.

Xmp

data class Xmp(val poseHeadingDegrees: Double?, val fullPanoWidthPixels: Int, val fullPanoHeightPixels: Int)

Photo sphere XMP metadata of a still image.

Properties

cameraModel

var cameraModel: String?

Camera model.

endpoint

val endpoint: String

URL of Theta web API endpoint.

Functions

cancelVideoConvert

suspend fun cancelVideoConvert()

Cancels the movie format conversion.

convertVideoFormats

suspend fun convertVideoFormats(fileUrl: String, toLowResolution: Boolean, applyTopBottomCorrection: Boolean = true): String

Converts the movie format of a saved movie.

deleteAccessPoint

suspend fun deleteAccessPoint(ssid: String)

Deletes access point information used in client mode. Only the access points registered with setAccessPoint can be deleted.

deleteAllFiles

suspend fun deleteAllFiles()

Delete all files in Theta.

deleteAllImageFiles

suspend fun deleteAllImageFiles()

Delete all image files in Theta.

deleteAllVideoFiles

suspend fun deleteAllVideoFiles()

Delete all video files in Theta.

deleteFiles

suspend fun deleteFiles(fileUrls: List<String>)

Delete files in Theta.

deleteMySetting

suspend fun deleteMySetting(captureMode: ThetaRepository.CaptureModeEnum)

Delete shooting conditions in My Settings. Supported just by Theta X and Z1.

finishWlan

suspend fun finishWlan()

Turns the wireless LAN off.

getLivePreview

fun getLivePreview(): Flow<ByteReadPacket>

suspend fun getLivePreview(frameHandler: suspend (Pair<ByteArray, Int>) -> Boolean)

Start live preview as motion JPEG.

getMetadata

suspend fun getMetadata(fileUrl: String): Pair<ThetaRepository.Exif, ThetaRepository.Xmp>

Get metadata of a still image

getMySetting

suspend fun getMySetting(captureMode: ThetaRepository.CaptureModeEnum): ThetaRepository.Options

Acquires the shooting properties set by the camera._setMySetting command. Just for Theta V and later.

suspend fun getMySetting(optionNames: List<ThetaRepository.OptionNameEnum>): ThetaRepository.Options

Acquires the shooting properties set by the camera._setMySetting command. Just for Theta S and SC.

getOptions

suspend fun getOptions(optionNames: List<ThetaRepository.OptionNameEnum>): ThetaRepository.Options

Acquires the properties and property support specifications for shooting, the camera, etc.

getPhotoCaptureBuilder

fun getPhotoCaptureBuilder(): PhotoCapture.Builder

Get PhotoCapture.Builder for take a picture.

getPluginLicense

suspend fun getPluginLicense(packageName: String): String

Acquires the license for the installed plugin

getPluginOrders

suspend fun getPluginOrders(): List<String>

Return the plugin orders. Supported just by Theta X and Z1.

getThetaInfo

suspend fun getThetaInfo(): ThetaRepository.ThetaInfo

Get basic information about Theta.

getThetaState

suspend fun getThetaState(): ThetaRepository.ThetaState

Get current state of Theta.

getTimeShiftCaptureBuilder

fun getTimeShiftCaptureBuilder(): TimeShiftCapture.Builder

Get TimeShiftCapture.Builder for time-shift.

getVideoCaptureBuilder

fun getVideoCaptureBuilder(): VideoCapture.Builder

Get PhotoCapture.Builder for capture video.

listAccessPoints

suspend fun listAccessPoints(): List<ThetaRepository.AccessPoint>

Acquires the access point list used in client mode.

listFiles

suspend fun listFiles(fileType: ThetaRepository.FileTypeEnum, startPosition: Int = 0, entryCount: Int): ThetaRepository.ThetaFiles

suspend fun listFiles(fileType: ThetaRepository.FileTypeEnum, startPosition: Int = 0, entryCount: Int, storage: ThetaRepository.StorageEnum? = null): ThetaRepository.ThetaFiles

Acquires a list of still image files and movie files.

listPlugins

suspend fun listPlugins(): List<ThetaRepository.PluginInfo>

Acquires a list of installed plugins. Supported just by Theta X, Z1 and V.

reset

suspend fun reset()

Reset all device settings and capture settings. After reset, the camera will be restarted.

restoreSettings

suspend fun restoreSettings()

Restore setting to THETA

setAccessPointDynamically

suspend fun setAccessPointDynamically(ssid: String, ssidStealth: Boolean = false, authMode: ThetaRepository.AuthModeEnum = AuthModeEnum.NONE, password: String = "", connectionPriority: Int = 1, proxy: ThetaRepository.Proxy? = null)

Set access point. IP address is set dynamically.

setAccessPointStatically

suspend fun setAccessPointStatically(ssid: String, ssidStealth: Boolean = false, authMode: ThetaRepository.AuthModeEnum = AuthModeEnum.NONE, password: String? = null, connectionPriority: Int = 1, ipAddress: String, subnetMask: String, defaultGateway: String, proxy: ThetaRepository.Proxy? = null)

Set access point. IP address is set statically.

setBluetoothDevice

suspend fun setBluetoothDevice(uuid: String): String

Registers identification information (UUID) of a BLE device (Smartphone application) connected to the camera. UUID can be set while the wireless LAN function of the camera is placed in the direct mode.

setMySetting