Upgrade from 1.11.0 to 1.12.0

genvid-bastion installation

genvid-bastion install and genvid-bastion reinstall commands now support two new options:

To load the jobs and logs to the bastion.
To update the global terraform variable values instead of doing it by default.

Both options are mandatory during a new installation or an upgrade, although the second one only affect the Cloud Deployment.

Genvid Unity Package

The unity.py build no longer compiles the Genvid Plugin. Instead, the plugin is now available as part of the Genvid MILE SDK Unity Asset Package import by the script. If you want to compile the plugin, you can now use the script package.py included with the Unity Sample. If you want to install the Genvid MILE SDK Unity Asset Package inside the Unity sample project, use the script unity.py prepare.

Windows AMI

The TightVNC installation of the Windows AMI now has a default password set to 1genvid6. You can change it during the installation process described in the Initialize the AMI section.

New dependency on Docker SDK for Python 3.1

This upgrade from the 2.0 version includes some breaking changes to the API. See Breaking Changes for more information.

Using compressed Docker images

We added the ability to compress the Docker images for uploading to the server. If you want to use it for your own project, here is a brief guide to the necessary changes:

  1. Add the compress=True parameter to the update_image() method when you save the archive of the image.
  2. Modify the template so that the load_image parameter uses the .docker instead of the .zip extension of the actual image key. For example:
  config {
    image        = "{{key `genvid/images/web/tag`}}"
    load         = "{{key `genvid/images/web/image` | replaceAll `.zip` `.docker`}}"
    force_pull   = "{{ key `genvid/images/web/dirty` | parseBool }}"
    network_mode = "host"

    // {{ if keyOrDefault "genvid/code/logging/fluentd/enabled" "false" | parseBool }}
    logging {
      type = "fluentd"

      config {
        fluentd-address = "${NOMAD_IP_web}:24224"
        tag             = "${NOMAD_TASK_NAME}"

    // {{ end }}

UE4 Genvid Module

the Unreal Engine Genvid Module 1.12.0 is a major change compared to the version 1.11.0.

The new Genvid Module is still compatible with the previous version but the code is now deprecated.

You can update from 1.11.0 to 1.12.0 version without any change. But we recommend the migration to the new version.

How to upgrade to 1.12.0

Some explanation

GenvidStreamer was split into five different classes:

And two new classes were added:

See also

To have more information about those classes take a look at this section: Preparing your game.


  1. You need to create a Blueprint class for each feature you need.


    GenvidSession and GenvidSessionManager are mandatory classes.

    See the Blueprint Diagram for more information.

  2. Parametrize each class you have created.

    See GenvidVideo, GenvidAudio, GenvidStreams, GenvidEvents, and GenvidCommands for more details.

  3. Set in GenvidSession your new created classes.

  4. Set in GenvidSessionManager your new created GenvidSession.

  5. Instantiate and Initialize and Terminate the GenvidSessionManager

  6. Instantiation

At this stage, the video and audio are ready to be streamed.

Take a look at GenvidStreams, GenvidEvents, and GenvidCommands to see how to declare streams, events, and commands.