Getting Started

Up and Running in Zero Lines of Code

Importing VideoKit

To begin, import the SDK with the Unity Package Manager by adding the following lines to your Packages/manifest.json file:

{
  "scopedRegistries": [
    {
      "name": "NatML",
      "url": "https://registry.npmjs.com",
      "scopes": ["ai.natml", "ai.fxn"]
    }
  ],
  "dependencies": {
    "ai.natml.videokit": "0.0.14",
    ...
  }
}

Here's an example:

Specifying your Access Key

In order to use VideoKit, you need a NatML access key. Retrieve your access key from NatML Hub:

Once you have your access key, add it in Project Settings > NatML:

Using VideoKit requires an active NatML VideoKit subscription. You can try it out for free, but some functionality is limited. See the FAQ for more info.

Streaming the Camera Preview

In one GIF:

PreviousVideoKitNextRequirements

Last updated