AugmentedImage

Kotlin |Java

class AugmentedImage : Trackable

Describes the system's current best knowledge of a real-world image

Summary

Nested types
`class AugmentedImage.State : Trackable.State` The representation of the current state of an `AugmentedImage`.

Public companion functions
`StateFlow<Collection<AugmentedImage>>`	`subscribe(session: Session)` Emits tracked augmented images in the `session`.

Public functions
`open String`	`toString()` Returns a string representation of `AugmentedImage` for debugging.

Public properties
`open StateFlow<AugmentedImage.State>`	`state` The current state of the `AugmentedImage`

fun subscribe(session: Session): StateFlow<Collection<AugmentedImage>>

Emits tracked augmented images in the session.

Only instances of AugmentedImage that are androidx.xr.arcore.TrackingState.TRACKING will be emitted in the Collection. Instances of the same AugmentedImage will remain between subsequent emits to the StateFlow as long as they remain tracking.

Parameters
`session: Session`	the `Session` to subscribe to

Returns
`StateFlow<Collection<AugmentedImage>>`	a `StateFlow` that emits a collection of AugmentedImages

Throws
`IllegalStateException`	if the `Config.augmentedImageDatabase` is empty

open fun toString(): String

Returns a string representation of AugmentedImage for debugging.

Note: Not intended for production use.

open val state: StateFlow<AugmentedImage.State>

The current state of the AugmentedImage