Asset Catalog Format Reference: AR Reference Image

The image file for an ARReferenceImage.

Extension

.arreferenceimage

Folder Contents

A .heif (High Efficiency Image Format), .png, .jpg, or .tiff file.

Contents.json File (Required)

Metadata and attributes for the image (Table 7-1.)

**Table 7-1**AR reference image tags
Key	Type	Description
`info`	Dictionary	Metadata for the author and format version of the asset catalog.
`author`	String	Use your bundle ID.
`version`	Number	The format version of the asset catalog. Use `1`.
`images`	Array of one dictionary	The image file for the `ARReferenceImage`.
`filename`	String	The `.heif`, `.jpg`, `.png`, or `.tiff` file for the image.
`idiom`	Slot component	The device type for the image. For the values, see idiom in Image Set Type.
`properties`	Dictionary	Properties for the image.
`unit`	String	The unit type of the `width` property. For the values, see unit below.
`width`	Number	The physical width of the image.

Values for Enumerated Tags

unit

An optional unit type used to convert the value of the width property to meters. Valid unit types are:

meters
centimeters
feet
inches
yards

A value of meters is used if the tag is not specified.

Sample Contents.json File

        {
   "images" : [
      {
         "idiom" : "universal",
         "filename" : "llama farm.heif"
      }
   ],
   "properties" : {
      "width" : 33,
      "units" : "inches"
   },
   "info" : {
      "author" : "com.developerName",
      "version" : 1
   }
}

      