WebAR SDK vr1.5.3
  • Introduction
  • GETTING STARTED
    • SignUp and Get a License
    • Manage Your Licenses
    • Download WebAR SDK
    • Installing WebAR SDK
  • INTEGRATIONS
    • A-frame Integration
      • Build a Basic Surface Tracking Experience
      • Build a Marker Tracking Experience
      • Build an Advanced Portal Experience
    • Babylon.Js Integration
      • Build a Basic Surface Tracking Experience
      • Build a Basic Marker Tracking Experience
    • Unity Integration
      • Package Installation
      • Build a Basic Surface Tracking Experience
      • Build a Basic Marker Tracking Experience
      • Customize Loading Screen
      • Use Cases
      • Unity API References
    • PlayCanvas Integration
      • Build a Basic Surface Tracking Experience
      • Build a Basic Marker Tracking Experience
    • What Makes a Good Marker
  • API
    • API Ref 1.5.1
      • A-frame
      • SDK Configuration Properties
      • Functions
    • API Ref Unity
      • SDK Configuration Properties
      • Functions
    • API Customization
  • PUBLISH YOUR CREATION
    • Develop Locally
    • Launch the Experience
  • MORE INFORMATION
    • Pricing
    • Terms & Conditions
    • FAQs
  • Support
    • Contact Support
Powered by GitBook
On this page
  • Introduction
  • API Reference
  1. INTEGRATIONS
  2. Unity Integration

Unity API References

The APIs listed are available in the WebAR SDK package

PreviousUse CasesNextPlayCanvas Integration

Last updated 1 year ago

Introduction

The WebAR’s functions are accessed through the global variableWEBARSDK, which is available after the WebAR SDK script has been loaded. The following section provides information on the various API included in the unity package.

API Reference

  1. StartTracking:WEBARSDK.StartTracking() WEBARSDK.StartTracking(KeepARAfterLost)/

  2. StopTracking: WEBARSDK.StopTracking() WEBARSDK.StopTracking(KeepARVisible) keepARVisible = true, keeps AR object visible after user stops tracking. Default value is false.

  3. ResetTracking: WEBARSDK.ResetTracking()

  4. Tracking Found/Lost: open event attached to the “webarManager” prefab, user can subscribe directly.

  5. TrackingStatus: WEBARSDK.GetTrackingStatus() Status: TRACKING, TRACKED, STOPPED

  6. DetectedMarkerID: WEBARSDK.GetDetectedMarkerID()

  7. LostMarkerID: WEBARSDK.GetLostMarkerID()

  8. TrackingQuality: WEBARSDK.GetTrackingQuality() For surface tracking, Quality: HIGH, MEDIUM, LOW, LOST

  9. SelectedTracking: WEBARSDK.GetSelectedTracking()

  10. Disable AutoScale: WEBARSDK.DisableAutoScale()

Blippar Documentation Centre