The Svrf SDK for Unity plugin starts by giving you access to the Svrf API, home to the largest search engine for augmented reality and virtual reality content. If you're looking to add face filters to your app, it also allows your users to stream ARKit and ARCore compatible 3D face filters.
To connect with the Svrf API, the Svrf SDK for Unity plugin utilizes the official Svrf C# library. You can use the class
SvrfApi to access the C# library's methods.
Looking for some help getting started? You can follow our recipe for Build a face filter app for Android with Unity and ARCore and it'll show you how to create a face filter app step-by-step.
The C# library can be used independently of the Svrf SDK for Unity. Parts of this guide include Unity specific references that may not apply to using the C# library independently.
The C# library can be used independently of the Svrf SDK for Unity. If you'd like to use the C# library independently, you can install it using NuGet.
Download the latest
Svrf.unitypackage from the releases page.
- Open Unity and create a new 3D project.
- Select Assets > Import Package > Custom Package.
- Select the
Svrf.unitypackagefile that you downloaded.
- In the Importing Package dialog, click Import.
For more information about importing packages in Unity, see the Importing custom Asset packages section in Unity docs.
Installation via NuGet is the preferable way. You can install it by searching for
Svrf package in the NuGet window or by typing the following command into the Package Manager console:
If you don't want to use NuGet, you can download
svrf-dlls.zip from our releases page. Then unzip the downloaded file and use
Svrf.dll in your project.
Our library depends on
Newtonsoft.Json package. All dependencies are handled automatically when installing via NuGet, but if you add
Svrf.dll manually, it has to be in the same folder with the