Skip to main content

AnchorModule.AnchorSessionOptions

Class

Options for opening an AnchorSession.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
  • SnapchatNot supported — Available on SPECS only
  • SPECSFully supported
  • Camera Kit WebNot supported — Available on SPECS only
  • Camera Kit MobileNot supported — Available on SPECS only

Platform details

  • Snapchat — Not supported — Available on SPECS only.

  • SPECS — Fully supported.

  • Camera Kit Web — Not supported — Available on SPECS only.

  • Camera Kit Mobile — Not supported — Available on SPECS only.

Since Lens Scripting v376

Options for opening an AnchorSession.

Index

Extends

Constructors

Constructor

new AnchorSessionOptions(): AnchorSessionOptions

Returns

AnchorSessionOptions

Overrides

ScriptObject.constructor

Properties

area

area: string

SPECS

A label for the physical space you're anchoring in (e.g. "home" vs "office"). Keep areas under ~250 m².

Since

Lens Scripting Version 376

Default Value

null
@snapOS

Methods

getTypeName()

static getTypeName(): TypeName<AnchorSessionOptions>

SPECS

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<AnchorSessionOptions>

Since

Lens Scripting Version 376

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame