class Face : Trackable

Contains the tracking information of a detected human face.

Summary

Nested types

The representation of the current state of Face.

Public companion functions
Face?
getUserFace(session: Session)

Returns the Face object that corresponds to the user.
StateFlow<Collection<Face>>
subscribe(session: Session)

Emits the faces that are currently being tracked in the Session.

Public functions
open operator Boolean
equals(other: Any?)
open Int
open String

Public properties
open StateFlow<Face.State>

The current State of this Face.

Public companion functions

getUserFace

Added in 1.0.0-alpha13
fun getUserFace(session: Session): Face?

Returns the Face object that corresponds to the user.

Parameters
session: Session

the currently active Session
Throws
IllegalStateException

if FaceTrackingMode is set to FaceTrackingMode.DISABLED

subscribe

Added in 1.0.0-alpha13
fun subscribe(session: Session): StateFlow<Collection<Face>>

Emits the faces that are currently being tracked in the Session.

Parameters
session: Session

the Session to track faces from

Public functions

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

state

open val state: StateFlow<Face.State>

The current State of this Face.