FAQ

Answers to Common Questions.

What is NatDevice?
NatDevice is a cross-platform, low-latency camera and microphone streaming API. With NatDevice, you can quickly build high performance camera and audio pipelines for your apps.
Can I try NatDevice for free?
Yes! NatDevice offers an unlimited-time free trial. The trial does have certain limitations though:
Microphone streaming is not allowed, so AudioDevice.StartRunning will throw an exception.
Camera streaming is limited to use the camera's lowest-supported preview resolution, so the camera preview will look low-quality.
To lift these limitations, you will need an active NatML VideoKit subscription.
What is an Access Key?
In order to use NatDevice, you must authenticate yourself with a valid NatML access key. You can find your access key on your NatML Hub profile page. Once you retrieve the access key, place it in Project Settings > NatML.
Keep your access key secret! Anyone with your access key has almost full access to your NatML Hub account.
Will my apps require an internet connection?
No! When you build your app from Unity, NatDevice will generate a session token that contains all the necessary information needed for you to use the API. At runtime, this token is validated without an internet connection. Minimal information is used to generate the token, and no information is collected from your users at runtime. See the code:
NatDevice/NatDeviceProjectSettings.cs at main · natmlx/NatDevice
GitHub
Generating a NatDevice session token during builds.
What happens if I cancel my subscription?
If you cancel your VideoKit subscription, NatDevice will automatically revert back to the free trial mode in both the Unity Editor and in new builds from Unity.
Any existing apps you have built from Unity will continue to function as-is.

Preliminaries - Previous

Requirements

Next - Workflows

Requesting Permissions

Last modified 8mo ago