@realsee/live 0.3.0-alpha.2 → 0.4.0-alpha.1

package/{lib/RTC → dist/rtc}/BrowserRTC.d.ts

@@ -1,30 +1,29 @@
-import { Subscribe } from '../shared-utils/Subscribe';
-import { RTCEventType } from '../typings/RTCEventType';
-import { RTCProtocol, RTCType } from '../typings/RTCProtocol';
-import { GetVoiceSign } from '../typings/GetVoiceSign';
-export declare class BrowserRTC extends Subscribe<RTCEventType> implements RTCProtocol {
-    type: RTCType;
-    joined: boolean;
-    micro: boolean;
-    voiceId: string;
-    private _getVoiceSign;
-    private $dom;
-    private _trtc;
-    constructor(options: {
-        getVoiceSign: GetVoiceSign;
-    });
-    private _initParentDom;
-    join: (options: {
-        voiceId: string;
-        userId: string;
-        roomId: string;
-        type: RTCType;
-    }) => Promise<boolean>;
-    quit(): Promise<boolean>;
-    detectMicro(): Promise<boolean>;
-    toggleMicro(flag?: boolean): Promise<boolean>;
-    shock(): void;
-    private _registerRtcEvent;
-    private _handleStreamAdded;
-    private _handleStreamSubscribed;
-}
+import { GetVoiceSign } from '../typings/live/GetVoiceSign';
+import { RTCType } from '../typings/rtc/type';
+import { CoreRTC } from './CoreRTC';
+export declare class BrowserRTC extends CoreRTC {
+    type: RTCType;
+    joined: boolean;
+    micro: boolean;
+    voiceId: string;
+    private _getVoiceSign;
+    private $dom;
+    private _trtc;
+    constructor(options: {
+        getVoiceSign: GetVoiceSign;
+    });
+    private _initParentDom;
+    join: (options: {
+        voiceId: string;
+        userId: string;
+        roomId: string;
+        type: RTCType;
+    }) => Promise<boolean>;
+    quit(): Promise<boolean>;
+    detectMicro(): Promise<boolean>;
+    toggleMicro(flag?: boolean): Promise<boolean>;
+    shock(): void;
+    private _registerRtcEvent;
+    private _handleStreamAdded;
+    private _handleStreamSubscribed;
+}

package/{lib/RTC → dist/rtc}/BrowserRTC4Chime.d.ts

