Notification Data API

Send Data Units

Create Anchor Data Unit

Description

Subclass of BaseNotificationData. When you are call the StickObject method will be need pass this data to ARMOD SDK.

Return

Parameters

Connection
Description
TrackableType
You should set trackabletype when stick type is ByTackableTYpe
Position
Anchor position(world position)
Rotation
Anchor rotation(worldrotation)
Offset
Anchor offset position(local position)
Virtual Object
You want to placed object
Event Target
Objects stored in response to events
Action Name
Current action name
Base data
Addition string data
Event Name
The name of callback to trigger graph custom event
Event Name With Result
The name of callback to trigger graph custom event inculde data

Create AR Algorithm Life Data Unit

Description

Subclass of BaseNotificationData. When you are call the ChangeARAlgorithmLife method will be need pass this data to ARMOD SDK.

Return

Parameters

Connection
Description
ARAlgorithmType
AR algorithm type
ARAlgorithmOperator
AR life cycle operation types
Mixed
Enable hybrid algorithm
Event Target
Objects stored in response to events
Action Name
Current action name
Base data
Addition string data
Event Name
The name of callback to trigger graph custom event
Event Name With Result
The name of callback to trigger graph custom event inculde data

Create AR Occlusion Data Unit

Description

Subclass of BaseNotificationData. When you are call the TryAcquireAROcclusionFrame method will be need pass this data to ARMOD SDK.

Return

Parameters

Connection
Description
Occlusion Data Type
Human Stencil / Depth or Enviroment
Event Target
Objects stored in response to events
Action Name
Current action name
Base data
Addition string data
Event Name
The name of callback to trigger graph custom event
Event Name With Result
The name of callback to trigger graph custom event inculde data

Create Try Acquire Current Frame Data Unit

Description

Subclass of BaseNotificationData. When you are call the TryAcquireCurrentFrame method will be need pass this data to ARMOD SDK.

Return

Parameters

Connection
Description
Occlusion Data Type
Human Stencil / Depth or Enviroment
Event Target
Objects stored in response to events
Action Name
Current action name
Base data
Addition string data
Event Name
The name of callback to trigger graph custom event
Event Name With Result
The name of callback to trigger graph custom event inculde data

Create Try Acquire App Info Data Unit

Description

Subclass of BaseNotificationData. When you are call the TryAcquireAppInfo method will be need pass this data to ARMOD SDK.

How to get the data from native app?

write callback action to Event name With Result

Return

Parameters

Connection
Description
GetInfoType
Opcode to get app info
Event Target
Objects stored in response to events
Action Name
Current action name
Base data
Addition string data
Event Name
The name of callback to trigger graph custom event
Event Name With Result
The name of callback to trigger graph custom event inculde data

Create Open BuiltIn Browser Data Unit

Description

Subclass of BaseNotificationData. When you are call the OpenBuiltInBrowser method will be need pass this data to ARMOD SDK.

Parameters

Param
Type
Description
Url
String
URL of the webpage you want to open
Data
String
Additional data

Create Base Data Unit

Description

As its name suggests, it is the base class of all Notification Data.

Return

Parameters

Param
Description
Event Target
Objects stored in response to events
Action Name
Current action name
Base data
Addition string data
Event Name
The name of callback to trigger graph custom event
Event Name With Result
The name of callback to trigger graph custom event inculde data

Callback Response Units

Marker Data Response Unit

Description

Subclass of BaseNotificationData. When using image tracking, the ARMOD SDK Event Receiver function will receive this type of data.

Parameters

TrackingState
Description
None
The image is not being tracked. Note that this may be the initial state when the image is first detected.
Limited
The image is being tracked, but not as effectively. The situations in which an image is considered Limited instead of Tracking depend on the underlying AR framework. Examples that could cause Limited tracking include:
  • Obscuring the image so that it is not visible to the camera.
  • The image is not tracked as a moving image. This can happen, for example, if the maxNumberOfMovingImages is exceeded.
Tracking
The underlying AR SDK reports that it is actively tracking the image.
Param
Type
Description
MarkerName
String
Current tracking or lost image's name
MarkerState
MarkerTrackingState
Current tracking state
BaseData
String
Additional data, generally not used
MarkerTrackable
Transform
To track the transform of the image, you can set the parent of our AR virtual object to it.

Immersal Data Response Unit

Description

Subclass of BaseNotificationData. When using image tracking, the ARMOD SDK Event Receiverfunction will receive this type of data.

Parameters

Param
Type
Description
MapId
int
Current map id
LocalizerPose
LocalizerPose
You should set trackabletype when stick type is ByTackableTYpe

Focus Data Response Unit

Description

Subclass of BaseNotificationData. When using image tracking, the ARMOD SDK Event Receiver function will receive this type of data.

Parameters

Param
Type
Description
FocusPos
Vector3
Focus's position
FocusRot
Vector3
Focus's rotation
FocusState
FindingType
Current tracking status

Face Mesh Data Response Unit

Description

Subclass of BaseNotificationData. When using image tracking, the ARMOD SDK Event Receiver function will receive this type of data.

Parameters

Param
Type
Description
TrackingId
String
Current map id
FaceGameObject
GameObject
You should set trackabletype when stick type is ByTackableTYpe
FaceTrackingState
FaceTrackingState
Current face tracking state
vertices
NativeArray<Vector3>
face mesh vertices
indices
NativeArray<int>
face mesh indices
normals
NativeArray<Vector3>
face mesh normals
uvs
NaativeArray<Vector2>
face mesh uvs
Last modified 1mo ago