Skip to main content

DepthModule

Class

Provides access to a DepthFrameSession on Spectacles device.

  • Available on all platforms
1 platform note
  • SnapchatFully supported
  • SPECSFully supported
  • Camera Kit WebFully supported
  • Camera Kit MobileFully supported

Applies to all platforms

  • Restricted when the Lens uses internet-connected APIs (see Privacy Restrictions).

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

  • All platforms. Restricted when the Lens uses internet-connected APIs (see Privacy Restrictions)

Exposes user data

Provides access to a DepthFrameSession on Spectacles device.

Index

Remarks

Used for requesting DepthFrameData.

Example

const depthModule = require("LensStudio:DepthModule");

const session = depthModule.createDepthFrameSession();

Extends

Properties

name

name: string

The name of the Asset in Lens Studio.

Default Value

""

Inherited from

Asset.name


uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

Asset.uniqueIdentifier

Methods

createDepthFrameSession()

createDepthFrameSession(): DepthFrameSession

Exposes user data

Create a DepthFrameSession.

Returns

DepthFrameSession


getTypeName()

static getTypeName(): TypeName<DepthModule>

Exposes user data

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<DepthModule>

Overrides

Asset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Asset.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

Asset.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

Asset.isSame

See also

Depth Module guide.