QuickLookSession

class QuickLookSession implements ARSession, OptionGetters<QuickLookSessionOptions>

AR Session using Apple AR Quick Look Viewer

See:

• https://developer.apple.com/augmented-reality/quick-look/

Methods

isAvailablestatic
enter

constructor

new QuickLookSession(view3D, options, options.allowsContentScaling, options.canonicalWebPageURL, options.applePayButtonType, options.callToAction, options.checkoutTitle, options.checkoutSubtitle, options.price, options.custom, options.customHeight)

Create new instance of QuickLookSession

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
view3D	View3D			Instance of the View3D
options	object	✔️	{}	Quick Look options
options.allowsContentScaling	boolean	✔️	true	Whether to allow content scaling.
options.canonicalWebPageURL	string | null	✔️		The web URL to share when the user invokes the share sheet. If null is given, the USDZ file will be shared.
options.applePayButtonType	string | null	✔️		Type of the apple pay button in the banner. See QUICK_LOOK_APPLE_PAY_BUTTON_TYPE
options.callToAction	string | null	✔️		A text that will be displayed instead of Apple Pay Button. See Official Guide Page
options.checkoutTitle	string | null	✔️		Title of the previewed item. See Official Guide Page
options.checkoutSubtitle	string | null	✔️		Subtitle of the previewed item. See Official Guide Page
options.price	string | null	✔️		Price of the previewed item. See Official Guide Page
options.custom	string | null	✔️		Custom URL to the banner HTML. See Official Guide Page
options.customHeight	string | null	✔️		Height of the custom banner. See QUICK_LOOK_CUSTOM_BANNER_SIZE

Methods

isAvailable

static

Return the availability of QuickLookSession.
QuickLook AR is available on iOS12+

Returns: Promise

• A Promise that resolves availability of this session(boolean).

enter

Enter QuickLook AR Session