theta-client/com.ricoh360.thetaclient.transferred

Package-level declarations

Types

enum _ProjectionType : Enum<_ProjectionType>

theta projection type

data class AccessPoint(val ssid: String, val ssidStealth: Boolean, val security: AuthenticationMode, val connectionPriority: Int, val ipAddressAllocation: IpAddressAllocation, val ipAddress: String?, val subnetMask: String?, val defaultGateway: String?, val proxy: Proxy? = null)

access point infomation

AiAutoThumbnail

enum AiAutoThumbnail : Enum<AiAutoThumbnail>

AI auto thumbnail setting

AuthenticationMode

enum AuthenticationMode : Enum<AuthenticationMode>

authentication mode

BluetoothPower

enum BluetoothPower : Enum<BluetoothPower>

bluetooth power

CameraControlSource

enum CameraControlSource : Enum<CameraControlSource>

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.

CameraError

enum CameraError : Enum<CameraError>

Camera error

CameraFileInfo

data class CameraFileInfo(val name: String, val fileUrl: String, val size: Long, val dateTimeZone: String?, val dateTime: String?, val lat: Float?, val lng: Float?, val width: Int?, val height: Int?, val thumbnail: String?, val _thumbSize: Int?, val _intervalCaptureGroupId: String?, val _compositeShootingGroupId: String?, val _autoBracketGroupId: String?, val _recordTime: Int?, val isProcessed: Boolean, val previewUrl: String, val _codec: String?, val _projectionType: _ProjectionType?, val _continuousShootingGroupId: String?, val _frameRate: Int?, val _favorite: Boolean?, val _imageDescription: String?, val _storageID: String?)

camera file information

CameraMode

enum CameraMode : Enum<CameraMode>

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

CameraState

data class CameraState(val batteryLevel: Double, val storageUri: String? = null, val _storageID: String? = null, val _captureStatus: CaptureStatus, val _recordedTime: Int, val _recordableTime: Int, val _capturedPictures: Int? = null, val _compositeShootingElapsedTime: Int? = null, val _latestFileUrl: String? = null, val _batteryState: ChargingState, val _apiVersion: Int, val _pluginRunning: Boolean? = null, val _pluginWebServer: Boolean? = null, val _function: ShootingFunction? = null, val _mySettingChanged: Boolean? = null, val _currentMicrophone: MicrophoneOption? = null, val _currentStorage: StorageOption? = null, val _cameraError: List<CameraError>? = null, val _batteryInsert: Boolean? = null)

camera state information

CancelVideoConvertRequest

data class CancelVideoConvertRequest(val name: String = "camera._cancelVideoConvert", val parameters: EmptyParameter = EmptyParameter()) : CommandApiRequest

cancel video convert request

CancelVideoConvertResponse

