Local Environment Usage¶
This section explains the main usage of the genvid-sdk tool. Be
sure to have it installed in your PATH as explained in
Installation of the Toolbox. To illustrate our example, we are
using a sample DirectX11 application integrated with a Node.js
website written in TypeScript, providing both the backend and
client side of the web site integration. You can find more details on
the sample as well as other integration examples under our
Samples section.
Initializing the local cluster¶
To initialize the local cluster, we need to load the sdk configuration. Do the following commands.
genvid-sdk clean-config # Make sure the configuration is clean
genvid-sdk load-config-sdk
Building the tutorial¶
To build the tutorial sample, simply go to the sample/tutorial folder
and execute the tutorial.py script like this:
py tutorial.py build
This will build both the tutorial application and the web site. This
command can be used to build only the game or web site by adding the
argument game or web.
Starting the tutorial¶
You can now start your application. You can open Cluster-UI with the following command:
genvid-sdk monitor
Click Start All to start the services, game, and webpage.
- services
- Starts all of the services needed for communication between the game and the webpage, including the encoder.
Important
Services must be launched prior to launching the game.
- web
- Launches the web server which allows the web page to be displayed properly with the tutorial application video-stream.
- game
- Launches the native DirectX application.
You may also start each one individually by clicking Start next to each job.
Viewing the tutorial¶
To access the local sample web-server, Click the Tutorial Demo hyperlink after it turns blue.
If you are using the standalone streaming feature, for now, you will need Chrome 59+ to be able to read the stream.
Stopping the tutorial¶
Click Stop All to stop the services.