Skip to main content

CameraModule.Result

Enum

Result codes from camera session operations.

  • 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

Result codes from camera session operations.

Index

Remarks

StreamConfig.minFrameRate, outputWidth and outputHeight report invalid values by throwing, where they are assigned or at start(), rather than with a Result.

Enumeration Members

AlreadyStarted

AlreadyStarted: number

Exposes user dataSPECS

start() was called on a running session.

Since

Lens Scripting Version 368


ErrorGeneric

ErrorGeneric: number

Exposes user dataSPECS

The camera service could not be reached, could not open the camera or could not apply a setConfig change, or a session limit was reached. A Lens can run up to three streaming sessions across all its CameraModules, at most one at 2016x1512, or one streaming session and one capture session.

Since

Lens Scripting Version 368


InvalidArgument

InvalidArgument: number

Exposes user dataSPECS

A required value is missing or out of range: no stream, invalid ConfigKey values, or a non-finite crop.

Since

Lens Scripting Version 368


InvalidConfig

InvalidConfig: number

Exposes user dataSPECS

The request does not fit the stream: the stream's operation does not match the session (for example a Capture capability on a StreamingSession), or the key cannot be used here.

Since

Lens Scripting Version 368


NotInitialized

NotInitialized: number

Exposes user dataSPECS

The session's camera client is not available.

Since

Lens Scripting Version 368


NotStarted

NotStarted: number

Exposes user dataSPECS

The session is not started.

Since

Lens Scripting Version 368


SessionStopped

SessionStopped: number

Exposes user dataSPECS

The session was disconnected and cannot be used again; create a new session.

Since

Lens Scripting Version 368


Success

Success: number

Exposes user dataSPECS

The call succeeded.

Since

Lens Scripting Version 368