This doument has instructions about how to assemble, operate, and use the Vive Port VR. Vive Port is a VR device that can be connect to the pc and acts like a controller with monitor where you can use it in VR apps.
- Where To Find
- In The Box
- How To Make It Works
- SDK
- Putting The Device Back
- More Documentations
Lab - shelf lef1
The box contains all the equipments which related to Vive Port VR. It has the box based on the steps. Step 1 is one big paper which introduces how to download and set up. Step 2-5 all is linked to different boxes. Below is the content list of the Vive-pro box.
- Headset with headset cable
- Controller (with lanyard) x2
- Power adapter x2
- Micro-USB cable x2
- Earphone hole cap x2
- Link box mounting pad
- Cleaning cloth
- Screws x4
- Documentations (SteamVR tracking 2.0 Base Stations mounting guide with different languages*2)
- The initial setup for the device is already done
- Take the VR main unit and connect it to the PC in the lab, with the compatible VIVE port.
- Adjust the VR to the size of your head using the wheel on the back.
- Use the micro USB cable with the adapter to charge the controller.
- No charging needed for the main unit.
- Power on the VR main unit using the power button on the left side, press and hold.
- Power on the controllers using the system button (the small last button), press and hold.
- Open the VR app or game and start navigating using the controllers.
- You can adjust the volume using the buttons on the left side speaker.
- To power off the controllers use the system button (the small last button)
- The information regarding the SDK and the developer tool can be found on the developer website for VIVE PRO.
- Supported platforms: PC, android and iOS.
- To get started you need to first create an account on VIVE website using this link
- After creating an account and signing in go to the same link and click become a developer.
- When signed in as developer you will find a menu on top with link "My Titles", click on it.
- Create new submission by clicking on the target platform for the desired content home/arcade or education.
- Type a name for the project and click next after agreeing on the terms.
- Fill in the form with the required information
VIVE Wave™, an open platform and toolset that will enable easy Android™ Mobile VR content development and high-performance device optimization for third party partners. The VIVE Wave™ SDK offers an open interface enabling interoperability between numerous mobile VR headsets and accessories, supporting mainstream game engines.
Download the VIVE Wave SDK from here.
The documentation you can find here.
Key Features of VIVE Wave™
-
Cross Platform
VIVE Wave™ runtime is a set of installable apk files supported on the platform with Android 7.1 or above. Users just need to install VIVE Wave™ apks on the VR devices and then can start to enjoy the VR world.
-
Less Customization
VIVE Wave™ runtime exists on Android application layer and has no any proprietary customization in Android framework and BSP.
-
High Performance Mode
VR devices just need to configure the specific CPU/GPU clock rate for Android VR mode and then VR devices just can get the high performance mode for VR rendering.
-
Standardized SDK interface
VIVE Wave™ provides easy-use and practical SDK APIs for VR contents development. Developers just need to spend minimal effort to be able to easily port contents to VIVE Wave™.
-
Versatile VR Features Optimized for Mobile VR
- <20ms motion to photon latency
- 3/6 DoF head and controller tracking
- Stereo rendering with Asynchronous TimeWarp
- Single buffer rendering with V-Sync scheduling
- Columns or Rows strip rendering
- Lens distortion correction and chromatic aberration correction
- Tracking prediction
- System 2D Overlay
- Unity and Unreal Plugin support
- Safety virtual wall
-
Various HMD Types Supported
- Smartphone slot-in HMD
- Smartphone tethered HMD
- Standalone HMD
-
Open Interface for Device Plugin
The vendors of VR accessory can easily develop their device service(driver) and plug in into VIVE Wave™ via apk installation. Per this way, VIVE Wave™ device can widely be expanded to fulfill the various demands of end users, such as: 3/6 DoF controller, Eye tracking, Hand tracking, and etc.
-
Qualcomm Snapdragon VR Embedded
VIVE Wave™ is fully integrated with Qualcomm SVR to leverage the hardware optimization of powerful Snapdragon SoC for mobile VR.
VIVE Wave™ provides the native SDK for the native VR app development or third-party engine integration. The key features include VR device tracking and input, and VR stereo rendering.
VIVE Wave™ provides the Unity SDK which fully integrated with VIVE Wave™ native runtime for Unity developers. Unity developers don’t need to take care the detailed VR affairs and can concentrate on VR content development.
VIVE Wave™ provides the Unreal SDK which fully integrated with Wave native runtime for Unreal development. Unreal developers don’t need to take care the detailed VR affairs and can concentrate on VR content development.
The PluginKit SDK is provided to help developers design a VR DeviceService. It encapsulates the communication between a VIVE Wave™ Server and a VR DeviceService. It also provides mechanisms for defining data transmission.
- The PluginKit has defined several interfaces to make it easier to develop drivers.
- A VR DeviceService can currently send three types of data (pose, button, and analog) to VR apps.
- When developing a VR DeviceService, you should define what role your device will play and what data type your device will send.
- You can decide how to use the tracker. For example, you can use the Android™ sensor manager (sensor.TYPE_GAME_ROTATION_VECTOR) as tracking data, and send the data to the VR App so the tracker will move with the smartphone. Or you can use a different path for the tracker. For example, the path could be a circle or a line.
- VRCameraInterface provides an interface to let developer customized their own camera device. Currently, we only support customized camera features on HMD.
The VROEMservice SDK is provided to help developers design a VROEMService. It encapsulates the communication between a VIVE Wave™ Server and a VROEMService. It also provides mechanisms for defining data transmission and making VIVE Wave™ Server to act.
- The VROEMservice defines several interfaces to make it easier to customize your own features.
- A VROEMService can get information from VIVE Wave™ Server.
- When developing a VROEMservice, you should implement the interface of IVROEMService and the interface of IVROEMService_api1.
- You can design your own behaviors according the information that is transmitted from VIVE Wave™ Server.
This SDK is used to build applications for pc, it consists of multiple sub SDK that can be downloaded and used.
The SRanipal SDK allows developers to track and integrate users’ eye and lip movements, empowering developers to read intention and model facial expression. The SRanipal SDK includes the required runtime which runs in the notification tray to show the current eye tracking status for VIVE Pro Eye. Plugins for Unreal and Unity are included in the SRanipal SDK along with sample code for native C development. You can find more details here
SRanipal SDK can be download from here
A cross platform tool to track hand position and recognize gestures using the front camera(s) of the VIVE, VIVE Pro and the VIVE Focus (Wave Platform). Finger tracking (21 points) is available for the Vive and Vive Pro.
VIVE hand tracking SDK can be downloaded from here
Detailed documentations and code samples can be found here
SRWorks SDK With the launch of VIVE Pro, developers will now have access to the stereo front facing cameras to create new experiences that can mix the see-through stereo camera view and their virtual worlds. This will enable developers to perform 3D perception and depth sensing with the stereo RGB sensors, opening new worlds for more creative, interactive experiences.
In addition to the updated OpenVR camera APIs that can now handle more than the mono camera of the original VIVE, the VIVE Software team is also providing developers with early access to the SRWorks SDK.
SRWorks SDK can be downloaded from here
The VIVE 3D Sound Perception SDK provides a Unity compatible, audio spatialization plugin with the following features:
- Higher Order Ambisonics
- HRTFs based on refined real-world modeling (horizontally and vertically)
- Support for Hi-Res audio source files and playback.
- Acoustic distance effect with real-world modeling.
The VIVE 3DSP plugin supports room effect, room reverberation and reflection, and acoustic occlusion that is tuned for the VIVE Pro. However the original VIVE and other HMDs and headphones are also supported.
VIVE 3DSP SDK can be download from here
Detailed documentations and code samples can be found here
Viveport is the official VR App Store, available in 60+ markets. VIVEPORT is compatible with a range of devices from HTC, other SteamVR devices, as well as devices from partner companies based on the WAVE runtime for all-in-one VR headsets.
Download the VIVEPORT SDK from here.
Dowenload the VIVEPORT Scene SDK from here.
Integrate your content with the VIVEPORT platform and utilize the store features.
When you publish your content to VIVEPORT, you can use the following features in your content if you integrate the VIVEPORT SDK into your content:
- Top Level
- DRM (Digitial Rights Management)
- Session Token
- User Profile
- In-App Purchase (IAP)
- Downloadable Content (DLC)
- Stats & Achievements
- Leaderboard
- Sessions (Per-round) for VIVEPORT Arcade (For Windows)
The VIVEPORT SDK consists of the components below:
- Client-side SDK
- VIVEPORT Desktop (For Windows) / VIVEPORT M (For Android)
- VIVEPORT cloud services
- ViVEPORT Switch Tool (For Windows Arcade development)
-
How Does the Client-Side SDK Work
- Users need to log in VIVEPORT Desktop by using their HTC Account (the account has owned this content) before launching the content.
- With the VIVEPORT SDK, the launched content can send a request to the VIVEPORT cloud services via VIVEPORT Desktop or Viveport App to check the user’s profile and licenses.
- The VIVEPORT cloud services return the user’s profile and licenses to client-side SDK for processing or verifying.
- The launched content may interact with the user through the user’s profile in VIVEPORT, or just check whether the user owns the content.
-
VIVEPORT ID and VIVEPORT Key
The VIVEPORT SDK uses VIVEPORT ID and VIVEPORT Key to communicate with the VIVEPORT platform.VIVEPORT ID and VIVEPORT Key is on the VIVEPORT Listing page.
- Before content can be published to VIVEPORT, the content must have a unique VIVEPORT ID and VIVEPORT Key.
- The VIVEPORT ID and VIVEPORT Key can be requested from the VIVEPORT developer portal at here.
- The VIVEPORT ID and VIVEPORT Key must be included in the authentication script before attempting to publish the content on VIVEPORT.
-
System Requirements
- Software Requirements
- Unity 5.x for Windows (32/64-bit)
- Unreal Engine 4.x for Windows (64-bit, Visual Studio 2013)
- VIVEPORT Desktop - You can download whole Vive Software since it includes VIVEPORT Desktop.
- VIVEPORT M - You can download whole Vive App from your Android.
- Runtime Environment
- For Windows, standalone applications for Windows 7/8/10 (32/64-bit) are supported.
- For Android, standalone app from Android version 4.1 with Gyroscope (minimum) to Android version 6 or later with 4G RAM and 1440p resolution (high standard) are supported.
-
SDK Usage Outline
Before publishing your content to VIVEPORT, you can (and should) check if the DRM license generated from VIVEPORT cloud services is valid, and then test whether other SDK functions work. The steps below outline the process of integrating the VIVEPORT SDK.
For Unity user:
- Create or import your content into Unity
- Download and install the VIVEPORT SDK
- Integrate the VIVEPORT SDK into your content in Unity
For Unreal user:
- Create or import your content into Unreal
- Download and install the VIVEPORT SDK
- Integrate the VIVEPORT SDK into your content in Unreal
For C# user:
- Create an empty C# project in your visual studio 2015
- Copy settings into your project
- Reload your project and rebuild
-
API
It has 9 different type of APIs. They are Top Level API, DRM API, Session Token API, User Profile API, In-App Purchase (IAP) API, Deeplink API, Downloadable Content (DLC) API, Stats & Achievements API and Leaderboards API. The details of how to use them and the examples can be found by click the name.
- Integration
Here is the guideline of how to integrate your content with the VIVEPORT platform.
- Integration with Unity.
- Integration with Unreal Engine.
- Integration with C#.
- Integration with C++.
- ViveportSwitch tool
For developers who want to develop for the Arcade program, you can use this tool to simulate Arcade mode in your computer, and integrate VIVEPORT SDK in the Arcade mode.
-
When you upload your title, opt-in to the VIVEPORT Arcade Program by checking one of the options in the VIVEPORT Arcade Program section.
-
Download and install the VIVEPORT SDK from the Download page.
-
Unzip the package and find the ViveportSwitch.exe tool.
-
Open the ViveportSwitch.exe tool and select VIVEPORT Arcade, then click the Switch button.
-
After switching to VIVEPORT mode, the VIVEPORT service will be restarted. You must re-launch VIVEPORT on your desktop before continuing development.
The details of its API and integration, you can found here.
Help you create immersive VR Previews that will be showcased in VIVEPORT.
Required files:
You will need to go to https://developer.vive.com/ to register or sign in if you have an existing account.
Download the vr preview scene sdk here
Required Hardware:
A Vive and Vive controllers setup and working.
The detailed tutorial can be found here.
-
Introduction
Vive Hand Tracking SDK is aimed to provide:
- First-person view hand recognition in VR/AR/Phones
- Provide accurate, low-latency, deep learning-based solution.
- Support different hardware & operation systems.
- Use existing camera modules, no extra hardware needed.
- Recognises static gestures, instead of gesture sequences.
-
Supported Operation Systems & Hardware
Vive Hand Tracking SDK tries our best to support all VR/AR devices with camera on-board. A list of currently supported devices is listed below:
| Operation Sytem | Aarchitecture | Hardware |
|---|---|---|
| Windows 7 or newer | x86-64 | HTC Vive, HTC Vive Pro |
| Android N or newer | ARMv7, ARMv8 | Android Phone with optional VR headset |
| Android (WaveVR) | ARMv7 | HTC Vive Focus, HTC Vive Focus Plus |
For detailed requirements for each OS/hardware, please see Supported Hardware.
-
Supported Features
Vive Hand Tracking SDK supports:
- Left/Right hand detection
- Pre-defined gesture classification
- Different modes for hand position result (restricted by OS/hardware capability) For detailed feature for each OS/hardware, please see Available Features.
-
Available Plugins
| Plugin Type | Supported Platforms | Requirements |
|---|---|---|
| Unity | All | Unity 5.4 or newer (Android armv8 requires 2017.4+) |
| Unreal | All | Unreal 4.20 or newer |
| Android Library | Android, WaveVR | Java 8 or newer |
| C/C++ | All | c/c++ compiler (MSVC or Android NDK) |
The details guide you can find here.
This document will help you to integrate your content with the VIVEPORT AirSig gesture and signature recognition.
-
Usage Cases
VIVEPORT AirSig Manager provides 4 major functions:
-
Player’s Signatures:
Identify player’s identity by verifying against Player’s Signatures with adjustable signature strength.
-
Developer-defined Gestures:
Identify input gestures against Developer-defined Gestures. The feature is:
- Developers customize and define gestures. Players don’t have to train.
- With high generality. Even different players with different drawing habit(e.g. different size, shape), system can recongnize it.
- In order to use this feature, gestures sample must be collected first and then generate a gesture profile in AirSig Developer Portal , or developers can use the gesture profile generated by others.
-
Player-defined Gestures:
Learn and identify Player-defined Gestures. The feature is:
- Players can create their own gestures in application real-time.
- The training progress is needed. Players have to repeat the same gesture for about 5 times.
- This kind of gesture focus on the drawing feature of individual. Less likely to be shareable between players.
-
Smart Gesture:
Smart Gesture algorithm that combines the result of Developer-defined Gestures and Player-defined Gestures (2 and 3). The feature is:
- Developers define the gesture and design a “Tutorial phase” in application. Players have to repeat the gesture and system learns the drawing habit in the same time. The accuracy is further improved.
- In “Tutorial phase”, if the players’ drawing habit is very different from the gestures defined by developers, system will not learn it. That can avoid the wrong gesture affects the recognition result.
- We suggest developers use this mode in most scenario. Players usually don’t familiar with using gestures. The “Tutorial phase” helps players practice it and system can learn the drawing habit in the same time.
-
-
System Requirements
-
Software Requirements
-
.Net Framework 4.6.1 - for Windows.
-
Microsoft Visual C++ 2017 Redistributable (x64) for Windows (64-bit)
-
Unity v5.6 or above version.
-
HTC Wave SDK for Android.
-
-
Runtime Environment
- For Windows, standalone applications for Windows 7/8/10 (32/64-bit) are supported.
- For Android, standalone app from Android version 4.1 with Gyroscope (minimum) to Android version 6 or later with 4G RAM and 1440p resolution (high standard) are supported.
-
Installation
VIVEPORT AirSig supports Vive and Wave. Please refer to AirSig for installation.
- API and Integration
It has two APIs which are Method and Event Delegates. The way of integration with Unity can be found here.
After finish using the device, it is important to turn off, disassemble and put it back in the box as it was found, then put the box back in its place.
More documentations and materials to download could be found here.