@epicgames-ps/lib-pixelstreamingfrontend-ue5.4/src/WebSockets/MessageReceive.ts

Frontend library for Unreal Engine 5.4 Pixel Streaming

// Copyright Epic Games, Inc. All Rights Reserved.

/**
 * The Types of Messages that will be received
 */
export enum MessageRecvTypes {
    CONFIG = 'config',
    STREAMER_LIST = 'streamerList',
    STREAMER_ID_CHANGED = 'streamerIDChanged',
    PLAYER_COUNT = 'playerCount',
    OFFER = 'offer',
    ANSWER = 'answer',
    ICE_CANDIDATE = 'iceCandidate',
    PEER_DATA_CHANNELS = 'peerDataChannels',
    PING = 'ping',
    WARNING = 'warning'
}

/**
 * Concrete Received Message wrapper
 */
export class MessageRecv {
    type: string;
    id: string;
}

/**
 * Authentication Required Message wrapper
 */
export class MessageAuthRequired extends MessageRecv {}

/**
 * Config Message Wrapper
 */
export class MessageConfig extends MessageRecv {
    peerConnectionOptions: RTCConfiguration;
}

/**
 * Streamer List Message Wrapper
 */
export class MessageStreamerList extends MessageRecv {
    ids: string[];
}

/**
 * Streamer ID Changed Message Wrapper
 */
export class MessageStreamerIDChanged extends MessageRecv {
    newID: string;
}

/**
 * Player Count Message wrapper
 */
export class MessagePlayerCount extends MessageRecv {
    count: number;
}

/**
 * Web RTC offer Answer Message wrapper
 */
export class MessageAnswer extends MessageRecv {
    sdp: string;
}

/**
 * WebRTC sdp offer Message wrapper.
 */
export class MessageOffer extends MessageRecv {
    sdp: string;
    sfu?: boolean;
    defaultToHover?: string;
}

/**
 * Ice Candidate Message wrapper
 */
export class MessageIceCandidate extends MessageRecv {
    candidate: RTCIceCandidateInit;
}

/**
 * Peer Data Channels Message wrapper
 */
export class MessagePeerDataChannels extends MessageRecv {
    recvStreamId: number;
    sendStreamId: number;
    type: string;
}

export class MessageOnScreenKeyboard {
    command: string;
    showOnScreenKeyboard: boolean;
    x: number;
    y: number;
}