Engine Integration

This section contains instructions on how to integrate Genvid with your game using the most popular engines. If you need it, we provide a multi engine sample called Cube that will show you a full integration, from the engine to the web.

We also suggest you that have a look at the Native SDK reference and Web SDK reference to have a better understanding of how to interact with the Genvid SDKs.

Unity Integration

The Unity Integration section covers everything you need to know to add the Genvid SDK to your Unity project. The Genvid SDK includes two plugins which streamline the integration process:

• The Genvid SDK asset package provides everything

  necessary for integrating the Genvid SDK into your game.

• The Genvid Editor asset package provides editor

  side scripts which let you control your cluster directly from the Unity editor rather than the Cluster UI page.

To provide a stable environment for developers we officially support every (active) LTS release of the engine as detailed on the Unity website.

This release has been tested with the following LTS versions:

• 2017.4
• 2018.4
• 2019.4

Warning

Non LTS releases are not thoroughly tested by our development team and thus are not officially supported.

Integrating the Genvid SDK into your Unity project is a simple process. We provide a Unity package containing the 3 DLLs required and the scripts and prefab for using it.

• Genvid SDK Asset Package
  • Package Contents
  • Building the Package
  • Installing the Package
• Genvid SDK prefabs
  • Overview
  • Files Included in the Prefab
• Genvid Editor Asset Package
  • Package Contents
  • Building the Package
  • Installing the Package
• Genvid Editor Window
  • Before You Begin
  • Parts of the Genvid Window
• SDK Integration
  • Preparing for Integration
  • Setting Up the Genvid Prefab
• Best Practices
  • Use a root scene for the Genvid prefab
  • Build your application to use DirectX 11
  • Use the correct type of video capture to show or hide the HUD
  • Build your application only when the Genvid stack is stopped
• Troubleshooting
  • The Genvid DLLs are not detected properly by Unity
  • The video stream is not captured properly on some machines
  • The video displays upside down in the stream
  • The Python scripts fail with a Unity License error
  • Testing Without a Running Genvid Stack
• Package Script
  • Positional Arguments
  • Named Arguments
  • Sub-commands:

Unreal Engine 4 Integration

Epic’s Unreal Engine 4 is one of the leading and most advanced game-engines in the industry today.

To simplify developer efforts, Genvid provides a plugin which should help cut the time necessary to implement Genvid technology in Unreal Engine 4.

• Genvid Integration
  • Installation
  • Genvid Plugin
  • Genvid Module
  • Genvid Blueprint
  • Genvid Client/Server
  • Genvid Plugin Editor
  • copy-ue4-plugin.py
• Troubleshooting
  • Rendering resolution is incorrect while running the game from the UE4Editor
  • Framerate is too low
  • Audio doesn’t work
  • Low framerate in UE4Editor
  • UE4 Cube Sample Build Error

Directx 11 Integration

See our DirectX cube sample for information about integrating the Genvid SDK in a DirectX 11 application.