@@ -1,53 +1,55 @@
-import { Subscribe } from "../shared-utils/Subscribe";
-import { RTCEventType } from "../typings/RTCEventType";
-import { RTCProtocol, RTCType } from "../typings/RTCProtocol";
-import { GetVoiceSign } from "../typings/GetVoiceSign";
-import { AudioVideoObserver, ConsoleLogger, DefaultDeviceController, DefaultMeetingSession, DeviceChangeObserver, LogLevel } from "amazon-chime-sdk-js";
-export declare class BrowserRTC4Chime extends Subscribe<RTCEventType> implements RTCProtocol {
-    type: RTCType;
-    joined: boolean;
-    micro: boolean;
-    voiceId: string;
-    userId: string;
-    logger: ConsoleLogger;
-    deviceController: DefaultDeviceController;
-    meetingSession: DefaultMeetingSession | undefined;
-    audioInput: MediaDeviceInfo | undefined;
-    audioOutput: MediaDeviceInfo | undefined;
-    deviceChangeObserver: DeviceChangeObserver;
-    audioVideoObserver: AudioVideoObserver;
-    private _getVoiceSign;
-    private $dom;
-    private $audio;
-    constructor(options: {
-        getVoiceSign: GetVoiceSign;
-        logLevel?: LogLevel;
-    });
-    /**
-     * 对audio标签初始化
-     */
-    _initDom: () => void;
-    /**
-     * 初始化事件监听器
-     */
-    initObservers: () => void;
-    /**
-     * 加入语音会议
-     * @param options
-     * @returns
-     */
-    join(options: {
-        voiceId: string;
-        userId: string;
-        roomId: string | number | undefined;
-        type: RTCType;
-    }): Promise<boolean>;
-    /**
-     * 注册rtc事件
-     */
-    _registerRtcEvent: () => void;
-    quit(): Promise<boolean>;
-    detectMicro(): Promise<boolean>;
-    toggleMicro(flag?: boolean): Promise<boolean>;
-    shock(): void;
-}
+import { AudioVideoObserver, ConsoleLogger, DefaultDeviceController, DefaultMeetingSession, DeviceChangeObserver, LogLevel } from 'amazon-chime-sdk-js';
+import { GetVoiceSign } from '../typings/live/GetVoiceSign';
+import { RTCType } from '../typings/rtc/type';
+import { CoreRTC } from './CoreRTC';
+/**
+ * amazon-chime-sdk-js 适配的rtc实现
+ */
+export declare class BrowserRTC4Chime extends CoreRTC {
+    type: RTCType;
+    joined: boolean;
+    micro: boolean;
+    voiceId: string;
+    userId: string;
+    logger: ConsoleLogger;
+    deviceController: DefaultDeviceController;
+    meetingSession: DefaultMeetingSession | undefined;
+    audioInput: MediaDeviceInfo | undefined;
+    audioOutput: MediaDeviceInfo | undefined;
+    deviceChangeObserver: DeviceChangeObserver;
+    audioVideoObserver: AudioVideoObserver;
+    private _getVoiceSign;
+    private $dom;
+    private $audio;
+    constructor(options: {
+        getVoiceSign: GetVoiceSign;
+        logLevel?: LogLevel;
+    });
+    /**
+     * 对audio标签初始化
+     */
+    _initDom: () => void;
+    /**
+     * 初始化事件监听器
+     */
+    initObservers: () => void;
+    /**
+     * 加入语音会议
+     * @param options
+     * @returns
+     */
+    join(options: {
+        voiceId: string;
+        userId: string;
+        roomId: string | number | undefined;
+        type: RTCType;
+    }): Promise<boolean>;
+    /**
+     * 注册rtc事件
+     */
+    _registerRtcEvent: () => void;
+    quit(): Promise<boolean>;
+    detectMicro(): Promise<boolean>;
+    toggleMicro(flag?: boolean): Promise<boolean>;
+    shock(): void;
+}

package/dist/rtc/CoreRTC.d.ts

@@ -0,0 +1,23 @@
+import { RTCEventType } from '../typings/rtc/eventType';
+import { RTCProtocol } from '../typings/rtc/protocol';
+import { RTCType } from '../typings/rtc/type';
+import { Subscribe } from '../utils/subscribe';
+/**
+ * rtc 基础抽象类
+ */
+export declare abstract class CoreRTC extends Subscribe<RTCEventType> implements RTCProtocol {
+    abstract joined: boolean;
+    abstract micro: boolean;
+    abstract voiceId: string;
+    abstract type: RTCType;
+    abstract join(options: {
+        voiceId: string;
+        userId: string;
+        roomId: string | number | undefined;
+        type: RTCType;
+    }): Promise<boolean>;
+    abstract quit(): Promise<boolean>;
+    abstract detectMicro(): Promise<boolean>;
+    abstract toggleMicro(flag?: boolean): Promise<boolean>;
+    abstract shock(): void;
+}

package/{lib/RTC → dist/rtc}/VRWebViewRTC.d.ts

