Skip to main content

ARDK for Android/com.nianticlabs.ardk/Orientation

Orientation

enum Orientation : Enum<Orientation>

Device orientation when capturing camera frames.

Orientation affects how ARDK interprets camera data and poses. Ensure the correct orientation is set in FrameData.screenOrientation for accurate tracking and localization.

Parameters​

androidJvm

valueThe underlying integer value of the orientation

See also​

FrameData.screenOrientation

Entries​

UNKNOWN[androidJvm]
UNKNOWN
Orientation is unknown or not yet determined
PORTRAIT[androidJvm]
PORTRAIT
Device held upright in portrait mode
PORTRAIT_UPSIDE_DOWN[androidJvm]
PORTRAIT_UPSIDE_DOWN
Device held upside-down in portrait mode
LANDSCAPE_RIGHT[androidJvm]
LANDSCAPE_RIGHT
Device rotated 90° clockwise from portrait (landscape)
LANDSCAPE_LEFT[androidJvm]
LANDSCAPE_LEFT
Device rotated 90° counter-clockwise from portrait (landscape)

Types​

NameSummary
Companion[androidJvm]
object Companion

Properties​

NameSummary
entries[androidJvm]
val entries: EnumEntries<Orientation>
Returns a representation of an immutable list of all enum entries, in the order they're declared.
name[androidJvm]
val name: String
ordinal[androidJvm]
val ordinal: Int

Functions​

NameSummary
valueOf[androidJvm]
fun valueOf(value: String): Orientation
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
values[androidJvm]
fun values(): Array<Orientation>
Returns an array containing the constants of this enum type, in the order they're declared.