Unreal Engine 4 Genvid Plugin¶
The GenvidPlugin is a standard UE4 plugin which developers can drop in their UE4 game and very quickly get started with Genvid technologies.
It provides a few utility routines to help interact with the Genvid’s native API. It also provides the necessary code to perform auto-capture of both audio and video data. Finally, as a convenience, it automatically calls Genvid_Initialize() and Genvid_Terminate() when the plugin is loaded and unloaded.
Installation¶
To install the plugin, simply copy the GenvidPlugin
directory inside
your game’s plugin directory (e.g. UE4_PROJ_ROOT/MyGame/Plugins
).
We recommend copying the plugin inside the game project directory rather
than inside the engine’s UE4_PROJ_ROOT/Engine/Plugins
directory, as
modifying things inside GenvidPlugin
will lead to much leaner recompiles.
Normally, the GenvidPlugin should already contain the Genvid Native API libraries. If it doesn’t, or if you need to update the provided files, simply copy the Genvid Native API files to following location:
GenvidPlugin/ThirdParty/GenvidSDK/include/genvid.h
- The header file of the Genvid Native SDK, declaring all of the functions and types.
GenvidPlugin/ThirdParty/GenvidSDK/lib/Win64/Genvid.lib
- The 64-bit import library used when linking.
Requires associated
Genvid.dll
at runtime. GenvidPlugin/ThirdParty/GenvidSDK/lib/Win64/Genvid.dll
- The 64-bit shared library used at runtime.
GenvidPlugin/ThirdParty/GenvidSDK/lib/Win32/Genvid.lib
- The 32-bit import library used when linking.
Requires associated
Genvid.dll
at runtime. GenvidPlugin/ThirdParty/GenvidSDK/lib/Win32/Genvid.dll
- The 32-bit shared library used at runtime.
Details¶
- GenvidPlugin
GenvidPlugin/Source/GenvidPlugin/GenvidPlugin.Build.cs
- This file is needed to integrate the plugin inside the Unreal Engine build process.
GenvidPlugin/Source/GenvidPlugin/Public/GenvidPlugin.h
- Class defining standard Unreal Engine module interface of the Native API.
GenvidPlugin/Source/GenvidPlugin/Private/AutoCaptureUtil.h
- Helper Class for setting up auto-capture (Audio & Video).
GenvidPlugin/Source/GenvidPlugin/Private/GenvidPlugin.cpp
- Implementation of the
GenvidPlugin
class.GenvidPlugin/Source/GenvidPlugin/Private/AutoCaptureUtil.cpp
- Implementation of AutoCaptureUtil class.
GenvidPlugin/Source/GenvidPlugin/Private/GenvidPluginPrivatePCH.h
- Used for specifying optional precompiled headers for faster compiles.
Activation¶
To use the Genvid plugin, you need to activate it. Go into the Edit menu and click on the Plugins items.
You should see a window like this screenshot capture.
Click on the checkbox “Enabled” to activate the plugin.