@yang__yj/pixelstreaming-core 1.0.1 → 1.0.2

package/types/WebSockets/MessageSend.d.ts

@@ -1,5 +1,5 @@
 /**
- * The Send Types that are pushed from the signaling server
+ * 从发信服务器推送的发送类型
  */
 export declare enum MessageSendTypes {
     LIST_STREAMERS = "listStreamers",
@@ -13,27 +13,31 @@ export declare enum MessageSendTypes {
     PONG = "pong"
 }
 /**
- * A Wrapper for the message to send to the signaling server
+ * 要发送到发信服务器的消息的包装器
  */
 export declare class MessageSend implements Send {
     type: string;
     peerConnectionOptions: object;
     /**
-     * Turns the wrapper into a JSON String
-     * @returns - JSON String of the Message to send
+     * 将包装器转换为JSON字符串
+     * @returns——要发送的消息的JSON字符串
      */
     payload(): string;
 }
 export interface Send {
     /**
-     * Turns the wrapper into a JSON String
-     * @returns - JSON String of the Message to send
+    *将包装器转换为JSON字符串
+    * @returns——要发送的消息的JSON字符串
      */
     payload: () => string;
 }
 export declare class MessageListStreamers extends MessageSend {
     constructor();
 }
+export declare class requestStreamerObject extends MessageSend {
+    streamerName: string;
+    constructor(streamerid: string);
+}
 export declare class MessageSubscribe extends MessageSend {
     streamerId: string;
     constructor(streamerid: string);
@@ -42,14 +46,14 @@ export declare class MessageUnsubscribe extends MessageSend {
     constructor();
 }
 /**
- * Instance Request Message Wrapper
+ * 实例请求消息包装器
  */
 export declare class MessagePong extends MessageSend {
     time: number;
     constructor(time: number);
 }
 /**
- *  Web RTC Offer message wrapper
+ *  Web RTC提供消息包装器
  */
 export declare class MessageWebRTCOffer extends MessageSend {
     sdp: string;
@@ -59,7 +63,7 @@ export declare class MessageWebRTCOffer extends MessageSend {
     constructor(offer?: RTCSessionDescriptionInit);
 }
 /**
- *  Web RTC Answer message wrapper
+ *  Web RTC应答消息包装器
  */
 export declare class MessageWebRTCAnswer extends MessageSend {
     sdp: string;

package/types/WebSockets/SignallingProtocol.d.ts

@@ -1,6 +1,6 @@
 import { WebSocketController } from './WebSocketController';
 /**
- * Signalling protocol for handling messages from the signalling server.
+ * 信令协议，用于处理来自信令服务器的消息。
  */
 export declare class SignallingProtocol {
     private FromUEMessageHandlers;
@@ -8,8 +8,8 @@ export declare class SignallingProtocol {
     addMessageHandler(messageId: string, messageHandler: (payload: string) => void): void;
     handleMessage(messageId: string, messageData: string): void;
     /**
-     * Setup any default signalling message handling, these can be overridden or additional handlers added with `addMessageHandler`.
-     * @param websocketController The controller to setup these handlers on.
+     * 设置任何默认的信号消息处理，这些可以被覆盖或使用`addMessageHandler`添加额外的处理程序。
+     * @param websocketController 设置这些处理程序的控制器。
      */
     static setupDefaultHandlers(websocketController: WebSocketController): void;
 }

package/types/WebSockets/WebSocketController.d.ts

@@ -16,37 +16,38 @@ export declare class WebSocketController {
     signallingProtocol: SignallingProtocol;
     constructor();
     /**
-     * Connect to the signaling server
-     * @param connectionURL - The Address of the signaling server
-     * @returns - If there is a connection
+     * 连接发信服务器
+     * @param connectionURL——发信服务器的地址
+     * @returns—是否存在连接
      */
     connect(connectionURL: string): boolean;
     /**
-     * Handles what happens when a message is received in binary form
+     * 处理以二进制形式接收消息时发生的情况
      * @param event - Message Received
      */
     handleOnMessageBinary(event: MessageEvent): void;
     /**
-     * Handles what happens when a message is received
+     * 处理接收到消息时发生的事情
      * @param event - Message Received
      */
     handleOnMessage(event: MessageEvent): void;
     /**
-     * Handles when the Websocket is opened
+     * 处理Websocket打开时的事件
      * @param event - Not Used
      */
     handleOnOpen(event: Event): void;
     /**
-     * Handles when there is an error on the websocket
+     * 在websocket中处理错误
      * @param event - Error Payload
      */
     handleOnError(): void;
     /**
-     * Handles when the Websocket is closed
+     * 当Websocket关闭时处理
      * @param event - Close Event
      */
     handleOnClose(event: CloseEvent): void;
     requestStreamerList(): void;
+    requestStreamerObject(streamerid: string): void;
     sendSubscribe(streamerid: string): void;
     sendUnsubscribe(): void;
     sendWebRtcOffer(offer: RTCSessionDescriptionInit): void;
@@ -54,16 +55,14 @@ export declare class WebSocketController {
     sendWebRtcDatachannelRequest(): void;
     sendSFURecvDataChannelReady(): void;
     /**
-     * Sends an RTC Ice Candidate to the Server
-     * @param candidate - RTC Ice Candidate
+    *向服务器发送一个RTC Ice候选项
+    * @param candidate—RTC Ice候选
      */
     sendIceCandidate(candidate: RTCIceCandidate): void;
     /**
      * Closes the Websocket connection
      */
     close(): void;
-    /** Event used for Displaying websocket closed messages */
-    onWebSocketOncloseOverlayMessage(event: CloseEvent): void;
     /**
      * The Message Contains the payload of the peer connection options used for the RTC Peer hand shake
      * @param messageConfig - Config Message received from he signaling server
@@ -93,4 +92,9 @@ export declare class WebSocketController {
      * @param messageDataChannels - The data channels details
      */
     onWebRtcPeerDataChannels(messageDataChannels: MessageReceive.MessagePeerDataChannels): void;
+    /**
+     * Event is fired when the websocket receives the an updated player count from cirrus
+     * @param MessagePlayerCount - The new player count
+     */
+    onPlayerCount(playerCount: MessageReceive.MessagePlayerCount): void;
 }

package/types/pixelstreamingfrontend.d.ts

@@ -1,6 +1,6 @@
 export { WebRtcPlayerController } from './WebRtcPlayer/WebRtcPlayerController';
 export { WebXRController } from './WebXR/WebXRController';
-export { Config, ControlSchemeType, Flags, NumericParameters, TextParameters, OptionParameters, FlagsIds, NumericParametersIds, TextParametersIds, OptionParametersIds, AllSettings } from './Config/Config';
+export { Config, ControlSchemeType, Flags, NumericParameters, TextParameters, OptionParameters, } from './Config/Config';
 export { SettingBase } from './Config/SettingBase';
 export { SettingFlag } from './Config/SettingFlag';
 export { SettingNumber } from './Config/SettingNumber';
@@ -13,6 +13,7 @@ export { EncoderSettings, InitialSettings, WebRTCSettings } from './DataChannel/
 export { AggregatedStats } from './PeerConnectionController/AggregatedStats';
 export { Logger } from './Logger/Logger';
 export { UnquantizedDenormalizedUnsignedCoord as UnquantizedAndDenormalizeUnsigned } from './Util/CoordinateConverter';
+export { MessageDirection } from './UeInstanceMessage/StreamMessageController';
 export { MessageSend } from './WebSockets/MessageSend';
 export { MessageRecv, MessageStreamerList } from './WebSockets/MessageReceive';
 export { WebSocketController } from './WebSockets/WebSocketController';