@yang__yj/pixelstreaming-core 1.0.1 → 1.0.3

package/types/Config/Config.d.ts

@@ -18,7 +18,6 @@ export declare class Flags {
     static FakeMouseWithTouches: "FakeMouseWithTouches";
     static IsQualityController: "ControlsQuality";
     static MatchViewportResolution: "MatchViewportRes";
-    static PreferSFU: "preferSFU";
     static StartVideoMuted: "StartVideoMuted";
     static SuppressBrowserKeys: "SuppressBrowserKeys";
     static UseMic: "UseMic";
@@ -27,6 +26,7 @@ export declare class Flags {
     static TouchInput: "TouchInput";
     static GamepadInput: "GamepadInput";
     static XRControllerInput: "XRControllerInput";
+    static WaitForStreamer: "WaitForStreamer";
 }
 export type FlagsKeys = Exclude<keyof typeof Flags, 'prototype'>;
 export type FlagsIds = typeof Flags[FlagsKeys];
@@ -42,6 +42,7 @@ export declare class NumericParameters {
     static WebRTCMinBitrate: "WebRTCMinBitrate";
     static WebRTCMaxBitrate: "WebRTCMaxBitrate";
     static MaxReconnectAttempts: "MaxReconnectAttempts";
+    static StreamerAutoJoinInterval: "StreamerAutoJoinInterval";
 }
 export type NumericParametersKeys = Exclude<keyof typeof NumericParameters, 'prototype'>;
 export type NumericParametersIds = typeof NumericParameters[NumericParametersKeys];
@@ -136,9 +137,9 @@ export declare class Config {
      */
     getSettingOption(id: OptionParametersIds): SettingOption;
     /**
-     * Get the value of the configuration flag which has the given id.
-     * @param id The unique id for the flag.
-     * @returns True if the flag is enabled.
+    * 获取具有给定id的配置标志的值。
+    * @param id标志的唯一id。
+    *如果启用了该标志，@返回True。
      */
     isFlagEnabled(id: FlagsIds): boolean;
     /**

package/types/DataChannel/DataChannelLatencyTestController.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+import { DataChannelLatencyTestRecord, DataChannelLatencyTestRequest, DataChannelLatencyTestResponse, DataChannelLatencyTestResult, DataChannelLatencyTestSeq, DataChannelLatencyTestTimestamp } from "./DataChannelLatencyTestResults";
+export type DataChannelLatencyTestConfig = {
+    duration: number;
+    rps: number;
+    requestSize: number;
+    responseSize: number;
+};
+export type DataChannelLatencyTestSink = (request: DataChannelLatencyTestRequest) => void;
+export type DataChannelLatencyTestResultCallback = (result: DataChannelLatencyTestResult) => void;
+export declare class DataChannelLatencyTestController {
+    startTime: DataChannelLatencyTestTimestamp;
+    sink: DataChannelLatencyTestSink;
+    callback: DataChannelLatencyTestResultCallback;
+    records: Map<DataChannelLatencyTestSeq, DataChannelLatencyTestRecord>;
+    seq: DataChannelLatencyTestSeq;
+    interval: NodeJS.Timer;
+    constructor(sink: DataChannelLatencyTestSink, callback: DataChannelLatencyTestResultCallback);
+    start(config: DataChannelLatencyTestConfig): boolean;
+    stop(): void;
+    produceResult(): DataChannelLatencyTestResult;
+    isRunning(): boolean;
+    receive(response: DataChannelLatencyTestResponse): void;
+    sendRequest(requestSize: number, responseSize: number): void;
+    createRequest(requestSize: number, responseSize: number): DataChannelLatencyTestRequest;
+}

package/types/DataChannel/DataChannelLatencyTestResults.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Data Channel Latency Test types
+ */
+/**
+ * Unix epoch
+ */
+export type DataChannelLatencyTestTimestamp = number;
+/**
+ * Sequence number represented by unsigned int
+ */
+export type DataChannelLatencyTestSeq = number;
+/**
+ * Request sent to Streamer
+ */
+export type DataChannelLatencyTestRequest = {
+    Seq: DataChannelLatencyTestSeq;
+    FillResponseSize: number;
+    Filler: string;
+};
+/**
+ * Response from the Streamer
+ */
+export type DataChannelLatencyTestResponse = {
+    Seq: DataChannelLatencyTestSeq;
+    Filler: string;
+    ReceivedTimestamp: DataChannelLatencyTestTimestamp;
+    SentTimestamp: DataChannelLatencyTestTimestamp;
+};
+export type DataChannelLatencyTestResult = {
+    records: Map<DataChannelLatencyTestSeq, DataChannelLatencyTestRecord>;
+    dataChannelRtt: number;
+    playerToStreamerTime: number;
+    streamerToPlayerTime: number;
+    exportLatencyAsCSV: () => string;
+};
+export declare class DataChannelLatencyTestRecord {
+    seq: DataChannelLatencyTestSeq;
+    playerSentTimestamp: DataChannelLatencyTestTimestamp;
+    playerReceivedTimestamp: DataChannelLatencyTestTimestamp;
+    streamerReceivedTimestamp: DataChannelLatencyTestTimestamp;
+    streamerSentTimestamp: DataChannelLatencyTestTimestamp;
+    requestFillerSize: number;
+    responseFillerSize: number;
+    constructor(request: DataChannelLatencyTestRequest);
+    update(response: DataChannelLatencyTestResponse): void;
+}

package/types/Inputs/HoveringMouseEvents.d.ts

@@ -29,7 +29,7 @@ export declare class HoveringMouseEvents implements IMouseEvents {
      */
     handleMouseUp(mouseEvent: MouseEvent): void;
     /**
-     * Handle the mouse context menu event, sends the mouse data to the UE Instance
+     * Consumes the mouse context event. The UE instance has no equivalent and doesn't need to be informed.
      * @param mouseEvent - Mouse Event
      */
     handleContextMenu(mouseEvent: MouseEvent): void;

package/types/PeerConnectionController/PeerConnectionController.d.ts

@@ -1,7 +1,7 @@
 import { Config } from '../Config/Config';
 import { AggregatedStats } from './AggregatedStats';
 /**
- * Handles the Peer Connection
+ * 处理对等连接
  */
 export declare class PeerConnectionController {
     peerConnection: RTCPeerConnection;

package/types/PixelStreaming/PixelStreaming.d.ts

@@ -6,6 +6,9 @@ import { InitialSettings } from '../DataChannel/InitialSettings';
 import { PixelStreamingEvent } from '../Util/EventEmitter';
 import { MessageOnScreenKeyboard } from '../WebSockets/MessageReceive';
 import { WebXRController } from '../WebXR/WebXRController';
+import { MessageDirection } from '../UeInstanceMessage/StreamMessageController';
+import { DataChannelLatencyTestConfig, DataChannelLatencyTestController } from "../DataChannel/DataChannelLatencyTestController";
+import { DataChannelLatencyTestResponse } from "../DataChannel/DataChannelLatencyTestResults";
 export interface PixelStreamingOverrides {
     /** The DOM elment where Pixel Streaming video and user input event handlers are attached to.
      * You can give an existing DOM element here. If not given, the library will create a new div element
@@ -22,13 +25,13 @@ export interface PixelStreamingOverrides {
 export declare class PixelStreaming {
     protected _webRtcController: WebRtcPlayerController;
     protected _webXrController: WebXRController;
+    protected _dataChannelLatencyTestController: DataChannelLatencyTestController;
     /**
      * Configuration object. You can read or modify config through this object. Whenever
      * the configuration is changed, the library will emit a `settingsChanged` event.
      */
     config: Config;
     private _videoElementParent;
-    _showActionOrErrorOnDisconnect: boolean;
     private allowConsoleCommands;
     private onScreenKeyboardHelper;
     private _videoStartTime;
@@ -84,6 +87,17 @@ export declare class PixelStreaming {
      * Auto connect if AutoConnect flag is enabled
      */
     private checkForAutoConnect;
+    /**
+     * Will unmute the microphone track which is sent to Unreal Engine.
+     * By default, will only unmute an existing mic track.
+     *
+     * @param forceEnable Can be used for cases when this object wasn't initialized with a mic track.
+     * If this parameter is true, the connection will be restarted with a microphone.
+     * Warning: this takes some time, as a full renegotiation and reconnection will happen.
+     */
+    unmuteMicrophone(forceEnable?: boolean): void;
+    muteMicrophone(): void;
+    private setMicrophoneMuted;
     /**
      * Emit an event on auto connecting
      */
@@ -99,9 +113,10 @@ export declare class PixelStreaming {
     /**
      * Event fired when the video is disconnected - emits given eventString or an override
      * message from webRtcController if one has been set
-     * @param eventString - the event text that will be emitted
+     * @param eventString - a string describing why the connection closed
+     * @param allowClickToReconnect - true if we want to allow the user to retry the connection with a click
      */
-    _onDisconnect(eventString: string): void;
+    _onDisconnect(eventString: string, allowClickToReconnect: boolean): void;
     /**
      * Handles when Web Rtc is connecting
      */
@@ -123,6 +138,7 @@ export declare class PixelStreaming {
      * @param latency - latency test results object
      */
     _onLatencyTestResult(latencyTimings: LatencyTestResults): void;
+    _onDataChannelLatencyTestResponse(response: DataChannelLatencyTestResponse): void;
     /**
      * Set up functionality to happen when receiving video statistics
      * @param videoStats - video statistics as a aggregate stats object
@@ -143,6 +159,7 @@ export declare class PixelStreaming {
      * @param hasQualityOwnership - does this user have quality ownership of the stream true / false
      */
     _onQualityControlOwnership(hasQualityOwnership: boolean): void;
+    _onPlayerCount(playerCount: number): void;
     /**
      * Request a connection latency test.
      * NOTE: There are plans to refactor all request* functions. Expect changes if you use this!
@@ -150,7 +167,12 @@ export declare class PixelStreaming {
      */
     requestLatencyTest(): boolean;
     /**
-     * Request for the UE application to show FPS counter.
+     * 请求数据通道延迟测试。
+     * 注意:我们计划重构所有的request*函数。如果您使用它，请期待更改!
+     */
+    requestDataChannelLatencyTest(config: DataChannelLatencyTestConfig): boolean;
+    /**
+     * 请求UE应用显示FPS计数器
      * NOTE: There are plans to refactor all request* functions. Expect changes if you use this!
      * @returns
      */
@@ -162,8 +184,8 @@ export declare class PixelStreaming {
      */
     requestIframe(): boolean;
     /**
-     * Send data to UE application. The data will be run through JSON.stringify() so e.g. strings
-     * and any serializable plain JSON objects with no recurrence can be sent.
+     * 发送数据到终端应用。数据将通过JSON.stringify()运行，例如字符串
+     * 并且可以发送任何可序列化且没有递归的普通JSON对象。
      * @returns true if succeeded, false if rejected
      */
     emitUIInteraction(descriptor: object | string): boolean;
@@ -231,4 +253,7 @@ export declare class PixelStreaming {
      * Public getter for the webXrController controller. Used for all XR features.
      */
     get webXrController(): WebXRController;
+    registerMessageHandler(name: string, direction: MessageDirection, handler?: (data: ArrayBuffer | Array<number | string>) => void): void;
+    get toStreamerHandlers(): Map<string, (messageData?: (string | number)[]) => void>;
+    isReconnecting(): boolean;
 }

package/types/UeInstanceMessage/SendMessageController.d.ts

@@ -14,5 +14,5 @@ export declare class SendMessageController {
      * @param messageData - the message data we are sending over the data channel
      * @returns - nil
      */
-    sendMessageToStreamer(messageType: string, messageData?: Array<number>): void;
+    sendMessageToStreamer(messageType: string, messageData?: Array<number | string>): void;
 }

package/types/UeInstanceMessage/StreamMessageController.d.ts

@@ -1,14 +1,12 @@
-import { TwoWayMap } from './TwoWayMap';
 export declare class ToStreamerMessage {
     id: number;
-    byteLength: number;
     structure?: Array<string>;
 }
 export declare class StreamMessageController {
-    toStreamerHandlers: Map<string, (messageData?: Array<number> | undefined) => void>;
+    toStreamerHandlers: Map<string, (messageData?: Array<number | string> | undefined) => void>;
     fromStreamerHandlers: Map<string, (messageType: string, messageData?: ArrayBuffer | undefined) => void>;
-    toStreamerMessages: TwoWayMap<string, ToStreamerMessage>;
-    fromStreamerMessages: TwoWayMap<string, number>;
+    toStreamerMessages: Map<string, ToStreamerMessage>;
+    fromStreamerMessages: Map<number, string>;
     constructor();
     /**
      * Populate the Default message protocol

package/types/Util/EventEmitter.d.ts

@@ -8,6 +8,7 @@ import { SettingFlag } from '../Config/SettingFlag';
 import { SettingNumber } from '../Config/SettingNumber';
 import { SettingText } from '../Config/SettingText';
 import { SettingOption } from '../Config/SettingOption';
+import { DataChannelLatencyTestResponse, DataChannelLatencyTestResult } from "../DataChannel/DataChannelLatencyTestResults";
 /**
  * An event that is emitted when AFK disconnect is about to happen.
  * Can be cancelled by calling the callback function provided as part of the event.
@@ -102,7 +103,7 @@ export declare class WebRtcDisconnectedEvent extends Event {
         /** Message describing the disconnect reason */
         eventString: string;
         /** true if the user is able to reconnect, false if disconnected because of unrecoverable reasons like not able to connect to the signaling server */
-        showActionOrErrorOnDisconnect: boolean;
+        allowClickToReconnect: boolean;
     };
     constructor(data: WebRtcDisconnectedEvent['data']);
 }
@@ -252,7 +253,9 @@ export declare class StreamerListMessageEvent extends Event {
         /** Streamer list message containing an array of streamer ids */
         messageStreamerList: MessageStreamerList;
         /** Auto-selected streamer from the list, or null if unable to auto-select and user should be prompted to select */
-        autoSelectedStreamerId: string | null;
+        autoSelectedStreamerId: string;
+        /** Wanted streamer id from various configurations. */
+        wantedStreamerId: string;
     };
     constructor(data: StreamerListMessageEvent['data']);
 }
@@ -267,6 +270,29 @@ export declare class LatencyTestResultEvent extends Event {
     };
     constructor(data: LatencyTestResultEvent['data']);
 }
+/**
+ * An event that is emitted when receiving data channel latency test response from server.
+ * This event is handled by DataChannelLatencyTestController
+ */
+export declare class DataChannelLatencyTestResponseEvent extends Event {
+    readonly type: 'dataChannelLatencyTestResponse';
+    readonly data: {
+        /** Latency test result object */
+        response: DataChannelLatencyTestResponse;
+    };
+    constructor(data: DataChannelLatencyTestResponseEvent['data']);
+}
+/**
+ * An event that is emitted when data channel latency test results are ready.
+ */
+export declare class DataChannelLatencyTestResultEvent extends Event {
+    readonly type: 'dataChannelLatencyTestResult';
+    readonly data: {
+        /** Latency test result object */
+        result: DataChannelLatencyTestResult;
+    };
+    constructor(data: DataChannelLatencyTestResultEvent['data']);
+}
 /**
  * An event that is emitted when receiving initial settings from UE.
  */
@@ -347,7 +373,18 @@ export declare class XrFrameEvent extends Event {
     readonly data: XrFrameData;
     constructor(data: XrFrameEvent['data']);
 }
-export type PixelStreamingEvent = AfkWarningActivateEvent | AfkWarningUpdateEvent | AfkWarningDeactivateEvent | AfkTimedOutEvent | VideoEncoderAvgQPEvent | WebRtcSdpEvent | WebRtcAutoConnectEvent | WebRtcConnectingEvent | WebRtcConnectedEvent | WebRtcFailedEvent | WebRtcDisconnectedEvent | DataChannelOpenEvent | DataChannelCloseEvent | DataChannelErrorEvent | VideoInitializedEvent | StreamLoadingEvent | StreamPreConnectEvent | StreamReconnectEvent | StreamPreDisconnectEvent | PlayStreamErrorEvent | PlayStreamEvent | PlayStreamRejectedEvent | LoadFreezeFrameEvent | HideFreezeFrameEvent | StatsReceivedEvent | StreamerListMessageEvent | LatencyTestResultEvent | InitialSettingsEvent | SettingsChangedEvent | XrSessionStartedEvent | XrSessionEndedEvent | XrFrameEvent;
+/**
+ * An event that is emitted when receiving a player count from the signalling server
+ */
+export declare class PlayerCountEvent extends Event {
+    readonly type: 'playerCount';
+    readonly data: {
+        /** count object */
+        count: number;
+    };
+    constructor(data: PlayerCountEvent['data']);
+}
+export type PixelStreamingEvent = AfkWarningActivateEvent | AfkWarningUpdateEvent | AfkWarningDeactivateEvent | AfkTimedOutEvent | VideoEncoderAvgQPEvent | WebRtcSdpEvent | WebRtcAutoConnectEvent | WebRtcConnectingEvent | WebRtcConnectedEvent | WebRtcFailedEvent | WebRtcDisconnectedEvent | DataChannelOpenEvent | DataChannelCloseEvent | DataChannelErrorEvent | VideoInitializedEvent | StreamLoadingEvent | StreamPreConnectEvent | StreamReconnectEvent | StreamPreDisconnectEvent | PlayStreamErrorEvent | PlayStreamEvent | PlayStreamRejectedEvent | LoadFreezeFrameEvent | HideFreezeFrameEvent | StatsReceivedEvent | StreamerListMessageEvent | LatencyTestResultEvent | DataChannelLatencyTestResponseEvent | DataChannelLatencyTestResultEvent | InitialSettingsEvent | SettingsChangedEvent | XrSessionStartedEvent | XrSessionEndedEvent | XrFrameEvent | PlayerCountEvent;
 export declare class EventEmitter extends EventTarget {
     /**
      * Dispatch a new event.

package/types/Util/RTCUtils.d.ts

@@ -0,0 +1,8 @@
+export declare class RTCUtils {
+    static isVideoTransciever(transceiver: RTCRtpTransceiver | undefined): boolean;
+    static canTransceiverReceiveVideo(transceiver: RTCRtpTransceiver | undefined): boolean;
+    static canTransceiverSendVideo(transceiver: RTCRtpTransceiver | undefined): boolean;
+    static isAudioTransciever(transceiver: RTCRtpTransceiver | undefined): boolean;
+    static canTransceiverReceiveAudio(transceiver: RTCRtpTransceiver | undefined): boolean;
+    static canTransceiverSendAudio(transceiver: RTCRtpTransceiver | undefined): boolean;
+}

package/types/VideoPlayer/StreamController.d.ts

@@ -1,7 +1,7 @@
 import { MouseController } from '../Inputs/MouseController';
 import { VideoPlayer } from './VideoPlayer';
 /**
- * Video Player Controller handles the creation of the video HTML element and all handlers
+ * 视频播放器控制器处理视频HTML元素和所有处理程序的创建
  */
 export declare class StreamController {
     videoElementProvider: VideoPlayer;
@@ -17,8 +17,8 @@ export declare class StreamController {
      */
     handleOnTrack(rtcTrackEvent: RTCTrackEvent): void;
     /**
-     * Creates the audio device when receiving an RTCTrackEvent with the kind of "audio"
-     * @param audioMediaStream - Audio Media stream track
+     * 当接收到类型为"audio"的RTCTrackEvent时创建音频设备
+     * @param audioMediaStream—音频媒体流track
      */
     CreateAudioTrack(audioMediaStream: MediaStream): void;
 }

package/types/VideoPlayer/VideoPlayer.d.ts

@@ -13,6 +13,7 @@ declare global {
 export declare class VideoPlayer {
     private config;
     private videoElement;
+    private audioElement?;
     private orientationChangeTimeout;
     private lastTimeResized;
     onMatchViewportResolutionCallback: (width: number, height: number) => void;
@@ -23,6 +24,7 @@ export declare class VideoPlayer {
      * @param config the applications configuration. We're interested in the startVideoMuted flag
      */
     constructor(videoElementParent: HTMLElement, config: Config);
+    setAudioElement(audioElement: HTMLAudioElement): void;
     /**
      * Sets up the video element with any application config and plays the video element.
      * @returns A promise for if playing the video was successful or not.

package/types/WebRtcPlayer/WebRtcPlayerController.d.ts

@@ -11,10 +11,9 @@ import { Config } from '../Config/Config';
 import { FileTemplate } from '../Util/FileUtil';
 import { InputClassesFactory } from '../Inputs/InputClassesFactory';
 import { VideoPlayer } from '../VideoPlayer/VideoPlayer';
-import { StreamMessageController } from '../UeInstanceMessage/StreamMessageController';
+import { StreamMessageController, MessageDirection } from '../UeInstanceMessage/StreamMessageController';
 import { ResponseController } from '../UeInstanceMessage/ResponseController';
 import * as MessageReceive from '../WebSockets/MessageReceive';
-import { SendDescriptorController } from '../UeInstanceMessage/SendDescriptorController';
 import { SendMessageController } from '../UeInstanceMessage/SendMessageController';
 import { ToStreamerMessagesController } from '../UeInstanceMessage/ToStreamerMessagesController';
 import { MouseController } from '../Inputs/MouseController';
@@ -23,6 +22,7 @@ import { DataChannelSender } from '../DataChannel/DataChannelSender';
 import { CoordinateConverter, UnquantizedDenormalizedUnsignedCoord } from '../Util/CoordinateConverter';
 import { PixelStreaming } from '../PixelStreaming/PixelStreaming';
 import { ITouchController } from '../Inputs/ITouchController';
+import { DataChannelLatencyTestRequest } from '../DataChannel/DataChannelLatencyTestResults';
 /**
  * Entry point for the WebRTC Player
  */
@@ -46,7 +46,6 @@ export declare class WebRtcPlayerController {
     latencyStartTime: number;
     pixelStreaming: PixelStreaming;
     streamMessageController: StreamMessageController;
-    sendDescriptorController: SendDescriptorController;
     sendMessageController: SendMessageController;
     toStreamerMessagesController: ToStreamerMessagesController;
     keyboardController: KeyboardController;
@@ -61,12 +60,14 @@ export declare class WebRtcPlayerController {
     preferredCodec: string;
     peerConfig: RTCConfiguration;
     videoAvgQp: number;
+    locallyClosed: boolean;
     shouldReconnect: boolean;
     isReconnecting: boolean;
     reconnectAttempt: number;
-    subscribedStream: string | null;
+    disconnectMessage: string;
+    subscribedStream: string;
     signallingUrlBuilder: () => string;
-    disconnectMessageOverride: string;
+    autoJoinTimer: ReturnType<typeof setTimeout>;
     /**
      *
      * @param config - the frontend config object
@@ -115,11 +116,11 @@ export declare class WebRtcPlayerController {
      */
     setAfkEnabled(afkEnabled: boolean): void;
     /**
-     * Restart the stream automatically without refreshing the page
+     * 尝试重新连接到信令服务器
      */
-    restartStreamAutomatically(): void;
+    tryReconnect(message: string): void;
     /**
-     * Loads a freeze frame if it is required otherwise shows the play overlay
+     * 如果需要，加载一个定格帧，否则显示播放覆盖
      */
     loadFreezeFrameOrShowPlayOverlay(): void;
     /**
@@ -147,7 +148,7 @@ export declare class WebRtcPlayerController {
      */
     onFileContents(data: ArrayBuffer): void;
     /**
-     * Plays the stream audio and video source and sets up other pieces while the stream starts
+     * 播放流音频和视频源，并在流启动时设置其他片段
      */
     playStream(): void;
     /**
@@ -159,7 +160,7 @@ export declare class WebRtcPlayerController {
      */
     autoPlayVideoOrSetUpPlayOverlay(): void;
     /**
-     * Connect to the Signaling server
+     * 连接发信服务器
      */
     connectToSignallingServer(): void;
     /**
@@ -173,16 +174,16 @@ export declare class WebRtcPlayerController {
      */
     checkTurnServerAvailability(options: RTCConfiguration): boolean;
     /**
-     * Handles when a Config Message is received contains the Peer Connection Options required (STUN and TURN Server Info)
-     * @param messageConfig - Config Message received from the signaling server
+     * 接收到配置消息时的处理包含所需的对等连接选项(STUN和TURN服务器信息)
+     * @param messageConfig—从发信服务器接收到的配置消息
      */
     handleOnConfigMessage(messageConfig: MessageConfig): void;
     /**
-     * Handles when the signalling server gives us the list of streamer ids.
+     * 当信令服务器给我们streamer id列表时处理。
      */
     handleStreamerListMessage(messageStreamerList: MessageStreamerList): void;
     /**
-     * Handle the RTC Answer from the signaling server
+     * 处理发信服务器的RTC应答
      * @param Answer - Answer SDP from the peer.
      */
     handleWebRtcAnswer(Answer: MessageAnswer): void;
@@ -227,15 +228,15 @@ export declare class WebRtcPlayerController {
      */
     setUpMouseAndFreezeFrame(): void;
     /**
-     * Close the Connection to the signaling server
+     * 关闭到发信服务器的连接
      */
-    closeSignalingServer(): void;
+    closeSignalingServer(message: string): void;
     /**
-     * Close the peer connection
+     * 关闭对端连接
      */
     closePeerConnection(): void;
     /**
-     * Close all connections
+     * 关闭所有连接
      */
     close(): void;
     /**
@@ -243,9 +244,13 @@ export declare class WebRtcPlayerController {
      */
     getStats(): void;
     /**
-     * Send a Latency Test Request to the UE Instance
+     * 向UE实例发送时延测试请求
      */
     sendLatencyTest(): void;
+    /**
+     * Send a Data Channel Latency Test Request to the UE Instance
+     */
+    sendDataChannelLatencyTest(descriptor: DataChannelLatencyTestRequest): void;
     /**
      * Send the MinQP encoder setting to the UE Instance.
      * @param minQP - The lower bound for QP when encoding
@@ -316,6 +321,11 @@ export declare class WebRtcPlayerController {
      * @param message - Latency Test Timings
      */
     handleLatencyTestResult(message: ArrayBuffer): void;
+    /**
+     * Handles when a Data Channel Latency Test Response is received from the UE Instance
+     * @param message - Data Channel Latency Test Response
+     */
+    handleDataChannelLatencyTestResponse(message: ArrayBuffer): void;
     /**
      * Handles when the Encoder and Web RTC Settings are received from the UE Instance
      * @param message - Initial Encoder and Web RTC Settings
@@ -344,14 +354,6 @@ export declare class WebRtcPlayerController {
      * To Resize the Video Player element
      */
     resizePlayerStyle(): void;
-    /**
-     * Get the overridden disconnect message
-     */
-    getDisconnectMessageOverride(): string;
-    /**
-     * Set the override for the disconnect message
-     */
-    setDisconnectMessageOverride(message: string): void;
     setPreferredCodec(codec: string): void;
     setVideoEncoderAvgQP(avgQP: number): void;
     /**
@@ -371,4 +373,5 @@ export declare class WebRtcPlayerController {
      */
     setGamePadInputEnabled(isEnabled: boolean): void;
     registerDataChannelEventEmitters(dataChannel: DataChannelController): void;
+    registerMessageHandler(name: string, direction: MessageDirection, handler?: (data: ArrayBuffer | Array<number | string>) => void): void;
 }

package/types/WebSockets/MessageReceive.d.ts

@@ -13,43 +13,43 @@ export declare enum MessageRecvTypes {
     WARNING = "warning"
 }
 /**
- * Concrete Received Message wrapper
+ * 具体的接收消息包装器
  */
 export declare class MessageRecv {
     type: string;
     id: string;
 }
 /**
- * Authentication Required Message wrapper
+ * 身份验证所需的消息包装器
  */
 export declare class MessageAuthRequired extends MessageRecv {
 }
 /**
- * Config Message Wrapper
+ * 配置消息包装器
  */
 export declare class MessageConfig extends MessageRecv {
     peerConnectionOptions: RTCConfiguration;
 }
 /**
- * Streamer List Message Wrapper
+ * Streamer列表消息包装器
  */
 export declare class MessageStreamerList extends MessageRecv {
     ids: string[];
 }
 /**
- * Player Count Message wrapper
+ * 玩家计数消息包装器
  */
 export declare class MessagePlayerCount extends MessageRecv {
     count: number;
 }
 /**
- * Web RTC offer Answer Message wrapper
+ * Web RTC提供应答消息包装器
  */
 export declare class MessageAnswer extends MessageRecv {
     sdp: string;
 }
 /**
- * WebRTC sdp offer Message wrapper.
+ * WebRTC sdp提供了消息包装器。
  */
 export declare class MessageOffer extends MessageRecv {
     sdp: string;
@@ -57,13 +57,13 @@ export declare class MessageOffer extends MessageRecv {
     defaultToHover?: string;
 }
 /**
- * Ice Candidate Message wrapper
+ * Ice候选消息包装器
  */
 export declare class MessageIceCandidate extends MessageRecv {
     candidate: RTCIceCandidateInit;
 }
 /**
- * Peer Data Channels Message wrapper
+ * 对等数据通道消息包装器
  */
 export declare class MessagePeerDataChannels extends MessageRecv {
     recvStreamId: number;