@casual-simulation/aux-vm-client

AUX VM Client

A set of utilities required to run an AUX as a client.

Installation

npm install @casual-simulation/aux-vm-client

Usage

Create a custom channel implementation

import { RemoteAuxChannel } from '@casual-simulation/aux-vm-client';
import { AuxUser, AuxConfig } from '@casual-simulation/aux-vm';

export class MyCustomChannel extends RemoteAuxChannel {

    constructor(defaultHost: string, user: AuxUser, config: AuxConfig) {
        super(defaultHost, user, config, {});
    }

    // Override the _handleServerEvents function
    // to handle events sent from a remote device.
    protected async _handleServerEvents(events: DeviceAction[]) {
        await super._handleServerEvents(events);
        let filtered = events.filter(
            e => e.device.roles.indexOf(SERVER_ROLE) >= 0
        );
        let mapped = <BotAction[]>filtered.map(e => e.event);
        if (filtered.length > 0) {
            await this.sendEvents(mapped);
        }
    }
}

Changelog

V3.3.15

Date: 12/19/2024

:rocket: Features

• Added the ability to use CasualOS URLs in <video> HTML custom app elements.
  • This makes it possible to use LiveKit tracks in a custom app.
  • Tip: Utilize the autoplay attribute to automatically play video from a track.

:bug: Bug Fixes

• Fixed an issue in LivekitManager where media permissions for the camera and microphone were not requested before joining a room. Resulting in silent fails for Google Chrome users. The joinRoom method now includes a preliminary step to check and request these permissions, ensuring a smoother user experience.