This document explains the use and functionality of the feature AFK (Away from Keyboard).
Enable AFK from your Control Panel to get a Warning on your session whenever you are away from your Controls (i.e. Keyboard and mouse).
Or get a Closing session message if you were still away from the game after the Count down on your Warning message ends.
Prepare to execute instructions
Before starting the first step, make sure you have:
Access to the Control Panel
Enabled the Pixel Streaming plugin Enable the Pixel Streaming plugin
Packaged your application Package your Project from Unreal Engine
At least one uploaded App Upload your Unreal Engine Application
Setup a Config following this tutorial Set a Config for your App from your Control Panel
- To complete this guide, your working environment must meet all the requirements above. If you have not completed any of the points, follow the link to the appropriate instruction and complete it first.
Instructions
Go to : Control Panel → Select your App from Step 1: Select an App → Select your Config from: Step 2: Create a Config → Edit → Session.
Step 1. Check the box of IsAFK Enabled
If IsAFK Enabled is not selected, then the Warn Timeout and Close Timeout will not be applied later on the user session.
Step 2. Set AFK warn Timeout (Minutes)
Click Save after setting the time in the field.
Step 3. Set AFK close Timeout (Minutes)
Click Save after setting the time in the field.
Step 4. Run the game
Go to Control Panel → Select the game from Step 1: Select an App → Select a Config from Step 2: Create a Config → Step 3: Generate URLs → Play App.
Step 5. Do not use your mouse and/or keyboard
Don’t perform any action on your App. Don’t click on anything for a while (i.e. for the time of AFK warn Timeout (minutes) that you have set on the Config).
Step 6. An AFK warning is displayed on the screen
This screen displays a warning message with a count down when the time you have set for the warn Timeout (minutes) feature on your Config from your Control Panel has reached the end.
Step 7. Click Continue Streaming to go back to the session
You can restore your session by clicking on Continue Streaming before the count down timer ends.
If you still don’t use your (mouse and/or keyboard) after the warning, the session gets terminated and you will be disconnected.
The countdown is the close Timeout you have set on your Config from your Control Panel.
.png?version=1&modificationDate=1703757627425&cacheVersion=1&api=v2&width=760&height=169)
Step 7. Start a new Session in a new Tab
You can run the game again. Close the disconnected session and open a new one in another Tab.
Launch the game again from: Control Panel → Step 3: Generate URLs.
Note: AFK is applicable even when the tab is minimized.
Now you are ready to apply the AFK feature to your App!
Check the next feature Tab Tab: UI
Was this article helpful? Let us know your feedback. React to the page and comment below.
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 E3DS Community Forum today.