# Volume

Artifact: [androidx.health.connect:connect-client](https://developer.android.com/jetpack/androidx/releases/health-connect) [View Source](https://cs.android.com/search?q=file:androidx/health/connect/client/units/Volume.kt+class:androidx.health.connect.client.units.Volume) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

*** ** * ** ***


```
class Volume : Comparable<Volume>
```

<br />

*** ** * ** ***

Represents a unit of volume. Supported units:

- liters - see `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#liters(kotlin.Double)`, `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/package-summary#(kotlin.Double).liters()`

- milliliters - see `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#milliliters(kotlin.Double)`, `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/package-summary#(kotlin.Double).milliliters()`

- US fluid ounces - see `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#fluidOuncesUs(kotlin.Double)`, `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/package-summary#(kotlin.Double).fluidOuncesUs()`

## Summary

| ### Public companion functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#fluidOuncesUs(kotlin.Double)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)` Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume` with the specified value in US fluid ounces. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#liters(kotlin.Double)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)` Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume` with the specified value in liters. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#milliliters(kotlin.Double)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)` Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume` with the specified value in milliliters. |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#compareTo(androidx.health.connect.client.units.Volume)(other: https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume)` |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#toString()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#inFluidOuncesUs()` Returns the volume in US fluid ounces. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#inLiters()` Returns the volume in liters. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume#inMilliliters()` Returns the volume in milliliters. |

## Public companion functions

### fluidOuncesUs

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
fun fluidOuncesUs(value: Double): Volume
```

Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume` with the specified value in US fluid ounces.

### liters

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
fun liters(value: Double): Volume
```

Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume` with the specified value in liters.

### milliliters

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
fun milliliters(value: Double): Volume
```

Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Volume` with the specified value in milliliters.

## Public functions

### compareTo

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
open operator fun compareTo(other: Volume): Int
```

### equals

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

### hashCode

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

### toString

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

## Public properties

### inFluidOuncesUs

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val inFluidOuncesUs: Double
```

Returns the volume in US fluid ounces.

### inLiters

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val inLiters: Double
```

Returns the volume in liters.

### inMilliliters

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val inMilliliters: Double
```

Returns the volume in milliliters.