article

AndresGenvid avatar image
AndresGenvid posted

01. Unreal Blueprint Class Setup Guide   

Unreal Class Setup Guide

This guide was written as a quick reference step by step guide for the first setup of genvid classes. For class descriptions or more in depth information on each step please check the documentation at https://www.genvidtech.com/for-developers/sdk-latest/


Blueprint Class Creation and Setup

  1. Create blueprints for the following classes (GenvidSessionManager, GenvidSession, GenvidVideo, GenvidAudio, GenvidStreams, GenvidEvents, and GenvidCommands)

  2. Create a blueprint PlayerController and GameMode

  3. Open your blueprint GenvidSessionManager. Set your blueprint GenvidSession in the property “Session Class”

  4. Open your GenvidSession blueprint. Set your blueprint GenvidAudio and GenvidVideo in the properties “Audio Stream Class” and “Video Stream Class”.

  5. Open your PlayerController. Add the blueprint GenvidEvents, GenvidStreams, and GenvidCommands as components

  6. Open your GameMode. Set your PlayerController as the default player controller class property

  7. Open project settings - set your new game mode as the default

1668468503070.pngExample GenvidSession Blueprint

1668468534203.pngExample PlayerController component list




GenvidSessionManager Instance Creation

  1. The GenvidSessionManager needs to persist at all times. One way to make sure this is the case is to have the GameInstance manage it.

  2. Create a blueprint GameInstace. Set the blueprint as the default game instance class in project settings.

  3. Create a variable in the GameInstance that is an instance of your GenvidSessionManager blueprint

  4. In the event graph on Init add the following:

    • Create a Session Manager using your blueprint session manager class

    • Set the instance created into the property declared above

    • Call the “initialize” function on the session manager instance

  5. In the event graph on Shutdown add the following:

    • Call the “terminate” function on the session manager instance



1668104489785.pngGameInstance blueprint code




unreal engineunreal
1668104489785.png (109.8 KiB)
1668468503070.png (32.2 KiB)
1668468534203.png (6.0 KiB)
10 |600

Up to 8 attachments (including images) can be used with a maximum of 1.0 MiB each and 10.0 MiB total.

Article

Contributors

AndresGenvid contributed to this article