@@ -1,23 +1,22 @@
-import { Subscribe } from '../shared-utils/Subscribe';
-import { RTCEventType } from '../typings/RTCEventType';
-import { RTCProtocol, RTCType } from '../typings/RTCProtocol';
-import { VRWebViewRTCOptions } from '../typings/VRWebViewRTCOptions';
-export declare class VRWebViewRTC extends Subscribe<RTCEventType> implements RTCProtocol {
-    type: RTCType;
-    joined: boolean;
-    micro: boolean;
-    voiceId: string;
-    private options;
-    get jsBridge(): import("@realsee/jsbridge-x/lib/typings/JSBridgeProtocol").JSBridgeProtocol;
-    constructor({ jsBridge, getVoiceSign }: VRWebViewRTCOptions);
-    join(options: {
-        voiceId: string;
-        userId: string;
-        roomId: string;
-        type: RTCType;
-    }): Promise<boolean>;
-    quit(): Promise<boolean>;
-    detectMicro(): Promise<boolean>;
-    toggleMicro(flag?: boolean): Promise<boolean>;
-    shock(): void;
-}
+import { RTCType } from '../typings/rtc/type';
+import { VRWebViewRTCOptions } from '../typings/rtc/VRWebViewRTCOptions';
+import { CoreRTC } from './CoreRTC';
+export declare class VRWebViewRTC extends CoreRTC {
+    type: RTCType;
+    joined: boolean;
+    micro: boolean;
+    voiceId: string;
+    private options;
+    get jsBridge(): import("@realsee/jsbridge-x").JSBridgeProtocol;
+    constructor({ jsBridge, getVoiceSign }: VRWebViewRTCOptions);
+    join(options: {
+        voiceId: string;
+        userId: string;
+        roomId: string;
+        type: RTCType;
+    }): Promise<boolean>;
+    quit(): Promise<boolean>;
+    detectMicro(): Promise<boolean>;
+    toggleMicro(flag?: boolean): Promise<boolean>;
+    shock(): void;
+}

package/dist/rtc/index.d.ts

@@ -0,0 +1,5 @@
+export { CoreRTC } from './CoreRTC';
+export { BrowserRTC } from './BrowserRTC';
+export { BrowserRTC4Chime } from './BrowserRTC4Chime';
+export { VRWebViewRTC } from './VRWebViewRTC';
+export type { RTCProtocol } from '../typings/rtc/protocol';

package/{lib/typings/Chime → dist/typings/chime}/AttendeeResponse.d.ts

@@ -1,5 +1,5 @@
-export interface AttendeeResponse {
-    attendee_id: string;
-    external_user_id: string;
-    join_token: string;
-}
+export interface AttendeeResponse {
+    attendee_id: string;
+    external_user_id: string;
+    join_token: string;
+}

package/{lib/typings/Chime → dist/typings/chime}/MeetingResponse.d.ts

@@ -1,12 +1,12 @@
-export interface MeetingResponse {
-    MediaPlacement: {
-        AudioFallbackUrl: string;
-        AudioHostUrl: string;
-        ScreenDataUrl: string;
-        ScreenSharingUrl: string;
-        ScreenViewingUrl: string;
-        SignalingUrl: string;
-        TurnControlUrl: string;
-    };
-    MeetingId: string;
-}
+export interface MeetingResponse {
+    MediaPlacement: {
+        AudioFallbackUrl: string;
+        AudioHostUrl: string;
+        ScreenDataUrl: string;
+        ScreenSharingUrl: string;
+        ScreenViewingUrl: string;
+        SignalingUrl: string;
+        TurnControlUrl: string;
+    };
+    MeetingId: string;
+}

package/{lib/typings/Chime → dist/typings/chime}/MeetingSessionConfigurationOptions.d.ts

@@ -1,16 +1,16 @@
-import { AttendeeResponse } from "./AttendeeResponse";
-import { MeetingResponse } from "./MeetingResponse";
-export interface MeetingSessionConfigurationOptions {
-    attendence: AttendeeResponse;
-    config: {
-        passport: string;
-        vendor: string;
-        app_id: string;
-        bypass: any;
-    };
-    expire_time: number;
-    identifier: string;
-    user_id: string;
-    user_sig: string;
-    vendor_wrapper: MeetingResponse;
-}
+import { AttendeeResponse } from "./AttendeeResponse";
+import { MeetingResponse } from "./MeetingResponse";
+export interface MeetingSessionConfigurationOptions {
+    attendence: AttendeeResponse;
+    config: {
+        passport: string;
+        vendor: string;
+        app_id: string;
+        bypass: any;
+    };
+    expire_time: number;
+    identifier: string;
+    user_id: string;
+    user_sig: string;
+    vendor_wrapper: MeetingResponse;
+}

package/dist/typings/chime/index.d.ts

