Interface CameraKitBootstrapConfiguration

Configuration which must be provided when calling bootstrapCameraKit. These values are used to create various CameraKit components.

interface CameraKitBootstrapConfiguration {
    apiToken: string;
    logger?: "noop" | "console";
    logLevel?: "error" | "warn" | "log" | "info" | "debug";
    lensPerformance?:
        | EstimatedLensPerformance
        | Promise<EstimatedLensPerformance>;
    lensCoreOverrideUrls?: { wasm: string; js: string };
    wasmEndpointOverride?: string;
    analyticsId?: string;
    fonts?: Font[];
    lensHttpHandler?: LensHttpHandler;
}

Properties

apiToken logger? logLevel? lensPerformance? lensCoreOverrideUrls? wasmEndpointOverride? analyticsId? fonts? lensHttpHandler?

Properties

apiToken

apiToken: string

Long-lived token granting your application access to CameraKit APIs. This is found in the SnapKit Dev Portal, where it's called the API Token.

Optionallogger

logger?: "noop" | "console"

Determine where to print CameraKit log messages. By default no logs will be printed.

CameraKit emits log messages to help diagnose and root cause issues that may occur during the development of a host application. The printing of these can be controlled via the following options:

  • noop: log messages are ignored.
  • console: log messages are printed to console.

OptionallogLevel

logLevel?: "error" | "warn" | "log" | "info" | "debug"

Log only if a logged entry level is greater than or equal to this level. Here is the order of levels: error > warn > log = info > debug. Default value is "info".

OptionallensPerformance

lensPerformance?: EstimatedLensPerformance | Promise<EstimatedLensPerformance>

Some lenses may decide to modify their behavior based on the performance of the current environment. If you are using such lenses, providing an estimation of lens performance may lead to better user experience (especially on low-performance devices).

Running the estimateLensPerformance function will run benchmarks and estimate an appropriate lens performance cluster (i.e. a performance rating) based on the current environment.

Lower cluster = worse expected performance capability.

Example

import { bootstrapCameraKit, estimateLensPerformance } from '@snap/camera-kit`

const cameraKit = await bootstrapCameraKit({
  apiToken: '...',
  lensPerformance: estimateLensPerformance(),
})

OptionallensCoreOverrideUrls

lensCoreOverrideUrls?: { wasm: string; js: string }

In recommended production deployments, the WebAssembly assets required by CameraKit will be downloaded from an optimized CDN. But sometimes (e.g. during development or within a CI pipeline), it may be necessary to download these assets from somewhere else.

This configuration option allows the application to specify URLs to be used for both the WebAssembly and JS glue file that are used to run and interact with CameraKit's rendering engine.

OptionalwasmEndpointOverride

wasmEndpointOverride?: string

In recommended production deployments, the WebAssembly assets required by CameraKit will be downloaded from an optimized CDN. But sometimes during development or within a CI pipeline, it may be necessary to download these assets from somewhere else. With a provided wasmEndpointOverride, asset URLs will be automatically generated based on this root endpoint.

OptionalanalyticsId

analyticsId?: string

Applications may optionally provide a unique identifier called analyticsId. This ID would enable Camera Kit to improve data reporting and accuracy and to better support potential needs related to an application's lens and user analytics.

Optionalfonts

fonts?: Font[]

An array of fonts to be used by Camera Kit for text rendering.

Lenses usually have their own font assets, but emojis are often not embedded. As a result, you may need to provide additional fonts (e.g., an emoji font) to ensure all glyphs render correctly.

Example

fonts: [
  {
    name: 'EmojiFont',
    data: emojiFontArrayBuffer, // Your emoji font data goes here
  },
]

OptionallensHttpHandler

lensHttpHandler?: LensHttpHandler

An optional custom HTTP handler for requests made by a Lens.

This handler allows you to intercept and customize the behavior of HTTP requests, such as adding authentication headers, logging request details, or replacing the default HTTP library used by the Lens system.

If not specified, the Lens system will use a default HTTP implementation.

Example

Here is an example of how to configure a custom LensHttpHandler to add an authentication token:

const customLensHttpHandler: LensHttpHandler = async (url, init, lensRequest) => {
  // Add an authentication token to the headers
  const sessionToken = await getAuthToken();
  const updatedInit = {
    ...init,
    headers: {
      ...init.headers,
      'Authorization': `Bearer ${sessionToken}`,
    },
  };

  // Log the request details for debugging
  console.log(`Requesting ${lensRequest.url} from lens: ${lensRequest.lens.name}`);

  // Use fetch to perform the HTTP request
  return fetch(url, updatedInit);
};

const cameraKit = bootstrapCameraKit({
  apiToken,
  lensHttpHandler: customLensHttpHandler,
});

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR