com.parrot.drone.groundsdk.protobuf.CameraMetadataKt.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of video-metadata Show documentation
Show all versions of video-metadata Show documentation
video-metadata module is part of Parrot Ground SDK for Android
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: vmeta.proto
// Generated files should ignore deprecation warnings
@file:Suppress("DEPRECATION")
package com.parrot.drone.groundsdk.protobuf;
@kotlin.jvm.JvmName("-initializecameraMetadata")
public inline fun cameraMetadata(block: com.parrot.drone.groundsdk.protobuf.CameraMetadataKt.Dsl.() -> kotlin.Unit): com.parrot.drone.groundsdk.protobuf.VideoMetadata.CameraMetadata =
com.parrot.drone.groundsdk.protobuf.CameraMetadataKt.Dsl._create(com.parrot.drone.groundsdk.protobuf.VideoMetadata.CameraMetadata.newBuilder()).apply { block() }._build()
/**
* Protobuf type `vmeta.CameraMetadata`
*/
public object CameraMetadataKt {
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
@com.google.protobuf.kotlin.ProtoDslMarker
public class Dsl private constructor(
private val _builder: com.parrot.drone.groundsdk.protobuf.VideoMetadata.CameraMetadata.Builder
) {
public companion object {
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _create(builder: com.parrot.drone.groundsdk.protobuf.VideoMetadata.CameraMetadata.Builder): Dsl = Dsl(builder)
}
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _build(): com.parrot.drone.groundsdk.protobuf.VideoMetadata.CameraMetadata = _builder.build()
/**
* ```
* Frame capture timestamp (us, monotonic)
* ```
*
* `uint64 timestamp = 1;`
*/
public var timestamp: kotlin.Long
@JvmName("getTimestamp")
get() = _builder.getTimestamp()
@JvmName("setTimestamp")
set(value) {
_builder.setTimestamp(value)
}
/**
* ```
* Frame capture timestamp (us, monotonic)
* ```
*
* `uint64 timestamp = 1;`
*/
public fun clearTimestamp() {
_builder.clearTimestamp()
}
/**
* ```
* Frame capture UTC timestamp (us since the Epoch)
* ```
*
* `uint64 utc_timestamp = 10;`
*/
public var utcTimestamp: kotlin.Long
@JvmName("getUtcTimestamp")
get() = _builder.getUtcTimestamp()
@JvmName("setUtcTimestamp")
set(value) {
_builder.setUtcTimestamp(value)
}
/**
* ```
* Frame capture UTC timestamp (us since the Epoch)
* ```
*
* `uint64 utc_timestamp = 10;`
*/
public fun clearUtcTimestamp() {
_builder.clearUtcTimestamp()
}
/**
* ```
* Frame capture UTC timestamp accuracy (us); zero means unknown,
* utc_timestamp must then be considered invalid
* ```
*
* `uint32 utc_timestamp_accuracy = 11;`
*/
public var utcTimestampAccuracy: kotlin.Int
@JvmName("getUtcTimestampAccuracy")
get() = _builder.getUtcTimestampAccuracy()
@JvmName("setUtcTimestampAccuracy")
set(value) {
_builder.setUtcTimestampAccuracy(value)
}
/**
* ```
* Frame capture UTC timestamp accuracy (us); zero means unknown,
* utc_timestamp must then be considered invalid
* ```
*
* `uint32 utc_timestamp_accuracy = 11;`
*/
public fun clearUtcTimestampAccuracy() {
_builder.clearUtcTimestampAccuracy()
}
/**
* ```
* Frame base view quaternion (without user pan/tilt)
* ```
*
* `.vmeta.Quaternion base_quat = 2;`
*/
public var baseQuat: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Quaternion
@JvmName("getBaseQuat")
get() = _builder.getBaseQuat()
@JvmName("setBaseQuat")
set(value) {
_builder.setBaseQuat(value)
}
/**
* ```
* Frame base view quaternion (without user pan/tilt)
* ```
*
* `.vmeta.Quaternion base_quat = 2;`
*/
public fun clearBaseQuat() {
_builder.clearBaseQuat()
}
/**
* ```
* Frame base view quaternion (without user pan/tilt)
* ```
*
* `.vmeta.Quaternion base_quat = 2;`
* @return Whether the baseQuat field is set.
*/
public fun hasBaseQuat(): kotlin.Boolean {
return _builder.hasBaseQuat()
}
/**
* ```
* Frame view quaternion
* ```
*
* `.vmeta.Quaternion quat = 3;`
*/
public var quat: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Quaternion
@JvmName("getQuat")
get() = _builder.getQuat()
@JvmName("setQuat")
set(value) {
_builder.setQuat(value)
}
/**
* ```
* Frame view quaternion
* ```
*
* `.vmeta.Quaternion quat = 3;`
*/
public fun clearQuat() {
_builder.clearQuat()
}
/**
* ```
* Frame view quaternion
* ```
*
* `.vmeta.Quaternion quat = 3;`
* @return Whether the quat field is set.
*/
public fun hasQuat(): kotlin.Boolean {
return _builder.hasQuat()
}
/**
* ```
* Estimated position of the camera in the local frame (m).
* The local frame is not NED: X and Y axis are arbitrary, but the Z
* axis is guaranteed to point down.
* The position is initialized at first take off. This position is
* guaranteed not to jump, even when a new absolute position (usually
* GPS) is available. Instead, the origin of the local frame jumps in
* order to ensure the continuity of the local position.
* This position is not available on all cameras. If not available,
* the Drone.local_position metadata should be used instead.
* ```
*
* `.vmeta.Vector3 local_position = 12;`
*/
public var localPosition: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Vector3
@JvmName("getLocalPosition")
get() = _builder.getLocalPosition()
@JvmName("setLocalPosition")
set(value) {
_builder.setLocalPosition(value)
}
/**
* ```
* Estimated position of the camera in the local frame (m).
* The local frame is not NED: X and Y axis are arbitrary, but the Z
* axis is guaranteed to point down.
* The position is initialized at first take off. This position is
* guaranteed not to jump, even when a new absolute position (usually
* GPS) is available. Instead, the origin of the local frame jumps in
* order to ensure the continuity of the local position.
* This position is not available on all cameras. If not available,
* the Drone.local_position metadata should be used instead.
* ```
*
* `.vmeta.Vector3 local_position = 12;`
*/
public fun clearLocalPosition() {
_builder.clearLocalPosition()
}
/**
* ```
* Estimated position of the camera in the local frame (m).
* The local frame is not NED: X and Y axis are arbitrary, but the Z
* axis is guaranteed to point down.
* The position is initialized at first take off. This position is
* guaranteed not to jump, even when a new absolute position (usually
* GPS) is available. Instead, the origin of the local frame jumps in
* order to ensure the continuity of the local position.
* This position is not available on all cameras. If not available,
* the Drone.local_position metadata should be used instead.
* ```
*
* `.vmeta.Vector3 local_position = 12;`
* @return Whether the localPosition field is set.
*/
public fun hasLocalPosition(): kotlin.Boolean {
return _builder.hasLocalPosition()
}
/**
* ```
* Camera location
* ```
*
* `.vmeta.Location location = 13;`
*/
public var location: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Location
@JvmName("getLocation")
get() = _builder.getLocation()
@JvmName("setLocation")
set(value) {
_builder.setLocation(value)
}
/**
* ```
* Camera location
* ```
*
* `.vmeta.Location location = 13;`
*/
public fun clearLocation() {
_builder.clearLocation()
}
/**
* ```
* Camera location
* ```
*
* `.vmeta.Location location = 13;`
* @return Whether the location field is set.
*/
public fun hasLocation(): kotlin.Boolean {
return _builder.hasLocation()
}
/**
* ```
* Camera principal point normalized coordinates in picture [0; 1]
* ```
*
* `.vmeta.Vector2 principal_point = 14;`
*/
public var principalPoint: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Vector2
@JvmName("getPrincipalPoint")
get() = _builder.getPrincipalPoint()
@JvmName("setPrincipalPoint")
set(value) {
_builder.setPrincipalPoint(value)
}
/**
* ```
* Camera principal point normalized coordinates in picture [0; 1]
* ```
*
* `.vmeta.Vector2 principal_point = 14;`
*/
public fun clearPrincipalPoint() {
_builder.clearPrincipalPoint()
}
/**
* ```
* Camera principal point normalized coordinates in picture [0; 1]
* ```
*
* `.vmeta.Vector2 principal_point = 14;`
* @return Whether the principalPoint field is set.
*/
public fun hasPrincipalPoint(): kotlin.Boolean {
return _builder.hasPrincipalPoint()
}
/**
* ```
* Frame exposure time (ms)
* ```
*
* `float exposure_time = 4;`
*/
public var exposureTime: kotlin.Float
@JvmName("getExposureTime")
get() = _builder.getExposureTime()
@JvmName("setExposureTime")
set(value) {
_builder.setExposureTime(value)
}
/**
* ```
* Frame exposure time (ms)
* ```
*
* `float exposure_time = 4;`
*/
public fun clearExposureTime() {
_builder.clearExposureTime()
}
/**
* ```
* Frame ISO gain
* ```
*
* `uint32 iso_gain = 5;`
*/
public var isoGain: kotlin.Int
@JvmName("getIsoGain")
get() = _builder.getIsoGain()
@JvmName("setIsoGain")
set(value) {
_builder.setIsoGain(value)
}
/**
* ```
* Frame ISO gain
* ```
*
* `uint32 iso_gain = 5;`
*/
public fun clearIsoGain() {
_builder.clearIsoGain()
}
/**
* ```
* Frame AWB red gain
* ```
*
* `float awb_r_gain = 6;`
*/
public var awbRGain: kotlin.Float
@JvmName("getAwbRGain")
get() = _builder.getAwbRGain()
@JvmName("setAwbRGain")
set(value) {
_builder.setAwbRGain(value)
}
/**
* ```
* Frame AWB red gain
* ```
*
* `float awb_r_gain = 6;`
*/
public fun clearAwbRGain() {
_builder.clearAwbRGain()
}
/**
* ```
* Frame AWB blue gain
* ```
*
* `float awb_b_gain = 7;`
*/
public var awbBGain: kotlin.Float
@JvmName("getAwbBGain")
get() = _builder.getAwbBGain()
@JvmName("setAwbBGain")
set(value) {
_builder.setAwbBGain(value)
}
/**
* ```
* Frame AWB blue gain
* ```
*
* `float awb_b_gain = 7;`
*/
public fun clearAwbBGain() {
_builder.clearAwbBGain()
}
/**
* ```
* Frame horizontal field of view (rad)
* ```
*
* `float hfov = 8;`
*/
public var hfov: kotlin.Float
@JvmName("getHfov")
get() = _builder.getHfov()
@JvmName("setHfov")
set(value) {
_builder.setHfov(value)
}
/**
* ```
* Frame horizontal field of view (rad)
* ```
*
* `float hfov = 8;`
*/
public fun clearHfov() {
_builder.clearHfov()
}
/**
* ```
* Frame vertical field of view (rad)
* ```
*
* `float vfov = 9;`
*/
public var vfov: kotlin.Float
@JvmName("getVfov")
get() = _builder.getVfov()
@JvmName("setVfov")
set(value) {
_builder.setVfov(value)
}
/**
* ```
* Frame vertical field of view (rad)
* ```
*
* `float vfov = 9;`
*/
public fun clearVfov() {
_builder.clearVfov()
}
}
}
@kotlin.jvm.JvmSynthetic
public inline fun com.parrot.drone.groundsdk.protobuf.VideoMetadata.CameraMetadata.copy(block: com.parrot.drone.groundsdk.protobuf.CameraMetadataKt.Dsl.() -> kotlin.Unit): com.parrot.drone.groundsdk.protobuf.VideoMetadata.CameraMetadata =
com.parrot.drone.groundsdk.protobuf.CameraMetadataKt.Dsl._create(this.toBuilder()).apply { block() }._build()
public val com.parrot.drone.groundsdk.protobuf.VideoMetadata.CameraMetadataOrBuilder.baseQuatOrNull: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Quaternion?
get() = if (hasBaseQuat()) getBaseQuat() else null
public val com.parrot.drone.groundsdk.protobuf.VideoMetadata.CameraMetadataOrBuilder.quatOrNull: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Quaternion?
get() = if (hasQuat()) getQuat() else null
public val com.parrot.drone.groundsdk.protobuf.VideoMetadata.CameraMetadataOrBuilder.localPositionOrNull: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Vector3?
get() = if (hasLocalPosition()) getLocalPosition() else null
public val com.parrot.drone.groundsdk.protobuf.VideoMetadata.CameraMetadataOrBuilder.locationOrNull: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Location?
get() = if (hasLocation()) getLocation() else null
public val com.parrot.drone.groundsdk.protobuf.VideoMetadata.CameraMetadataOrBuilder.principalPointOrNull: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Vector2?
get() = if (hasPrincipalPoint()) getPrincipalPoint() else null