Skip to main content

LocationProximityStatus

Enum

Used by DeviceLocationTrackingComponent to indicate the user's distance from the landmarker location.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Used by DeviceLocationTrackingComponent to indicate the user's distance from the landmarker location. See the Landmarker guide for more information.

Index

Example

//@input Component.DeviceLocationTrackingComponent locationTrackingComponent

if (script.locationTrackingComponent.locationProximityStatus == LocationProximityStatus.WithinRange) {
print("user is in range to see the landmarker");
} else {
print("user's location is unknown or user is too far away");
}

Enumeration Members

OutOfRange

OutOfRange: number

User is too far away from the landmarker location to track it.


Unknown

Unknown: number

User's distance cannot be determined or has not been determined yet.


WithinRange

WithinRange: number

User is close enough to the landmarker location to begin tracking.