Skip to content
This repository was archived by the owner on Mar 27, 2026. It is now read-only.

Commit ab01423

Browse files
Update TYPES.md
1 parent 981a8bf commit ab01423

1 file changed

Lines changed: 20 additions & 29 deletions

File tree

docs/TYPES.md

Lines changed: 20 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@
44

55
An `AugmentedFaceModel` is a structure meant to be used by the `addAugmentedFace` method. It has two properties:
66

7-
- model: `URL`/`path` (inside android's assets folder) referencing a GLB object.
8-
- texture: (nullable) `URL`/`path` (inside android's assets folder) referencing an image object.
7+
- **model**: `URL`/`path` (inside android's assets folder) referencing a GLB object.
8+
- **texture**: (nullable) `URL`/`path` (inside android's assets folder) referencing an image object.
99

1010
Example:
1111
`{model: 'models/fox.glb', texture: 'textures/freckles.png'}`
1212

13+
------------
14+
1315
### Plane
1416

1517
A plane is any touchable surface discovered in the AR session.
@@ -18,11 +20,14 @@ When the user taps on a plane it is automatically saved and an index is sent bac
1820
You can access the value using `event.planeId`.
1921
It can be used to host a cloud anchor or to place objects on tap.
2022

23+
------------
2124

2225
### CloudAnchor
2326

2427
It is a simple structure containing the CloudAnchorId in the `event.anchorId` value.
2528

29+
------------
30+
2631
### FeatureMapQuality
2732

2833
The FeatureMapQuality is an indicator used to get sure there is enough quality in the environment scan previous to host an anchor.
@@ -36,35 +41,31 @@ It is a value from 0 to 2 indicating the quality:
3641
You can access the value via `event.quality`
3742
Host the anchor when the event returns at least 1.
3843

44+
------------
45+
3946
### VideoRecording
4047

4148
After `stopVideoRecording` is called (`startVideoRecording` must be called first), the video is copied into storage and its path is returned when the promise fulfills.
4249

4350
You can get the path via `response.path`
4451

52+
------------
4553

4654
### Screenshot
4755

4856
When `takeScreenshot` is called, the session's current view is copied into a bitmap and saved as a JPEG image. When the promise fulfills you can access the image via `response.path`
4957

58+
------------
5059

5160
### Model
5261

5362
The `addObject` method is used to insert a renderable into scene, it supports a `Model` object described as follows:
5463

55-
##### name
56-
57-
It must be an URL pointing to a glb asset.
58-
59-
##### anchorId
60-
61-
It can be a CloudAnchorId or a PlaneId (returned by onTapPlane)
62-
63-
##### isCloudAnchor
64-
65-
`boolean`, if true then the `anchorId` value will be taken as a CloudAnchorId and the session will attempt to resolve it, triggering `onAnchorResolve` if succeed.
64+
- **name**: It must be an URL pointing to a glb asset.
65+
- **anchorId**: It can be a CloudAnchorId or a PlaneId (returned by onTapPlane)
66+
- **isCloudAnchor**: `boolean`, if true then the `anchorId` value will be taken as a CloudAnchorId and the session will attempt to resolve it, triggering `onAnchorResolve` if succeed. Otherwise, if `false` , `anchorId` will be taken as `Plane` and the object will be attached to it.
6667

67-
Otherwise, if `false` , `anchorId` will be taken as `Plane` and the object will be attached to it.
68+
------------
6869

6970
### LocationMarker
7071

@@ -73,22 +74,12 @@ There are two types of tags currently supported, showing a label or a simple one
7374

7475
The location marker structure is:
7576

76-
##### title
77+
- **title**: `String` , it is the label to be shown by the marker.
78+
- **lat**: `Double`, the latitude value.
79+
- **lng**: `Double`, the longitude value.
80+
- **isAnchor**: `boolean`, if `false` the title is shown in the marker, if `true` then the icon marker is used.
7781

78-
`String` , it is the label to be shown by the marker.
79-
80-
##### lat
81-
82-
`Double`, the latitude value.
83-
84-
##### lng
85-
86-
`Double`, the longitude value.
87-
88-
##### isAnchor
89-
90-
`boolean`, if `false` the title is shown in the marker, if `true` then the icon marker is used,
82+
------------
9183

9284
### CloudAnchorId
93-
9485
A `String` value returned by the `onAnchorHost` event, you can use it to resolve the same anchor lately or share it with friends to get the same experience.

0 commit comments

Comments
 (0)