Object

ARKit

The component for adding an augmented reality (AR) experience to your article.

Properties

caption
string
(Required)

A string that describes the contents of the ARKit stage. This text is also used by VoiceOver for iOS and VoiceOver for macOS, if accessibilityCaption text is not provided.

role
string
(Required)

Always arkit for this component.

URL
uri
(Required)

A valid URL to a Universal Scene Description file (USD) file with extension .usdz, beginning with http://, https:// or bundle://.

accessibilityCaption
string

A caption that describes the augmented reality experience. The text is used for VoiceOver for iOS and VoiceOver for macOS. If accessibilityCaption is not provided, the caption value is used for VoiceOver for iOS and VoiceOver for macOS.

anchor

An object that defines vertical alignment with another component.

A object that defines an animation to be applied to the component.

behavior

An object that defines Behavior for a component, like Parallax or Springy.

conditional

An array of component properties that can be applied conditionally, and the conditions that cause them to be applied.

explicitContent
boolean

This property indicates that the component may contain explicit or graphic content.

hidden
boolean

A boolean value that determines whether the component is hidden.

identifier
string

An optional unique identifier for this component. If used, this identifier must be unique across the entire document. You will need an identifier for your component if you want to anchor other components to it.

layout
*

An inline ComponentLayout object that contains layout information, or a string reference to a ComponentLayout object that is defined at the top level of the document.

If layout is not defined, size and position will be based on various factors, such as the device type, the length of the content, and the role of this component.

style
*

An inline ComponentStyle object that defines the appearance of this component, or a string reference to a ComponentStyle object that is defined at the top level of the document.

Discussion

Augmented reality (AR) creates user experiences that add 2D or 3D elements to the live view from a device’s camera in a way that makes those elements appear to inhabit the real world. ARKit combines device motion tracking, camera scene capture, advanced scene processing, and display conveniences to simplify the task of building an AR experience. See ARKit.

Displaying ARKit content in Apple News requires an iOS device with an A9 or later processor.

Example

{ "components": [ { "role": "arkit", "caption": "Lunar Lander", "URL": "https://example.com/assets/lunar-lander/main.usdz" } ]}

Relationships

Inherits From