AFK-module

AFK stands for Away From Keyboard

Overview

The AFK (Away-From-Keyboard) events in Arcware's WebSDK are now sourced from Epic Games' Pixel Streaming Infrastructure SDK. This document provides an updated guide on how to handle AFK events using the PixelStreaming event listeners.

Accessing AFK Events

When initializing Arcware WebSDK via ArcwareInit(), three objects are returned. The second object, PixelStreaming, provides event listeners to handle AFK-related events.

Event Listener Registration

You can register event listeners using:

PixelStreaming.addEventListener("eventName", callbackFunction);

Available AFK Events

Event Name

Corresponding Epic SDK Object

afkTimedOut

AfkTimedOutEvent

afkWarningActivate

AfkWarningActivateEvent

afkWarningDeactivate

AfkWarningDeactivateEvent

afkWarningUpdate

AfkWarningUpdateEvent

Example Usage

Here is an example of how to listen for AFK events:

PixelStreaming.addEventListener("afkWarningActivate", () => {
    console.log("AFK Warning Activated!");
});

PixelStreaming.addEventListener("afkWarningDeactivate", () => {
    console.log("AFK Warning Deactivated!");
});

PixelStreaming.addEventListener("afkTimedOut", () => {
    console.log("User has timed out due to inactivity.");
});

Overlay Controls

The AFK overlays are managed by Epic's Pixel Streaming Infrastructure. There are available options to configure and control these overlays.

Note: Further documentation on overlay customization will be provided in a separate update.

Next Steps

Implement AFK event listeners in your application as needed.
Stay tuned for an upcoming update regarding overlay control.
If you encounter any issues, refer to Epic's Pixel Streaming documentation or reach out to Arcware support.

This documentation is an update to reflect the latest changes in AFK event handling within Arcware's WebSDK.

AFK Module