Vive Face Tracker Developer User Guide
- June 6, 2024
- Vive
Table of Contents
Vive Face Tracker Developer User Guide
Developers can develop applications for the Face Tracker (also known as Lip Tracker) and the Eye Tracker using the same SDK.
Download the SDK and Runtime (SRanipal) https://hub.vive.com/download
The SDK folder structure shows 3 supported APIs, Native C, Unity and UE4:
SDK Folder Structure
SRanipal_SDK_Guide.pdf 01_C
-
Document\Document_C.lnk (C API reference)
-
SRanipal
-
SRanipal_Sample
-
SRanipal_Sample.sln
02_Unity -
Document
-
Geting Started with SRanipal in Unity.pdf
-
Document_Unity.lnk (SRanipal API reference)
-
Vive-SRanipal-Unity-Plugin.unitypackage · Geting Started with SRanipal in Unity.pdf
-
Document_Unity.lnk (SRanipal API reference)
-
Vive-SRanipal-Unity-Plugin.unitypackage
03_Unreal -
Document
-
Getting Started with SRanipal in Unreal.pdf
-
Document_Unreal.lnk (SRanipal Unreal API reference)
-
Vive-SRanipal-Unreal-Plugin.zip
Install and run the SRanipal Runtime:
-
Launch SR_Runtime until the status icon appears in the notification tray:
The status icon reflects the status of your tracking devices:
-
Start SteamVR (if not running already)
-
Put on your HMD.
-
Done. You are ready to develop face-aware applications.
-
If you want to quit the runtime, right-click on the status icon and click Quit to stop SR_Runtime.
Developing with the Unity Plugin
- Open unity and create a new 3D project.
- Select Asset > Import Package > Custom Package.
- Select the Vive-SRanipal-Unity-Plugin.unitypackage
- In the Importing Package dialog, ensure that all package options are selected and click on Import.
- Accept any API upgrades if prompted.
Opening a sample scene
-
In the Unity Project window, find the scene file Sample.unity in Asset > ViveSR > Scenes
-
Click Play.
-
For details about this sample, please refer to
$(SRANIPAL)2_UnityPluginGetting Started with SRanipal in Unity.docx -
For details about this API, please refer to $(SRANIPAL)2_UnityDocument_Unity.lnk
Developer Forum: https://forum.vive.com/forum/78-vive-eye-tracking-sdk/
Read User Manual Online (PDF format)
Read User Manual Online (PDF format) >>