# Velocity

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# Velocity

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/health/connect/datatypes/units/Velocity "View this page in Java")  

```
class Velocity : Comparable<Velocity!>
```

|---|----------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                     ||
| ↳ | [android.health.connect.datatypes.units.Velocity](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Velocity#) |

Represents a unit of speed. Supported units: metersPerSecond

## Summary

|                                                                                                                                                                                                                                Public methods                                                                                                                                                                                                                                 ||
|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                                        | [compareTo](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Velocity#compareTo(android.health.connect.datatypes.units.Velocity))`(`other:` `[Velocity](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Velocity#)`)` Compares this object with the specified object for order. |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)                                | [equals](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Velocity#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is "equal to" this one.                                                                          |
| static[Velocity](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Velocity#) | [fromMetersPerSecond](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Velocity#fromMetersPerSecond(kotlin.Double))`(`value:` `[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`)` Creates a Velocity object with the specified value in meters per second.                           |
| [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)                                  | [getInMetersPerSecond](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Velocity#getInMetersPerSecond())`()` Returns velocity in meters per second                                                                                                                                                                    |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                                        | [hashCode](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Velocity#hashCode())`()` Returns a hash code value for the object.                                                                                                                                                                                        |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)                                  | [toString](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Velocity#toString())`()` <br />                                                                                                                                                                                                                           |

## Public methods

### compareTo

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun compareTo(other: Velocity): Int
```

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

|                                                                                 Parameters                                                                                  ||
|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `o`     | the object to be compared.                                                                                                                                         |
| `other` | [Velocity](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Velocity#):the object to be compared. This value cannot be`null`. |

|                                                                                                  Return                                                                                                  ||
|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. |

|                                                    Exceptions                                                    ||
|----------------------------------|--------------------------------------------------------------------------------|
| `java.lang.NullPointerException` | if the specified object is null                                                |
| `java.lang.ClassCastException`   | if the specified object's type prevents it from being compared to this object. |

### equals

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun equals(other: Any?): Boolean
```

Indicates whether some other object is "equal to" this one.

|                      Parameters                       ||
|----------|---------------------------------------------|
| `obj`    | the reference object with which to compare. |
| `object` | the reference object with which to compare. |

|                                                                            Return                                                                             ||
|------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true`if this object is the same as the object argument;`false`otherwise. |

### fromMetersPerSecond

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static fun fromMetersPerSecond(value: Double): Velocity
```

Creates a Velocity object with the specified value in meters per second.

|                                                           Parameters                                                            ||
|---------|------------------------------------------------------------------------------------------------------------------------|
| `value` | [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html):value to be set as meters per second. |

|                                                                  Return                                                                  ||
|-------------------------------------------------------------------------------------------------------------|-----------------------------|
| [Velocity](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Velocity#) | This value cannot be`null`. |

### getInMetersPerSecond

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun getInMetersPerSecond(): Double
```

Returns velocity in meters per second  

### hashCode

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun hashCode(): Int
```

Returns a hash code value for the object.

|                                                     Return                                                     ||
|----------------------------------------------------------------------------|------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |

### toString

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun toString(): String
```

|                                                          Return                                                          ||
|----------------------------------------------------------------------------------|----------------------------------------|
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | a string representation of the object. |