data class CancelVideoConvertResponse(val name: String, val state: CommandState, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

cancel video convert response

CaptureMode

enum CaptureMode : Enum<CaptureMode>

capture Mode

CaptureStatus

enum CaptureStatus : Enum<CaptureStatus>

Capture status

ChargingState

enum ChargingState : Enum<ChargingState>

Charging state

CommandApi

object CommandApi

POST /osc/commands/execute

CommandApiRequest

interface CommandApiRequest

command api request interface

CommandApiResponse

interface CommandApiResponse

command api response interface

CommandError

data class CommandError(val code: String, val message: String)

error in command api response

CommandProgress

data class CommandProgress(val completion: Float)

completion at inProgress status

CommandState

enum CommandState : Enum<CommandState>

state in command api response

ConvertVideoFormatsParams

data class ConvertVideoFormatsParams(val fileUrl: String, val size: VideoFormat? = null, val projectionType: _ProjectionType? = null, val codec: String? = null, val topBottomCorrection: TopBottomCorrection? = null)

Convert video format parameters

ConvertVideoFormatsRequest

data class ConvertVideoFormatsRequest(val name: String = "camera._convertVideoFormats", val parameters: ConvertVideoFormatsParams) : CommandApiRequest

Convert video formats request

ConvertVideoFormatsResponse

data class ConvertVideoFormatsResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultConvertVideoFormats? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

Convert video formats response

DeleteAccessPointParams

data class DeleteAccessPointParams(val ssid: String)

delete access point parameters

DeleteAccessPointRequest

data class DeleteAccessPointRequest(val name: String = "camera._deleteAccessPoint", val parameters: DeleteAccessPointParams) : CommandApiRequest

delete access point request

DeleteAccessPointResponse

data class DeleteAccessPointResponse(val name: String, val state: CommandState, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

deletee access point response

DeleteMySettingParams

data class DeleteMySettingParams(val mode: CaptureMode? = null)

delete my setting parameters

DeleteMySettingRequest

data class DeleteMySettingRequest(val name: String = "camera._deleteMySetting", val parameters: DeleteMySettingParams) : CommandApiRequest

delete my setting request

DeleteMySettingResponse

data class DeleteMySettingResponse(val name: String, val state: CommandState, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

delete my setting response

DeleteParams

data class DeleteParams(val fileUrls: List<String>)

delete request parameters

DeleteRequest

data class DeleteRequest(val name: String = "camera.delete", val parameters: DeleteParams) : CommandApiRequest

delete request

DeleteResponse

data class DeleteResponse(val name: String, val state: CommandState, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

delete response

EmptyParameter

class EmptyParameter

empty parameters

EndPoint

data class EndPoint(val httpPort: Int, val httpUpdatesPort: Int)

endpoint information

ExifInfo

data class ExifInfo(val ExifVersion: String, val ImageDescription: String, val DateTime: String, val ImageWidth: Int?, val ImageLength: Int?, val ColorSpace: Int, val Compression: Int?, val Orientation: Int, val Flash: Int, val FocalLength: Float, val WhiteBalance: Int, val ExposureTime: Double, val FNumber: Double, val ExposureProgram: Int, val PhotographicSensitivity: Int, val ApertureValue: Double, val BrightnessValue: Float, val ExposureBiasValue: Float, val GPSLatitudeRef: String?, val GPSLatitude: Double?, val GPSLongitudeRef: String?, val GPSLongitude: Double?, val Make: String, val Model: String, val Software: String, val Copyright: String)

exif information (exif 2.3) https://www.cipa.jp/std/documents/j/DC-008-2012_J.pdf

FileType

enum FileType : Enum<FileType>

list file type

FinishWlanRequest

data class FinishWlanRequest(val name: String = "camera._finishWlan", val parameters: EmptyParameter = EmptyParameter()) : CommandApiRequest

finish wlan request

FinishWlanResponse

data class FinishWlanResponse(val name: String, val state: CommandState, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

finish wlan response

FirstShootingEnum

enum FirstShootingEnum : Enum<FirstShootingEnum>

On time shift shooting, specify which side is shot first.

GetLivePreviewRequest

data class GetLivePreviewRequest(val name: String = "camera.getLivePreview", val parameters: EmptyParameter = EmptyParameter()) : CommandApiRequest

get live preview request

GetMetadataParams

data class GetMetadataParams(val fileUrl: String)

get metadata request parameters

GetMetadataRequest

data class GetMetadataRequest(val name: String = "camera._getMetadata", val parameters: GetMetadataParams) : CommandApiRequest

get metadata request

GetMetadataResponse

data class GetMetadataResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultGetMetadata? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

get metadata response

GetMySettingParams

data class GetMySettingParams(val mode: CaptureMode? = null, val optionNames: List<String>? = null)

get my setting parameters

GetMySettingRequest

data class GetMySettingRequest(val name: String = "camera._getMySetting", val parameters: GetMySettingParams) : CommandApiRequest

get my setting request

GetMySettingResponse

data class GetMySettingResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultGetMySetting? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

get my setting response

GetOptionsParams

data class GetOptionsParams(val optionNames: List<String>)

get options parameters

GetOptionsRequest

data class GetOptionsRequest(val name: String = "camera.getOptions", val parameters: GetOptionsParams) : CommandApiRequest

get options request

GetOptionsResponse

data class GetOptionsResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultGetOptions? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

get options response

GetPluginLicenseParams

data class GetPluginLicenseParams(val packageName: String)

GetPluginLicenseRequest

data class GetPluginLicenseRequest(val name: String = "camera._getPluginLicense", val parameters: GetPluginLicenseParams) : CommandApiRequest

GetPluginOrdersRequest

data class GetPluginOrdersRequest(val name: String = "camera._getPluginOrders", val parameters: EmptyParameter = EmptyParameter()) : CommandApiRequest

get plugin order request

GetPluginOrdersResponse

data class GetPluginOrdersResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultGetPluginOrders? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

get plugin order response

GpsInfo

data class GpsInfo(val lat: Float? = null, val lng: Float? = null, val _altitude: Float? = null, val _dateTimeZone: String? = null, val _datum: String? = null)

GPS information

GpsTagRecording

enum GpsTagRecording : Enum<GpsTagRecording>

gps position information

ImageFilter

enum ImageFilter : Enum<ImageFilter>

image filter setting

ImageStitching

enum ImageStitching : Enum<ImageStitching>

image stitching setting

InfoApi

object InfoApi

info api request

InfoApiResponse

data class InfoApiResponse(val manufacturer: String, val model: String, val serialNumber: String, val _wlanMacAddress: String?, val _bluetoothMacAddress: String?, val firmwareVersion: String, val supportUrl: String, val gps: Boolean, val gyro: Boolean, val uptime: Int, val api: List<String>, val endpoints: EndPoint, val apiLevel: List<Int>)

info api response

IpAddressAllocation

enum IpAddressAllocation : Enum<IpAddressAllocation>

ip address allocation

Language

enum Language : Enum<Language>

supported language in camera OS

ListAccessPointsRequest

data class ListAccessPointsRequest(val name: String = "camera._listAccessPoints", val parameters: EmptyParameter = EmptyParameter()) : CommandApiRequest

list access points request

ListAccessPointsResponse

data class ListAccessPointsResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultListAccessPoints? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

list access points response

ListFilesParams

data class ListFilesParams(val fileType: FileType = FileType.ALL, val startPosition: Int? = null, val _startFileUrl: String? = null, val entryCount: Int, val maxThumbSize: Int = 0, val _detail: Boolean? = true, val _sort: SortOrder? = null, val _storage: Storage? = null)

list files request parameters

ListFilesRequest

data class ListFilesRequest(val name: String = "camera.listFiles", val parameters: ListFilesParams) : CommandApiRequest

list files request

ListFilesResponse

data class ListFilesResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultListFiles? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

list files response

ListPluginsRequest

data class ListPluginsRequest(val name: String = "camera._listPlugins", val parameters: EmptyParameter = EmptyParameter()) : CommandApiRequest

list plugins request

ListPluginsResponse

data class ListPluginsResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultListPlugins? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

list plugins response

MediaFileFormat

data class MediaFileFormat(val type: MediaType? = null, val width: Int? = null, val height: Int? = null, val _codec: String? = null, val _frameRate: Int? = null)

Media file format setting

MediaType

enum MediaType : Enum<MediaType>

Media type setting

MicrophoneChannel

enum MicrophoneChannel : Enum<MicrophoneChannel>

Microphone channel setting

MicrophoneOption

enum MicrophoneOption : Enum<MicrophoneOption>

Microphone option

NetworkType

enum NetworkType : Enum<NetworkType>

Network type setting supported by Theta V, Z1, and X.

NumberAsIntSerializer

object NumberAsIntSerializer : KSerializer<Int>

floating point number to/from Long serializer

NumberAsLongSerializer

object NumberAsLongSerializer : KSerializer<Long>

floating point number to/from Long serializer

NumbersAsIntsSerializer

@ExperimentalSerializationApi

object NumbersAsIntsSerializer : KSerializer<List<Int>>

floating point number to/from List serializer

NumbersAsLongsSerializer

@ExperimentalSerializationApi

object NumbersAsLongsSerializer : KSerializer<List<Long>>

floating point number to/from List serializer

Options

data class Options(var _aiAutoThumbnail: AiAutoThumbnail? = null, var _aiAutoThumbnailSupport: List<AiAutoThumbnail>? = null, var aperture: Float? = null, var apertureSupport: List<Float>? = null, var _bluetoothPower: BluetoothPower? = null, var _cameraControlSource: CameraControlSource? = null, var _cameraControlSourceSupport: List<CameraControlSource>? = null, var _cameraMode: CameraMode? = null, var captureMode: CaptureMode? = null, var captureModeSupport: List<CaptureMode>? = null, var clientVersion: Int? = null, var clientVersionSupport: List<Int>? = null, var _colorTemperature: Int? = null, var dateTimeZone: String? = null, var exposureCompensation: Float? = null, var exposureCompensationSupport: List<Float>? = null, var exposureDelay: Int? = null, var exposureDelaySupport: List<Int>? = null, var exposureProgram: Int? = null, var exposureProgramSupport: List<Int>? = null, var fileFormat: MediaFileFormat? = null, var fileFormatSupport: List<MediaFileFormat>? = null, var _filter: ImageFilter? = null, var _filterSupport: List<ImageFilter>? = null, var gpsInfo: GpsInfo? = null, var _gpsTagRecording: GpsTagRecording? = null, var _imageStitching: ImageStitching? = null, var _imageStitchingSupport: List<ImageStitching>? = null, var iso: Int? = null, var isoSupport: List<Int>? = null, var isoAutoHighLimit: Int? = null, var isoAutoHighLimitSupport: List<Int>? = null, var _language: Language? = null, var _languageSupport: List<Language>? = null, var _maxRecordableTime: Int? = null, var _maxRecordableTimeSupport: List<Int>? = null, var _microphone: MicrophoneOption? = null, var _microphoneSupport: List<MicrophoneOption>? = null, var _microphoneChannel: MicrophoneChannel? = null, var _microphoneChannelSupport: List<MicrophoneChannel>? = null, var _networkType: NetworkType? = null, var _networkTypeSupport: List<NetworkType>? = null, var offDelay: Int? = null, var offDelaySupport: List<Int>? = null, var _password: String? = null, var _powerSaving: PowerSaving? = null, var _powerSavingSupport: List<PowerSaving>? = null, var previewFormat: PreviewFormat? = null, var previewFormatSupport: List<PreviewFormat>? = null, var _proxy: Proxy? = null, var remainingPictures: Int? = null, var remainingSpace: Long? = null, var remainingVideoSeconds: Int? = null, var _shootingMethod: ShootingMethod? = null, var _shootingMethodSupport: List<ShootingMethod>? = null, var shutterSpeed: Double? = null, var shutterSpeedSupport: List<Double>? = null, var _shutterVolume: Int? = null, var _shutterVolumeSupport: ShutterVolumeSupport? = null, var sleepDelay: Int? = null, var sleepDelaySupport: List<Int>? = null, var _timeShift: TimeShift? = null, var _timeShiftSupport: List<TimeShift>? = null, var _topBottomCorrection: TopBottomCorrectionOption? = null, var _topBottomCorrectionSupport: List<TopBottomCorrectionOption>? = null, var totalSpace: Long? = null, var _username: String? = null, var videoStitching: VideoStitching? = null, var videoStitchingSupport: List<VideoStitching>? = null, var _visibilityReduction: VisibilityReduction? = null, var _visibilityReductionSupport: List<VisibilityReduction>? = null, var whiteBalance: WhiteBalance? = null, var whiteBalanceSupport: List<WhiteBalance>? = null, var _whiteBalanceAutoStrength: WhiteBalanceAutoStrength? = null, var _whiteBalanceAutoStrengthSupport: List<WhiteBalanceAutoStrength>? = null, var _wlanFrequency: WlanFrequency? = null, var _wlanFrequencySupport: List<WlanFrequency>? = null)

option key value pair

Plugin

data class Plugin(val pluginName: String, val packageName: String, val version: String, val type: String, val running: Boolean, val foreground: Boolean, val boot: Boolean, val force: Boolean? = null, val bootOptions: String? = null, val webServer: Boolean, val exitStatus: String, val message: String)

PluginControlParams

data class PluginControlParams(val action: String, val plugin: String? = null)

Starts or stops plugin. Supported just by Theta V and later.

PluginControlRequest

data class PluginControlRequest(val name: String = "camera._pluginControl", val parameters: PluginControlParams) : CommandApiRequest

Plugin control request

PluginControlResponse

data class PluginControlResponse(val name: String, val state: CommandState, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

Set plugin response

PowerSaving

enum PowerSaving : Enum<PowerSaving>

Power saving mode

PreviewFormat

data class PreviewFormat(val width: Int? = null, val height: Int? = null, val framerate: Int? = null)

preview format

ProjectionType

enum ProjectionType : Enum<ProjectionType>

projection type

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.

ResetRequest

data class ResetRequest(val name: String = "camera.reset", val parameters: EmptyParameter = EmptyParameter()) : CommandApiRequest

reset request

ResetResponse

data class ResetResponse(val name: String, val state: CommandState, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

reset response

ResultConvertVideoFormats

data class ResultConvertVideoFormats(val fileUrl: String)

Convert video formats results

ResultGetMetadata

data class ResultGetMetadata(val exif: ExifInfo, val xmp: XmpInfo)

get metadata results

ResultGetMySetting

data class ResultGetMySetting(val options: Options)

get options results

ResultGetOptions

data class ResultGetOptions(val options: Options)

get options results

ResultGetPluginOrders

data class ResultGetPluginOrders(val pluginOrders: List<String>)

plugin order results

ResultListAccessPoints

data class ResultListAccessPoints(val accessPoints: List<AccessPoint>)

list access points results

ResultListFiles

data class ResultListFiles(val entries: List<CameraFileInfo>, val totalEntries: Int)

list files request results

ResultListPlugins

data class ResultListPlugins(val plugins: List<Plugin>)

get options results

ResultSetBluetoothDevice

data class ResultSetBluetoothDevice(val deviceName: String)

ResultSetOptions

data class ResultSetOptions(val options: Options)

set options results

ResultStartCapture

data class ResultStartCapture(val fileUrls: List<String>)

start capture results

ResultStartSession

data class ResultStartSession(val sessionId: String, val timeout: Int)

start capture results

ResultStopCapture

data class ResultStopCapture(val fileUrls: List<String>)

stop capgure results

ResultTakePicture

data class ResultTakePicture(val fileUrl: String, val _dngFileUrl: String? = null)

take picture results

SetAccessPointParams

data class SetAccessPointParams(val ssid: String, val ssidStealth: Boolean? = null, val security: AuthenticationMode? = null, val password: String? = null, val connectionPriority: Int? = null, val ipAddressAllocation: IpAddressAllocation? = null, val ipAddress: String? = null, val subnetMask: String? = null, val defaultGateway: String? = null, val proxy: Proxy? = null)

set access point request parameters

SetAccessPointRequest

data class SetAccessPointRequest(val name: String = "camera._setAccessPoint", val parameters: SetAccessPointParams) : CommandApiRequest

set access point request

SetAccessPointResponse

data class SetAccessPointResponse(val name: String, val state: CommandState, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

set access point response

SetBluetoothDeviceParams

data class SetBluetoothDeviceParams(val uuid: String)

SetBluetoothDeviceRequest

data class SetBluetoothDeviceRequest(val name: String = "camera._setBluetoothDevice", val parameters: SetBluetoothDeviceParams) : CommandApiRequest

SetBluetoothDeviceResponse

data class SetBluetoothDeviceResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultSetBluetoothDevice? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

SetMySettingParams

data class SetMySettingParams(val mode: CaptureMode? = null, val options: Options)

Set my setting parameters

SetMySettingRequest

data class SetMySettingRequest(val name: String = "camera._setMySetting", val parameters: SetMySettingParams) : CommandApiRequest

Set my setting request

SetMySettingResponse

data class SetMySettingResponse(val name: String, val state: CommandState, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

Set my setting response

SetOptionsParams

data class SetOptionsParams(val sessionId: String? = null, val options: Options)

set options request parameters

SetOptionsRequest

data class SetOptionsRequest(val name: String = "camera.setOptions", val parameters: SetOptionsParams) : CommandApiRequest

set options request

SetOptionsResponse

data class SetOptionsResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultSetOptions? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

set options response

SetPluginOrdersParams

data class SetPluginOrdersParams(val pluginOrders: List<String>)

Set plugin orders parameters

SetPluginOrdersRequest

data class SetPluginOrdersRequest(val name: String = "camera._setPluginOrders", val parameters: SetPluginOrdersParams) : CommandApiRequest

Set plugin orders request

SetPluginOrdersResponse

data class SetPluginOrdersResponse(val name: String, val state: CommandState, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

Set plugin orders response

SetPluginParams

data class SetPluginParams(val packageName: String, val boot: Boolean)

Sets the installed plugin for boot. Supported just by Theta V.

SetPluginRequest

data class SetPluginRequest(val name: String = "camera._setPlugin", val parameters: SetPluginParams) : CommandApiRequest

Set plugin request

SetPluginResponse

data class SetPluginResponse(val name: String, val state: CommandState, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

Set plugin response

ShootingFunction

enum ShootingFunction : Enum<ShootingFunction>

shooting function

ShootingMethod

enum ShootingMethod : Enum<ShootingMethod>

Shooting Method setting

ShootingMode

enum ShootingMode : Enum<ShootingMode>

Shooting mode

ShutterVolumeSupport

data class ShutterVolumeSupport(val minShutterVolume: Int? = null, val maxShutterVolume: Int? = null)

Shutter volume support

SortOrder

enum SortOrder : Enum<SortOrder>

list files to sort order

StartCaptureParams

data class StartCaptureParams(val _mode: ShootingMode? = null)

start capture request parameters

StartCaptureRequest

data class StartCaptureRequest(val name: String = "camera.startCapture", val parameters: StartCaptureParams) : CommandApiRequest

start capture request

StartCaptureResponse

data class StartCaptureResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultStartCapture? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

start capture response

StartSessionRequest

data class StartSessionRequest(val name: String = "camera.startSession", val parameters: EmptyParameter = EmptyParameter()) : CommandApiRequest

start capture request

StartSessionResponse

data class StartSessionResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultStartSession? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

start capture response

StateApi

object StateApi

/osc/state api request

StateApiResponse

data class StateApiResponse(val fingerprint: String, val state: CameraState)

state api response

StatusApi

object StatusApi

Status api request

StatusApiParams

data class StatusApiParams(val name: String? = null, val id: String? = null)

Status API request parameters class

StatusApiRequest

data class StatusApiRequest(val name: String? = null, val id: String? = null)

Status API request information class

StopCaptureRequest

data class StopCaptureRequest(val name: String = "camera.stopCapture", val parameters: EmptyParameter = EmptyParameter()) : CommandApiRequest

stop capture request

StopCaptureResponse

data class StopCaptureResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultStopCapture? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

stop capture response

StopSelfTimerRequest

data class StopSelfTimerRequest(val name: String = "camera._stopSelfTimer", val parameters: EmptyParameter = EmptyParameter()) : CommandApiRequest

stop self timer request

StopSelfTimerResponse

data class StopSelfTimerResponse(val name: String, val state: CommandState, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

stop self timer response

Storage

enum Storage : Enum<Storage>

Specifies the storage

StorageOption

enum StorageOption : Enum<StorageOption>

Storage option

TakePictureRequest

data class TakePictureRequest(val name: String = "camera.takePicture", val parameters: EmptyParameter = EmptyParameter()) : CommandApiRequest

take picture request

TakePictureResponse

data class TakePictureResponse(val name: String, val state: CommandState, val id: String? = null, val results: ResultTakePicture? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

take picture Response

TimeShift

data class TimeShift(val firstShooting: FirstShootingEnum? = null, val firstInterval: Int? = null, val secondInterval: Int? = null)

Time shift shooting.

TopBottomCorrection

enum TopBottomCorrection : Enum<TopBottomCorrection>

Top Buttoncorrection value

TopBottomCorrectionOption

enum TopBottomCorrectionOption : Enum<TopBottomCorrectionOption>

top bottom correction option setting

UnknownResponse

data class UnknownResponse(val name: String, val state: CommandState = CommandState.ERROR, val id: String? = null, val results: JsonElement? = null, val error: CommandError? = null, val progress: CommandProgress? = null) : CommandApiResponse

Unknown Response data class

VideoFormat

enum VideoFormat : Enum<VideoFormat>

video formats

VideoStitching

enum VideoStitching : Enum<VideoStitching>

Video stitching setting

VisibilityReduction

enum VisibilityReduction : Enum<VisibilityReduction>

Visibility reduction setting

WhiteBalance

enum WhiteBalance : Enum<WhiteBalance>

White balance setting

WhiteBalanceAutoStrength

enum WhiteBalanceAutoStrength : Enum<WhiteBalanceAutoStrength>

White balance auto strength

WlanFrequency

enum WlanFrequency : Enum<WlanFrequency>

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

WlanFrequencySerializer

object WlanFrequencySerializer : KSerializer<WlanFrequency>

Custom serializer for WlanFrequency

XmpInfo

data class XmpInfo(val ProjectionType: ProjectionType, val UsePanoramaViewer: Boolean, val PoseHeadingDegrees: Double?, val CroppedAreaImageWidthPixels: Int, val CroppedAreaImageHeightPixels: Int, val FullPanoWidthPixels: Int, val FullPanoHeightPixels: Int, val CroppedAreaLeftPixels: Int, val CroppedAreaTopPixels: Int)

XMP information

Functions

decodeStatusApiResponse

@ExperimentalSerializationApi

fun decodeStatusApiResponse(body: String?): CommandApiResponse

decode status api response depends on {body}.name and return decoded object