com.parrot.drone.groundsdk.protobuf.DroneMetadataKt.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("-initializedroneMetadata")
public inline fun droneMetadata(block: com.parrot.drone.groundsdk.protobuf.DroneMetadataKt.Dsl.() -> kotlin.Unit): com.parrot.drone.groundsdk.protobuf.VideoMetadata.DroneMetadata =
com.parrot.drone.groundsdk.protobuf.DroneMetadataKt.Dsl._create(com.parrot.drone.groundsdk.protobuf.VideoMetadata.DroneMetadata.newBuilder()).apply { block() }._build()
/**
* Protobuf type `vmeta.DroneMetadata`
*/
public object DroneMetadataKt {
@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.DroneMetadata.Builder
) {
public companion object {
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _create(builder: com.parrot.drone.groundsdk.protobuf.VideoMetadata.DroneMetadata.Builder): Dsl = Dsl(builder)
}
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _build(): com.parrot.drone.groundsdk.protobuf.VideoMetadata.DroneMetadata = _builder.build()
/**
* ```
* Drone quaternion
* ```
*
* `.vmeta.Quaternion quat = 1;`
*/
public var quat: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Quaternion
@JvmName("getQuat")
get() = _builder.getQuat()
@JvmName("setQuat")
set(value) {
_builder.setQuat(value)
}
/**
* ```
* Drone quaternion
* ```
*
* `.vmeta.Quaternion quat = 1;`
*/
public fun clearQuat() {
_builder.clearQuat()
}
/**
* ```
* Drone quaternion
* ```
*
* `.vmeta.Quaternion quat = 1;`
* @return Whether the quat field is set.
*/
public fun hasQuat(): kotlin.Boolean {
return _builder.hasQuat()
}
/**
* ```
* Drone location
* ```
*
* `.vmeta.Location location = 2;`
*/
public var location: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Location
@JvmName("getLocation")
get() = _builder.getLocation()
@JvmName("setLocation")
set(value) {
_builder.setLocation(value)
}
/**
* ```
* Drone location
* ```
*
* `.vmeta.Location location = 2;`
*/
public fun clearLocation() {
_builder.clearLocation()
}
/**
* ```
* Drone location
* ```
*
* `.vmeta.Location location = 2;`
* @return Whether the location field is set.
*/
public fun hasLocation(): kotlin.Boolean {
return _builder.hasLocation()
}
/**
* ```
* Best ground distance estimation (m)
* ```
*
* `double ground_distance = 3;`
*/
public var groundDistance: kotlin.Double
@JvmName("getGroundDistance")
get() = _builder.getGroundDistance()
@JvmName("setGroundDistance")
set(value) {
_builder.setGroundDistance(value)
}
/**
* ```
* Best ground distance estimation (m)
* ```
*
* `double ground_distance = 3;`
*/
public fun clearGroundDistance() {
_builder.clearGroundDistance()
}
/**
* ```
* Estimated position of the drone in NED frame (m).
* The position is initialized at first take off. When this position may
* have drifted from the true position (for example when GPS signal is
* not available), this position jumps on the first absolute position
* measurement available.
* ```
*
* `.vmeta.NED position = 9;`
*/
public var position: com.parrot.drone.groundsdk.protobuf.VideoMetadata.NED
@JvmName("getPosition")
get() = _builder.getPosition()
@JvmName("setPosition")
set(value) {
_builder.setPosition(value)
}
/**
* ```
* Estimated position of the drone in NED frame (m).
* The position is initialized at first take off. When this position may
* have drifted from the true position (for example when GPS signal is
* not available), this position jumps on the first absolute position
* measurement available.
* ```
*
* `.vmeta.NED position = 9;`
*/
public fun clearPosition() {
_builder.clearPosition()
}
/**
* ```
* Estimated position of the drone in NED frame (m).
* The position is initialized at first take off. When this position may
* have drifted from the true position (for example when GPS signal is
* not available), this position jumps on the first absolute position
* measurement available.
* ```
*
* `.vmeta.NED position = 9;`
* @return Whether the position field is set.
*/
public fun hasPosition(): kotlin.Boolean {
return _builder.hasPosition()
}
/**
* ```
* Estimated position of the drone 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.
* ```
*
* `.vmeta.Vector3 local_position = 10;`
*/
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 drone 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.
* ```
*
* `.vmeta.Vector3 local_position = 10;`
*/
public fun clearLocalPosition() {
_builder.clearLocalPosition()
}
/**
* ```
* Estimated position of the drone 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.
* ```
*
* `.vmeta.Vector3 local_position = 10;`
* @return Whether the localPosition field is set.
*/
public fun hasLocalPosition(): kotlin.Boolean {
return _builder.hasLocalPosition()
}
/**
* ```
* Speed vector in NED (North-East-Down) (m/s)
* ```
*
* `.vmeta.NED speed = 4;`
*/
public var speed: com.parrot.drone.groundsdk.protobuf.VideoMetadata.NED
@JvmName("getSpeed")
get() = _builder.getSpeed()
@JvmName("setSpeed")
set(value) {
_builder.setSpeed(value)
}
/**
* ```
* Speed vector in NED (North-East-Down) (m/s)
* ```
*
* `.vmeta.NED speed = 4;`
*/
public fun clearSpeed() {
_builder.clearSpeed()
}
/**
* ```
* Speed vector in NED (North-East-Down) (m/s)
* ```
*
* `.vmeta.NED speed = 4;`
* @return Whether the speed field is set.
*/
public fun hasSpeed(): kotlin.Boolean {
return _builder.hasSpeed()
}
/**
* ```
* Battery charge percentage
* ```
*
* `sint32 battery_percentage = 5;`
*/
public var batteryPercentage: kotlin.Int
@JvmName("getBatteryPercentage")
get() = _builder.getBatteryPercentage()
@JvmName("setBatteryPercentage")
set(value) {
_builder.setBatteryPercentage(value)
}
/**
* ```
* Battery charge percentage
* ```
*
* `sint32 battery_percentage = 5;`
*/
public fun clearBatteryPercentage() {
_builder.clearBatteryPercentage()
}
/**
* ```
* Flying state
* ```
*
* `.vmeta.FlyingState flying_state = 7;`
*/
public var flyingState: com.parrot.drone.groundsdk.protobuf.VideoMetadata.FlyingState
@JvmName("getFlyingState")
get() = _builder.getFlyingState()
@JvmName("setFlyingState")
set(value) {
_builder.setFlyingState(value)
}
public var flyingStateValue: kotlin.Int
@JvmName("getFlyingStateValue")
get() = _builder.getFlyingStateValue()
@JvmName("setFlyingStateValue")
set(value) {
_builder.setFlyingStateValue(value)
}
/**
* ```
* Flying state
* ```
*
* `.vmeta.FlyingState flying_state = 7;`
*/
public fun clearFlyingState() {
_builder.clearFlyingState()
}
/**
* ```
* Animation in progreess
* ```
*
* `bool animation_in_progress = 11;`
*/
public var animationInProgress: kotlin.Boolean
@JvmName("getAnimationInProgress")
get() = _builder.getAnimationInProgress()
@JvmName("setAnimationInProgress")
set(value) {
_builder.setAnimationInProgress(value)
}
/**
* ```
* Animation in progreess
* ```
*
* `bool animation_in_progress = 11;`
*/
public fun clearAnimationInProgress() {
_builder.clearAnimationInProgress()
}
/**
* ```
* Piloting mode
* ```
*
* `.vmeta.PilotingMode piloting_mode = 12;`
*/
public var pilotingMode: com.parrot.drone.groundsdk.protobuf.VideoMetadata.PilotingMode
@JvmName("getPilotingMode")
get() = _builder.getPilotingMode()
@JvmName("setPilotingMode")
set(value) {
_builder.setPilotingMode(value)
}
public var pilotingModeValue: kotlin.Int
@JvmName("getPilotingModeValue")
get() = _builder.getPilotingModeValue()
@JvmName("setPilotingModeValue")
set(value) {
_builder.setPilotingModeValue(value)
}
/**
* ```
* Piloting mode
* ```
*
* `.vmeta.PilotingMode piloting_mode = 12;`
*/
public fun clearPilotingMode() {
_builder.clearPilotingMode()
}
}
}
@kotlin.jvm.JvmSynthetic
public inline fun com.parrot.drone.groundsdk.protobuf.VideoMetadata.DroneMetadata.copy(block: com.parrot.drone.groundsdk.protobuf.DroneMetadataKt.Dsl.() -> kotlin.Unit): com.parrot.drone.groundsdk.protobuf.VideoMetadata.DroneMetadata =
com.parrot.drone.groundsdk.protobuf.DroneMetadataKt.Dsl._create(this.toBuilder()).apply { block() }._build()
public val com.parrot.drone.groundsdk.protobuf.VideoMetadata.DroneMetadataOrBuilder.quatOrNull: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Quaternion?
get() = if (hasQuat()) getQuat() else null
public val com.parrot.drone.groundsdk.protobuf.VideoMetadata.DroneMetadataOrBuilder.locationOrNull: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Location?
get() = if (hasLocation()) getLocation() else null
public val com.parrot.drone.groundsdk.protobuf.VideoMetadata.DroneMetadataOrBuilder.positionOrNull: com.parrot.drone.groundsdk.protobuf.VideoMetadata.NED?
get() = if (hasPosition()) getPosition() else null
public val com.parrot.drone.groundsdk.protobuf.VideoMetadata.DroneMetadataOrBuilder.localPositionOrNull: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Vector3?
get() = if (hasLocalPosition()) getLocalPosition() else null
public val com.parrot.drone.groundsdk.protobuf.VideoMetadata.DroneMetadataOrBuilder.speedOrNull: com.parrot.drone.groundsdk.protobuf.VideoMetadata.NED?
get() = if (hasSpeed()) getSpeed() else null