Skip to main content

CameraModule.MetadataKey

Enum

Typed keys for querying per-frame metadata.

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

Since Lens Scripting v368Exposes user data

Typed keys for querying per-frame metadata.

Index

Remarks

Used with CameraModule.Frame#getMetadata. Returns null if the key is not available for the current frame. TimestampNs is present on every frame; Iso, ExposureTimeNs, and FrameRate are present only when the camera service reports them for that frame — always handle null. New keys may be added in future versions without breaking existing code.

Enumeration Members

ExposureTimeNs

ExposureTimeNs: number

Exposes user dataSPECS

Exposure time used for the frame, in nanoseconds.

Since

Lens Scripting Version 368


FrameRate

FrameRate: number

Exposes user dataSPECS

The camera's frame rate, in Hz.

Since

Lens Scripting Version 368


Iso

Iso: number

Exposes user dataSPECS

Sensor sensitivity used for the frame.

Since

Lens Scripting Version 368


TimestampNs

TimestampNs: number

Exposes user dataSPECS

Capture time of the frame in nanoseconds, CLOCK_MONOTONIC. Present on every frame.

Since

Lens Scripting Version 368