Local Environment Usage¶
Building the tutorial¶
The project file allows you to configure some scripts to be run. For
the tutorial, we have created a script named build
. You can run it by
calling:
py local.py run-script build
This will build both the tutorial application and the web site.
Starting the tutorial¶
Once you have launched the cluster and loaded your project, you can start your application:
py local.py start
The start
command can be used to launch the jobs separately:
- services
- web
- game
Using services
will start all of the services needed for proper
communication between the game and the web page, including the
encoder. Using web
launches the web server to allow the web page
to be displayed properly with the tutorial application video stream.
Finally, game
launches the native DirectX application. Note that
services
must be launched prior to launching the game.
Viewing the tutorial¶
To be able to see the webpage with the content, you just need to call:
py local.py open web
This will open a webpage accessing the local sample web server.
Stopping the tutorial¶
To stop the tutorial, you need to use the command:
py local.py stop
The stop command can be used to stop services separately, by
specifying web
, game
or services
(just
like start
does).
Available Commands¶
Here’s the list of the available commands for local.py
, all of
which can be consulted via the -h
option:
check-config
: Validate the current configuration.clean
: Uninstall services.clear-config
: Clear all configuration.config
: Configure the broadcast session.env
: Print the environment variable used by the script..load-project
: Load a project configuration.log
: Return the specific log for some task.monitor
: Open monitors pages.open
: Show the available links or open the specified link.reinstall
: Clean up and reinstall the services.reload-config
: Clear and reload the broadcast session.reload-project
: Reload current project.restart
: Restart the jobs.run-script
: Run a project script.setup
: Setup the services.show-config
: Show the configuration.start
: Start the game.status
: Give a status.stop
: Stop the jobs.