@@ -0,0 +1,3 @@
+export * from './AttendeeResponse';
+export * from './MeetingResponse';
+export * from './MeetingSessionConfigurationOptions';

package/dist/typings/index.d.ts

@@ -0,0 +1,4 @@
+export * from './chime';
+export * from './live';
+export * from './react';
+export * from './rtc';

package/{lib/typings → dist/typings/live}/EventType.d.ts

@@ -1,89 +1,90 @@
-import { BuiltinMsg, LiveMsg } from './LiveMsg';
-import { UserInfo } from './UserInfo';
-import { WebSocketError, WebSocketState } from './WebSocket';
-/**
- * WebSocket 相关异步事件
- * @description 可以
- */
-declare type WebSocketEventType = {
-    /**
-     * WebSocket 状态发生更新
-     * @param readyState - 当前状态枚举值。
-     */
-    'ws.readyStateUpdate'(readyState: WebSocketState): void;
-    /**
-     * WebSocket 连接前
-     */
-    'ws.beforeConnect'(reConnect?: number): void;
-    /**
-     * WebSocket 连接后
-     */
-    'ws.afterConnect'(reConnect?: number): void;
-    /**
-     * WebSocket 连接过程中遭遇的异常情况信息。
-     * @param error - 错误信息。
-     */
-    'ws.error'(error: WebSocketError): void;
-    /**
-     * WebSocket 收到的消息
-     * @param liveMsg - 透传 WebSocket 消息
-     */
-    'ws.message'(liveMsg: LiveMsg): void;
-};
-declare type LiveEventType<Snapshot> = {
-    /**
-     * 内置消息事件
-     * @param builtinMsg
-     */
-    'builtinEvent'(builtinMsg: BuiltinMsg): void;
-    /**
-     * 内置消息事件: 用户信息改变
-     * @param builtinMsg
-     */
-    'userChange'(builtinMsg: BuiltinMsg): void;
-    /**
-     * 内置消息事件：房间信息改变
-     * @param builtinMsg
-     */
-    'roomChange'(builtinMsg: BuiltinMsg): void;
-    /**
-     * 收到其他用户的广播消息。
-     * @param evtMsg
-     */
-    'broadcast'(evtMsg: Record<string, any>, frontRequestId: string): void;
-    /**
-     * 带看已经就绪，可以发送帧数据。
-     * @param lastKeyframe 带看最后一帧数据（链接切换、断网等重连恢复上次会话帧状态），你可以通过此数据拉齐当前UI状态。
-     */
-    'readyKeyframeSync'(lastKeyframe: Partial<Snapshot>): void;
-    /**
-     * 获取其他用户输送的帧数据：根据此帧数据更新UI状态。
-     * @param keyframes
-     */
-    'keyframes'(keyframes: Partial<Snapshot>, frontRequestId: string): void;
-    /**
-     * 个人信息发生更新。
-     * @param userInfo
-     */
-    'selfInfoUpdate'(userInfo: UserInfo, frontRequestId: string): void;
-    /**
-     * 用户列表更新。
-     * @param userList
-     */
-    'userListUpdate'(userList: UserInfo[], frontRequestId: string): void;
-    /**
-     * 被踢出房间
-     * @param
-     * */
-    'kickOut'(): void;
-    /**
-     * 异常消息：不符合规范。
-     * @param liveMsg
-     */
-    'error'(liveMsg: LiveMsg): void;
-};
-declare type KeyframeTypes<Type> = {
-    [Property in keyof Type as Property]: (nextKeyframes: Type[Property], prevKeyframes: Type[Property], frontRequestId: string) => void;
-};
-declare type EventType<Snapshot> = LiveEventType<Snapshot> & WebSocketEventType;
-export { LiveEventType, WebSocketEventType, KeyframeTypes, EventType };
+import { BuiltinMsg, LiveMsg } from './LiveMsg';
+import { UserInfo } from './UserInfo';
+import { WebSocketError, WebSocketState } from './WebSocket';
+/**
+ * WebSocket 相关异步事件
+ * @description
+ * @deprecated 这些事件不应暴露给应用层
+ */
+declare type WebSocketEventType = {
+    /**
+     * WebSocket 状态发生更新
+     * @param readyState - 当前状态枚举值。
+     */
+    'ws.readyStateUpdate'(readyState: WebSocketState): void;
+    /**
+     * WebSocket 连接前
+     */
+    'ws.beforeConnect'(reConnect?: number): void;
+    /**
+     * WebSocket 连接后
+     */
+    'ws.afterConnect'(reConnect?: number): void;
+    /**
+     * WebSocket 连接过程中遭遇的异常情况信息。
+     * @param error - 错误信息。
+     */
+    'ws.error'(error: WebSocketError): void;
+    /**
+     * WebSocket 收到的消息
+     * @param liveMsg - 透传 WebSocket 消息
+     */
+    'ws.message'(liveMsg: LiveMsg): void;
+};
+declare type LiveEventType<Snapshot> = {
+    /**
+     * 内置消息事件
+     * @param builtinMsg
+     */
+    'builtinEvent'(builtinMsg: BuiltinMsg): void;
+    /**
+     * 内置消息事件: 用户信息改变
+     * @param builtinMsg
+     */
+    'userChange'(builtinMsg: BuiltinMsg): void;
+    /**
+     * 内置消息事件：房间信息改变
+     * @param builtinMsg
+     */
+    'roomChange'(builtinMsg: BuiltinMsg): void;
+    /**
+     * 收到其他用户的广播消息。
+     * @param evtMsg
+     */
+    'broadcast'(evtMsg: Record<string, any>, frontRequestId: string): void;
+    /**
+     * 带看已经就绪，可以发送帧数据。
+     * @param lastKeyframe 带看最后一帧数据（链接切换、断网等重连恢复上次会话帧状态），你可以通过此数据拉齐当前UI状态。
+     */
+    'readyKeyframeSync'(lastKeyframe: Partial<Snapshot>): void;
+    /**
+     * 获取其他用户输送的帧数据：根据此帧数据更新UI状态。
+     * @param keyframes
+     */
+    'keyframes'(keyframes: Partial<Snapshot>, frontRequestId: string): void;
+    /**
+     * 个人信息发生更新。
+     * @param userInfo
+     */
+    'selfInfoUpdate'(userInfo: UserInfo, frontRequestId: string): void;
+    /**
+     * 用户列表更新。
+     * @param userList
+     */
+    'userListUpdate'(userList: UserInfo[], frontRequestId: string): void;
+    /**
+     * 被踢出房间
+     * @param
+     * */
+    'kickOut'(): void;
+    /**
+     * 异常消息：不符合规范。
+     * @param liveMsg
+     */
+    'error'(liveMsg: LiveMsg): void;
+};
+declare type KeyframeTypes<Type> = {
+    [Property in keyof Type as Property]: (nextKeyframes: Type[Property], prevKeyframes: Type[Property], frontRequestId: string) => void;
+};
+declare type EventType<Snapshot> = LiveEventType<Snapshot> & WebSocketEventType;
+export { LiveEventType, WebSocketEventType, KeyframeTypes, EventType };

package/{lib/typings → dist/typings/live}/GetVoiceSign.d.ts

@@ -1,11 +1,17 @@
-export interface GetVoiceSignReturnType {
-    sdkAppId: number;
-    userId: string;
-    roomId: string | number;
-    userSig: string;
-}
-export declare type GetVoiceSign = ({ voiceId, userId, roomId }: {
-    voiceId: string;
-    userId: string;
-    roomId: string | number;
-}) => Promise<GetVoiceSignReturnType>;
+/**
+ * 语音签名的返回值
+ */
+export interface GetVoiceSignReturnType {
+    sdkAppId: number;
+    userId: string;
+    roomId: string | number;
+    userSig: string;
+}
+/**
+ * 获取用户语音签名
+ */
+export declare type GetVoiceSign = ({ voiceId, userId, roomId, }: {
+    voiceId: string;
+    userId: string;
+    roomId: string | number;
+}) => Promise<GetVoiceSignReturnType>;