AR Base API

TryAcquireSDKVersion

Description

Get current sdk version

Description

String SDK version string[e.g. 0.0.1]
1
public string TryAcquireSDKVersion()
Copied!

SetFocusAlgorithmState

Description

Turn on and off the Focus algorithm

Parameters

Param
Type
Description
_state
bool
True:Turn on,False:Turn off
1
public void SetFocusAlgorithmState(bool _state)
Copied!

StickObject

Description

Place the virtual object into the world

Parameters

Param
Type
Description
_anchorNotification
Data sent to the anchor manager
1
public void StickObject(AnchorNotificationData _anchorNotification)
Copied!

ARRaycast

Description

Cast a ray from a point in screen space against trackables, i.e., detected features such as planes.
Parameters
Param
Type
Description
_screenPoint
Vector3
The point, in device screen pixels, from which to cast.
_trackableType
TrackableTypeEnum
The types of trackables to cast against.
_callback
Action<Pose>
Contents are replaced with the raycast results, if successful.
1
public void ARRaycast(Vector3 _screenPoint,TrackableTypeEnum _trackableType,Action<Pose> _callback)
Copied!

MakeContentAppearAt

This does not move the content; instead, it moves and orients the ARCamera. such that the content appears to be at the raycast hit position.

Description

Makes content appear to have orientation rotation relative to the Camera.

Parameters

Param
Type
Description
_content
Transform
Your content gameObject's transform
_position
Vector3
Your content position
_rotation
Quaternion
Your content rotation
1
public void MakeContentAppearAt(Transform _content,Vector3 _position,Quaternion _rotation)
Copied!

ExitAR

Description

Exit the AR
1
public void ExitAR()
Copied!

ChangeARAlgorithmLife

Description

Addition AR algorithm, It will allow multiple algorithms to be mixed.

Parameters

Param
Type
Description
_data
The AR life controller data
1
public void ChangeARAlgorithmLife(ARAlgorithmNotificationData _data)
Copied!

TryAcquireCurrentFrame

Description

Get current AR frame

Return

Texture A texture of current frame
It maybe null, plz attention
1
public Texture2D TryAcquireCurrentFrame()
Copied!

TryAcquireLightEstimateValue

Description

Get light estimate value

Return

light A light of unity
It maybe null, plz attention
1
public Light TryAcquireLightEstimateValue()
Copied!

CheckARAvailablility

Description

Check whether the current device supports ARKit or ARCore

Return

Bool True:Supports,False:otherwise
1
public bool CheckARAvailability()
Copied!

CheckFeatureAvailability

Description

Check AR features are support on current device

Return

Bool True:Supports,False:otherwise
1
public bool CheckFeatureAvailability(string _featureName)
Copied!
Feature Name
SimpleAR
ImageTracking
Anchors
CpuImages
EnvironmentProbes
ARCollaborationData
ARKitCoachingOverlay
ObjectTracking
FaceTracking
BodyTracking
BasicLightEstimation
HDRLightEstimation
PlaneClassification
Meshing
Depth
ThermalState

TryAcquireAROcclusionFrame

Description

Get AR Occlusion frame texture.

Return

Texture A texture of Unity
1
public Texture2D TryAcquireAROcclusionFrame(AROcclusionNotificationData _data)
Copied!
Last modified 30d ago