The command line parameter “CmdLineParameters” makes it possible to send commands to the UE App upon app initialization. To understand how this feature works, first prepare a setup to follow along with this demo:
First, create a new config. The name of the config can be anything, in this example I will name my config ‘CmdLineDemo’.
Second, download our feature templates UE Project, found here: Bitbucket .
Third, upload the FeaturesTemplate UE Project into your Eagle 3D Streaming Platform.
After completing these three steps, your control panel should now have the FeaturesTemplate App and a new config, shown here:
Image 1. STANDALONE APPS: FeaturesTemplate App and a new config
Now that you have your environment setup, its time to try the command line parameter. First click on ‘Edit’ on your config, and then click ‘Streaming’ from the top menu items. Then scroll down to the very bottom, and find the ‘CmdLineParameters To Pass to App’.
This field will enable you to send commands to your UE App when in initializes. To start off learning the CmdLine, try adding ‘-green’ into this field, and clicking save.
Image 2. STREAMING: CmdLine
After saving, run the FeaturesTemplate app. After the app loads run to the 11th bay (yes, we know it takes a long time to get there). You’ll notice the sphere is now green. This is because UE4 received your command on run time to change the sphere’s color to green.
Image 3. Launching the Features Template Application: Сolor to green
Now let’s test sending multiple commands to UE. Go back to the command line, enter ‘-blue -pink -white’, save the config, and run the game again
Image 4. CmdLine: -blue -pink -white
Image 5. Launching the Features Template Application: -blue -pink -white
As a final test, change the colors to ‘-blue -red -green’ so that we can the values entered into the Command Line are having a direct impact on the UE Game.
Now let’s test sending multiple commands to UE. Go back to the command line, enter ‘-blue -red -green’, save the config, and run the game again.
Image 7. Launching the Features Template Application: -blue -red -green
Pro-tip: Check the UE Blueprints in our sample project to see how these commands are being received by UE.
More advanced features
1. It is also possible to append cmdLine Arguments with existing ones. This can be used for authentication / token purposes.
2. First, lets return to a simple example, with the Command ‘-green’. This will make the sphere green in your example.
3. Now, check the ‘should append overiding cmdLine Argument with existing (sp, we know) one?’
Should append parameters from url with existing one to override?
Image 8. CmdLine: -green
Then copy your URL, it will look something like this: https://connector.eagle3dstreaming.com/v5/demo/FeaturesTemplate/CmdLineDemo
Then copy your URL, it will look something like this: https://connector.eagle3dstreaming.com
/v5/demo/FeaturesTemplate/CmdLine
Demo
Now that you have checked ‘’should append overiding cmdLine Argument with existing one?’, you are able to add additional command lines to the URL, by adding ‘?exeLunchArgs=-[variable]’ to the end of the URL.
For example, say I wanted to add -’blue' to my URL.
I will first start with this URL:
https://connector.eagle3dstreaming.com/v5/demo/FeaturesTemplate/CmdLineDemo
And then I would add ‘?exeLunchArgs=-blue' to the end of it. My URL now looks like this:
https://connector.eagle3dstreaming.com/v5/demo/FeaturesTemplate/CmdLineDemo?exeLunchArgs=-blue
The system has now appended the additional command and has sent both the command added into the config and the command added into the URL to the UE game.
Example: https://connector.eagle3dstreaming.com/v5/demo/FeaturesTemplate/KunalConfig?exeLunchArgs=-green pink red
When you click on
https://connector.eagle3dstreaming.com/v5/demo/FeaturesTemplate/CmdLineDemo?exeLunchArgs=-blue, your output will look something like this( where 2 values is getting parsed from two place in cmdline args):
For example, say I wanted to add
-’blue’ to my URL.
I will first start with this URL:
https://connector.eagle3dstreaming.com
/v5/demo/FeaturesTemplate/CmdLineDemo
And then I would add ‘?exeLunchArgs=-blue’ to the end of it. My URL now looks like this:
https://connector.eagle3dstreaming.com
/v5/demo/FeaturesTemplate/CmdLineDemo?exeLunchArgs=-blue
The system has now appended the additional command and has sent both the command added into the config and the command added into the URL to the UE game.
Example: https://connector.eagle3dstreaming.com/v5/
demo/FeaturesTemplate/KunalConfig?exeLunchArgs=-green pink red
When you click on
https://connector.eagle3dstreaming.com/v
Now that we are familiar with how the appending system works, we can explore how this is used for authentication.
On the URL side, append (we assume you know how to do this programmatically on your end) the user’s email address to the URL, so that it looks like this:
https://connector.eagle3dstreaming.com/
v5/demo/FeaturesTemplate/CmdLineDemo?exeLunchArgs=-user=myEmailAddress@gmail.com (this link will not work and is for demonstration purposes only).
Voila! You are now ready to authenticate your UE visitors sending their email address through the command line!
Special data:
%ip_streamer% will pass the IP address of the machine where UE app is running
%ip_ss% will pass the IP address of the Signaling server
%port_streamer2ss% will pass the port of the of Signaling server through which UE app communicates with the signaling server
In Parameters If I put :
-bb=%ip_streamer% -aa=%ip_ss%:%port_streamer2ss%
Then the output would be something like thi
Need help? Contact Support
if you still need help, contact support to get your issue resolved quickly.
Submit a new request at E3DS support portal or send an Email at support@eagle3dstreaming.com.
Seek advice. Connect with others. Share your experiences. Join our lively Community Forum today.
