Genvid Unity Package¶
The engine-integration/unity/genvid.unitypackage
file contains
everything necessary to integrate the Genvid SDK into your game and
adds editor tools for controlling the Genvid Stack.
Package Contents¶
Plugins/x86/genvid.dll
andPlugins/x64/genvid.dll
- This is our main native DLL for Windows (32-bit and 64-bit versions). It is required for integrating the Genvid Services.
Plugins/GenvidSDKCSharp.dll
- This is the C# wrapper around our Native SDK. It provides all
the same functionalities as
genvid.dll
and lets you use our SDK through Unity Scripts. Plugins/x86/GenvidPlugin.dll
andPlugins/x64/GenvidPlugin.dll
- This is our Unity Native Plugin (32-bit and 64-bit versions) which lets us enable direct access to the graphics device for optimal video capture. It is not mandatory for integrating Genvid, but allows more efficient video transfer to our SDK.
Plugins/Genvid/Editor/GenvidRESTCSharp.dll
This is a wrapper around our Toolbox REST API which allows control of the Genvid Stack from the Unity Editor. It depends on two external third party libraries: RESTCSharp Library and Newtonsoft JSON.Net Library.
We use version 8.0 of the Newtonsoft library, so it can be replaced with the JSON.Net for Unity assets.
Genvid/Scripts
andGenvid/Prefabs/Genvid
These folders contain scripts and prefabs for integrating Genvid more easily. We use them in our sample integration, but they aren’t required. You can replace them in your project.
We describe these prefabs and scripts in more detail in the The Genvid SDK Prefab for Unity section.
Genvid/Editor
- This folder contains scripts that add some tools to control the Genvid Stack from the Unity Editor. They create a new Genvid panel available from the Unity menu under The Local Environment and the The Cloud Environment. . The tools aren’t mandatory but can help testing in both the
Building the Package¶
The package source is available under /engine-integration/unity
.
You can use the package.py script to build the full Unity
package. You must have the Microsoft C++ Compiler installed to build
the Unity package. A pre built asset package is available in that folder
under the name genvid.unitypackage
.
Warning
The Unity Installer only installs the C# tools by default. You need to install C++ support separately to build the Unity package.
Installing the Package¶
For our cube sample in /samples/cube/unity
, we use a Python script
to install the package for our sample, you can run it with:
py unity.py prepare
You can also manually add the Genvid SDK to your Unity project:
Open your project in the Unity Editor.
Select
.Click genvid.unitypackage located in the
/engine-integration/unity
folder.