MiniTrackAR

Main class of the Image Tracking tracker.

Constructor

const tracker = new MiniTrackAR({
  licenseKey: 'YOUR_LICENSE_KEY',  // Required
  useFlannMatcher: false,          // Optional - use FLANN instead of BFMatcher
  cameraConstraints: { ... }       // Optional - custom camera constraints
})

Parameter	Type	Required	Description
licenseKey	string	Yes	Your Monolook license key
useFlannMatcher	boolean	No	Use FLANN matcher (default: false)
cameraConstraints	object	No	MediaTrackConstraints for the camera

Methods

Initialization

async init()

Initializes the WASM module and validates the license against the Monolook server.

await tracker.init()

Possible errors:

• "Monolook license key required"
• "License validation failed: License expired"
• "License validation failed: Domain not allowed"
• "Build version 0001PR is not authorized"

Target management

async addTarget(id, imageElement)

Adds an image as a tracking target.

const img = new Image()
img.src = './marker.jpg'
await new Promise(r => { img.onload = r })
await tracker.addTarget('myMarker', img)

Parameter	Type	Description
id	string	Unique identifier for the target
imageElement	HTMLImageElement	Marker image

removeTarget(id)

Removes a target and frees its data.

tracker.removeTarget('myMarker')

clearTargets()

Removes all targets.

tracker.clearTargets()

setActiveTargets(targetIds)

Sets which targets are active for detection. Inactive targets remain in memory but are not searched for. See Selective Tracking.

tracker.setActiveTargets(['marker1', 'marker3'])

Parameter	Type	Description
targetIds	string[]	IDs of targets to activate

State

isTracking(id)

Checks if a specific target is being tracked.

if (tracker.isTracking('myMarker')) {
  // The marker is visible
}

getTrackedTargets()

Returns the list of IDs of currently tracked targets.

const active = tracker.getTrackedTargets()
// ['marker1', 'marker3']

Control

async start()

Activates the camera and begins tracking.

await tracker.start()

stop()

Stops tracking.

tracker.stop()

setMatcherType(useFlann)

Switches between BFMatcher and FLANN at runtime.

tracker.setMatcherType(true)  // Use FLANN
tracker.setMatcherType(false) // Use BFMatcher

destroy()

Stops tracking, releases all resources, and cleans up the WASM.

tracker.destroy()

Events

on(event, callback)

Subscribes to an event. Returns a function to unsubscribe.

const unsub = tracker.on('found', (id) => {
  console.log('Found:', id)
})

// Unsubscribe
unsub()

off(event, callback)

Unsubscribes from an event.

tracker.off('found', myHandler)

Available events

Event	Callback	Description
'found'	(id: string)	Marker detected
'lost'	(id: string)	Marker lost
'pose'	(pose: object)	Pose update
'frame'	()	Each frame
'error'	(error)	Error

Pose object

tracker.on('pose', (pose) => {
  pose.position       // { x, y, z }
  pose.forward         // Direction vector
  pose.up              // Up vector
  pose.rotationMatrix  // Rotation matrix
})