LogoLogo
Quick Links
  • Arcware Cloud
  • Arcware Cloud Platform
    • Getting started with Arcware Cloud
      • Sign up and sign in
        • Reset your password
      • Selecting a Plan & Creating your Tenant
      • Creating & Managing your projects
        • Project Dashboard
          • Statistics
        • Uploading and releasing packages
          • Resume package upload
        • Preview stream
        • Project settings
          • Max instance run-time
          • AFK Module - User inactivity
          • Queue
      • Sharing your project
      • Upgrading your Plan
      • Organization
      • Products
        • The Marketplace
          • Direct Flow
          • Asset Management
      • Help Center
        • Customer Support tickets
  • Unreal Engine Setup
    • Set up Pixel Streaming in your own project​
      • 01. Core Settings
        • 01.1. Plugin
        • 01.2. Pixel Streaming Input / Json messages
        • 01.3. Resolution
        • 01.4. Camera Aspect Ratio
        • 01.5. Framerate
        • 01.6. Mouse
        • 01.7. Touch Input Setup for Mobile
        • 01.8. DirectX version
      • 02. Optional Settings
        • 02.1 Touch Controllers
        • 02.2 Playing Media files
    • Using the Arcware Pixel Streaming Template Project
      • Template Overview
      • Getting Started
        • 01. Template download
        • 02. Arcware Blueprints
          • 02.1. Arcware GameMode
          • 02.2. Arcware Player Controller
            • 02.2.1. Sending and Receiving Json messages
            • 02.2.2. Creating and Testing Your Own Events
          • 02.3. Arcware Pawn
            • 02.3.1 Change Movement Mode
            • 02.3.2 Set Collision Channels
            • 02.3.3 Add new camera views
          • 02.4. Arcware HUD
        • 03. Packaging your project
  • ARCWARE FEATURES
    • Screenshot Functionality
      • Frontend Overview
        • Web UI
        • In-Game UI
      • Blueprint overview
  • Web Integration
    • ⬆️PixelStreaming WebSDK
      • Implementing the stream on your app
        • Getting Started
        • Code examples
          • Javascript + HTML
          • React
          • VueJS
          • AngularJS
        • Migration from @arcware/webrtc-plugin
        • Best practices
      • Configuration
      • Interacting with the Stream
        • Stream Container
        • Video Element
        • Customizing the User Interface
        • Handling Dynamic Content
        • Stream Display Customization
      • Interacting with Unreal Engine
      • In depth
        • Ticket destroyed.
        • Events handlers
        • Disconnect
        • ConnectionIdentifier
        • Settings-Menu
        • AFK-module
      • Showcase
Powered by GitBook
LogoLogo

Arcware Cloud Platform

  • Getting started​
  • Add-ons guide
  • Common Arcware Cloud Questions

Unreal Engine Setup

  • Set up Pixel Streaming in your own project​
  • Using the Arcware Pixel Streaming Template Project
  • Common Unreal Engine Questions

Arcware Features

  • Screenshot Functionality

Web Integration

  • PixelStreaming WebSDK
  • WebRTC Plugin

Copyright 2024 - Arcware GmbH

On this page
  • Overview
  • Accessing AFK Events
  • AFK Module
  • Overview
  • Accessing AFK Events
  • Overlay Controls
  • Next Steps
  1. Web Integration
  2. PixelStreaming WebSDK
  3. In depth

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

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.

PreviousSettings-MenuNextShowcase

Last updated 2 months ago

⬆️