Skip to main content

TrackingStatus

Class

TrackingStatus signals changes in data availability for the tracked object.

  • 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.

Since Lens Scripting v354

Index

Extends

Properties

onChange

readonly onChange: event1<boolean, void>

Event fired when the tracking is either started or stopped.

Since

Lens Scripting Version 354


onStarted

readonly onStarted: event0<void>

Event fired when the tracked object is found.

Since

Lens Scripting Version 354


onStopped

readonly onStopped: event0<void>

Event fired when the tracked object is lost or the tracking is suspended (e.g. when the component is disabled or destroyed).

Since

Lens Scripting Version 354

Methods

getTypeName()

static getTypeName(): TypeName<TrackingStatus>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<TrackingStatus>

Since

Lens Scripting Version 354

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame