Skip to main content

CameraFrame

Class

Metadata about the current camera image of a CameraTextureProvider.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
1 platform note
  • SnapchatNot supported — Available on SPECS only
  • SPECSFully supported
    • Restricted when the Lens uses internet-connected APIs (see Privacy Restrictions).
  • 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. Restricted when the Lens uses internet-connected APIs (see Privacy Restrictions)

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

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

Exposes user data

Metadata about the current camera image of a CameraTextureProvider. Modeled after the VideoFrame web API.

Index

Example

let onNewFrame = cameraTexture.control.onNewFrame;
let registration = onNewFrame.add(function (frame) {
let cameraTs = frame.timestampSeconds;
});
script.createEvent('OnDestroyEvent').bind(function () {
onNewFrame.remove(registration);
});

Extends

Properties

timestampSeconds

readonly timestampSeconds: number

Exposes user dataSPECS

The timestamp (in seconds) in which this frame was received.

Methods

getTypeName()

static getTypeName(): TypeName<CameraFrame>

Exposes user dataSPECS

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

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