iOS SDK — IngevoraMirage

iOS SDK

Important: The iOS SDK is coming soon. It is not available yet, and there is nothing to install today. Until it ships, use the Delivery API from your own server.

What it isThe iOS SDK will be a Swift library for iOS apps. It will fetch your workspace's published face lenses and screen effects and draw them in your app. It will follow the same format and drawing rules as the studio's live preview, so it is meant to draw what your designers see in the editor.What it will do

Fetch with your key. It will call the delivery API with an API key you issue for the app: one key for each app.

Check every file. Before it uses a package, it will check the manifest's SHA-256 and the SHA-256 of every image, as Downloading safely describes.

Cache by version. A version it has checked will be kept on the device, so it isn't downloaded again.

Skip what it can't draw. A version that needs a newer engine than the SDK has will be refused, not guessed at.

Draw face lenses on the camera. Layers will follow the tracked face, and face triggers will fire from the face's own signals.

Play screen effects in an overlay above your app's own screens, for the effect's length, and tell your app when an effect has finished.

Take your app's events. Your app will send its own event names, such as round.start, and the triggers that listen for them will run.

Load test links in debug builds only. A debug build will be able to show a draft from Test on phone; a release build never will.

Details may change before the first release. This page will say when the SDK is available.Until it shipsYou can build on the delivery API today:

Keep an API key on your own server, never in your iOS app. See API keys.

Your server resolves the ids your app uses with the Delivery API and caches the answers.

Your app asks your server, downloads the manifest and the images, and checks every SHA-256 before using them. See Downloading safely.

Your app draws the package itself, following the published format.

Swift's Codable ignores fields it doesn't know, which is what you want for the delivery API's answers: new fields can appear at any time.Prepare now

Collect your ids. The Developers page in the editor lists every face lens and screen effect in your workspace, with its id and latest version.

Agree on event names. Decide with your designers which host events your app will send, such as round.start, so their triggers listen for the right names. See Triggers and your events.

Choose latest or pinned. Decide, item by item, whether your app should follow every publish or stay on a version you have checked. See Versions, latest and pinned.

Plan for errors. Keep a cached version to fall back on. See Errors and limits.

Android SDK — the same, for Android.

Delivery API — what to use today.