# SpatialAnnotationTrackingOptions

Artifact: [androidx.xr.arcore:arcore](https://developer.android.com/jetpack/androidx/releases/xr-arcore) [View Source](https://cs.android.com/search?q=file:androidx/xr/arcore/SpatialAnnotationTrackingOptions.kt+class:androidx.xr.arcore.SpatialAnnotationTrackingOptions) Added in [1.1.0-alpha01](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.1.0-alpha01)

*** ** * ** ***


```
@ExperimentalSpatialAnnotationsApi
class SpatialAnnotationTrackingOptions
```

<br />

*** ** * ** ***

Configuration options required to start tracking Spatial Annotations.

Use the nested `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationTrackingOptions.Builder` to create an instance.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationTrackingOptions.Builder` Builder for `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationTrackingOptions`. |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationTrackingOptions#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/xr/arcore/SpatialAnnotationTrackingOptions#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationTrackingOptions#toString()()` |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationQuadAlignment` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationTrackingOptions#alignment()` the requested tracking alignment |
| `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationImageFormat` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationTrackingOptions#format()` the format of the input image |
| `https://developer.android.com/reference/java/nio/ByteBuffer.html` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationTrackingOptions#imageBuffer()` the `https://developer.android.com/reference/java/nio/ByteBuffer.html` containing the input image data |
| `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/IntSize2d` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationTrackingOptions#imageSize()` the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/IntSize2d` of the input image |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationId, https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Quad>` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationTrackingOptions#quads()` a map of `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationId`s to bounding quads |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationTrackingOptions#rowStride()` the row stride of the input image in bytes |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationTrackingOptions#timestampNanos()` the system timestamp of the input image in nanoseconds, using the `https://developer.android.com/reference/java/lang/System.html#nanoTime()` clock base |

## Public functions

### equals

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

### hashCode

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

### toString

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

## Public properties

### alignment

Added in [1.1.0-alpha01](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.1.0-alpha01)

```
val alignment: SpatialAnnotationQuadAlignment
```

the requested tracking alignment

### format

Added in [1.1.0-alpha01](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.1.0-alpha01)

```
val format: SpatialAnnotationImageFormat
```

the format of the input image

### imageBuffer

Added in [1.1.0-alpha01](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.1.0-alpha01)

```
val imageBuffer: ByteBuffer
```

the `https://developer.android.com/reference/java/nio/ByteBuffer.html` containing the input image data

### imageSize

Added in [1.1.0-alpha01](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.1.0-alpha01)

```
val imageSize: IntSize2d
```

the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/IntSize2d` of the input image

### quads

Added in [1.1.0-alpha01](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.1.0-alpha01)

```
val quads: Map<SpatialAnnotationId, Quad>
```

a map of `https://developer.android.com/reference/kotlin/androidx/xr/arcore/SpatialAnnotationId`s to bounding quads

### rowStride

Added in [1.1.0-alpha01](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.1.0-alpha01)

```
val rowStride: Int
```

the row stride of the input image in bytes

### timestampNanos

Added in [1.1.0-alpha01](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.1.0-alpha01)

```
val timestampNanos: Long
```

the system timestamp of the input image in nanoseconds, using the `https://developer.android.com/reference/java/lang/System.html#nanoTime()` clock base