DepthModule
ClassProvides access to a DepthFrameSession on Spectacles device.
- Available on all platforms
- 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).
Exposes user data
Provides access to a DepthFrameSession on Spectacles device.
Index
Properties
Methods
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
uniqueIdentifier
readonlyuniqueIdentifier:string
Since
Lens Scripting Version 176
Inherited from
Methods
createDepthFrameSession()
createDepthFrameSession():
DepthFrameSession
Exposes user data
Create a DepthFrameSession.
Returns
getTypeName()
staticgetTypeName():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
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean
Inherited from
See also
Depth Module guide.