Class CameraKit

The entry point to the CameraKit SDK's API. Most of CameraKit's features are accessed via this class.

Applications obtain an instance of CameraKit by calling bootstrapCameraKit.

Example

const cameraKit = await bootstrapCameraKit(config)

Then this class can be used to:

  • Create a CameraKitSession instance, which provides the API for setting up media inputs, applying Lenses, and obtaining rendered <canvas> outputs.
  • Query for lenses using LensRepository.
  • Listen for lens usage metrics events using MetricsEventTarget.

Hierarchy

  • CameraKit

Properties

lenses metrics lensRepository

Methods

createSession destroy

Properties

Readonly lenses

lenses: {
    repository: LensRepository;
}

Type declaration

Deprecated

Use lensRepository

Readonly metrics

metrics: TypedEventTarget<LensMetricsEvents> = ...

Business metrics (e.g. each time a lens is viewed) are emitted here.

Readonly lensRepository

lensRepository: LensRepository

Used to query for lenses and lens groups.

Methods

createSession

  • Create a CameraKitSession.

    This initializes the rendering engine and returns a CameraKitSession instance, which provides access to Lens rendering.

    Parameters

    Returns Promise<CameraKitSession>

    Example

    const cameraKit = await bootstrapCameraKit(config)
    const session = await cameraKit.createSession()

    const lens = await cameraKit.lensRepository.loadLens(lensId, groupId)
    session.applyLens(lens)

destroy

  • Destroys all sessions and frees all resources.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc