@realsee/live 0.7.1 → 0.7.3-alpha.0

package/dist/live/controller.d.ts

@@ -0,0 +1,118 @@
+import { LiveMsg } from '../typings';
+import { LiveState } from '../typings/live/LiveState';
+import { RobustWebSocketEventDetail } from '../utils/RobustWebSocket';
+import { Subscribe } from '../utils/subscribe';
+/**
+ * 带看控制器事件映射
+ */
+export type LiveControllerEventMap = {
+    /**
+     * 带看状态变更
+     * @param state
+     * @param prevState
+     * @returns
+     */
+    stateChange: (state: LiveState, prevState: LiveState) => void;
+    /**
+     * 接收到带看消息
+     * @param message
+     * @returns
+     */
+    message: (message: LiveMsg) => void;
+    /**
+     * 带看重连中
+     * @param detail
+     * @returns
+     */
+    reconnecting: (detail: RobustWebSocketEventDetail) => void;
+    /**
+     * 带看重连成功
+     * @param detail
+     * @returns
+     */
+    reconnected: (detail: RobustWebSocketEventDetail) => void;
+};
+/**
+ * 带看控制器
+ */
+export declare class LiveController extends Subscribe<LiveControllerEventMap> {
+    /**
+     * ws代理器
+     */
+    private _ws;
+    /**
+     * 带看连接状态
+     */
+    private _state;
+    set state(state: LiveState);
+    get state(): LiveState;
+    constructor();
+    /**
+     * 添加事件监听
+     */
+    private _addWebSocketEventListeners;
+    /**
+     * 移除事件监听
+     */
+    private _removeWebSocketEventListeners;
+    /**
+     * 处理房间关闭事件
+     * @param event
+     */
+    private _handleCloseEvent;
+    /**
+     * 处理房间正在关闭事件（这个时候可能是断网了）
+     */
+    private _handleClosingEvent;
+    /**
+     * 连接中
+     * @param event
+     */
+    private _handleConnectingEvent;
+    /**
+     * 连接发送异常
+     * @param event
+     */
+    private _handleErrorEvent;
+    /**
+     * 接收到消息
+     * @param event
+     */
+    private _handleMessageEvent;
+    /**
+     * 连接建立成功
+     * @param event
+     */
+    private _handleOpenEvent;
+    /**
+     * 处理超时
+     * @param event
+     */
+    private _handleTimeoutEvent;
+    /**
+     * 释放资源，释放之后需要重新实例化
+     * @returns
+     */
+    dispose: () => Promise<boolean>;
+    /**
+     * 开启房间链接
+     * @param url  房间链接
+     * @returns
+     */
+    open: (url: string) => void;
+    /**
+     * 关闭房间
+     * @param code
+     * @param reason
+     */
+    close: (code?: string | number | undefined, reason?: string | undefined) => Promise<boolean>;
+    /**
+     * 发送数据
+     * @param data
+     */
+    sendMessage: (data?: any) => void | undefined;
+    /**
+     * 准备关闭带看
+     */
+    readyClose: () => void;
+}

package/dist/live/createLive.d.ts

@@ -0,0 +1,8 @@
+import { LiveOptions } from '../typings/live/LiveOptions';
+import { Live } from './live';
+/**
+ * 创建`Live`实例
+ * @param opts
+ * @returns
+ */
+export declare const createLive: <KeyframesSnapshot extends Record<string, any>>(opts: LiveOptions) => Live<KeyframesSnapshot>;

package/dist/live/createLiveReact.d.ts

@@ -0,0 +1,54 @@
+import { default as React } from 'react';
+import { BuiltinActionType, BuiltinEventType, KeyframeEventType, LiveConnectOptions, LiveEventType, LiveOptions, MicroStatus, RTCEventType, RTCType, UserInfo } from '../typings';
+import { LiveState } from '../typings/live/LiveState';
+import { Live } from './live';
+export type LiveProviderPropTypes<KeyframesSnapshot extends Record<string, any>> = {
+    children?: React.ReactNode;
+    live?: Live<KeyframesSnapshot>;
+};
+/**
+ * 创建 LiveReact 实例，并提供 `React` 技术栈相关工具链。
+ * @param options 带看配置
+ * @returns 返回当前的带看上下文实例
+ */
+export declare function createLiveReact<KeyframesSnapshot extends Record<string, any>>(options: LiveOptions): {
+    live: Live<KeyframesSnapshot>;
+    jsBridge: import('@realsee/jsbridge-x').JSBridgeProtocol;
+    LiveProvider: (props: LiveProviderPropTypes<KeyframesSnapshot>) => React.FunctionComponentElement<React.ProviderProps<Live<KeyframesSnapshot> | null>>;
+    unsafe__useLiveInstance: () => Live<KeyframesSnapshot>;
+    unsafe__useRTCInstance: () => import('../typings').RTCProtocol;
+    useConnect: () => (options: LiveConnectOptions) => Promise<true | Error>;
+    useKeyframe: <K extends keyof KeyframesSnapshot>(key: K) => (KeyframesSnapshot[K] | ((frame: KeyframesSnapshot[K]) => boolean | Error) | undefined)[];
+    useKeyframeUpdateCallback: <KeyOfKeyframe extends keyof KeyframeEventType<KeyframesSnapshot>>(key: KeyOfKeyframe, callback: (...args: Parameters<KeyframeEventType<KeyframesSnapshot>[KeyOfKeyframe]>) => ReturnType<KeyframeEventType<KeyframesSnapshot>[KeyOfKeyframe]>, deps?: React.DependencyList) => () => void;
+    useLiveAction: () => {
+        connect: (options: LiveConnectOptions) => Promise<void>;
+        broadcast: (data: Record<string, any>, toUserIds: string | string[], timeout?: number) => Promise<void>;
+        exit: () => Promise<void>;
+        kick: (toUserIds: string | string[]) => Promise<void>;
+        toggleMicro: (microStatus: boolean) => void;
+        forbidMicro: (micro: MicroStatus, toUserIds?: string | string[]) => Promise<void>;
+        forbidSync: (sync: boolean, toUserIds?: string | string[]) => void;
+        sendKeyframe: (key: keyof KeyframesSnapshot, frame: KeyframesSnapshot[keyof KeyframesSnapshot]) => void;
+        getFramesByKey: (key: keyof KeyframesSnapshot) => Partial<KeyframesSnapshot>[keyof KeyframesSnapshot] | undefined;
+        setSelfInfo: (userInfo: Partial<UserInfo>) => void;
+        updateStatus: (evtType: BuiltinEventType, atnType: BuiltinActionType, status: Record<string, any>, toUserIds?: string | string[]) => void;
+    };
+    useLiveEventCallback: <K extends keyof LiveEventType<KeyframesSnapshot>>(name: K, callback: (...args: Parameters<LiveEventType<KeyframesSnapshot>[K]>) => ReturnType<LiveEventType<KeyframesSnapshot>[K]>, deps?: React.DependencyList) => () => void;
+    useLiveState: () => LiveState;
+    useRTCAction: () => {
+        join: (options: {
+            voiceId: string;
+            userId: string;
+            roomId: string;
+            type: RTCType;
+        }) => Promise<boolean>;
+        quit: () => Promise<boolean>;
+        shock: () => void | undefined;
+        toggleMicro: (flag?: boolean | undefined) => Promise<boolean>;
+        detectMicro: () => Promise<boolean>;
+    };
+    useRTCEventCallback: <K extends keyof RTCEventType>(name: K, callback: (...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>, deps?: React.DependencyList) => () => void;
+    useSelfInfo: () => (Partial<UserInfo> | ((userInfo: Partial<UserInfo>) => Promise<boolean>))[];
+    useKeyframesSnapshot: () => Partial<KeyframesSnapshot>;
+    useUserList: () => UserInfo[];
+};

package/dist/live/live.d.ts

@@ -0,0 +1,200 @@
+import { JSBridgeProtocol } from '@realsee/jsbridge-x';
+import { RTCProtocol } from '../rtc';
+import { EventType, KeyframeEventType, LiveOptions, RoomInfo, RTCType, UserInfo, BuiltinEventType, BuiltinActionType, MicroStatus, LiveConnectOptions } from '../typings';
+import { LiveState } from '../typings/live/LiveState';
+import { Subscribe } from '../utils/subscribe';
+import * as Y from 'yjs';
+export type LiveBuiltInData<KeyframesSnapshot> = {
+    selfInfo?: UserInfo;
+    userList?: UserInfo[];
+    roomInfo?: RoomInfo;
+    rtcInfo?: {
+        voiceId: string;
+        type: RTCType;
+    };
+    keyframes: Y.Map<KeyframesSnapshot>;
+};
+export declare const _clearLiveInstanceIfNeed: () => void;
+export declare class Live<KeyframesSnapshot extends Record<string, any>> extends Subscribe<EventType<KeyframesSnapshot>> {
+    /**
+     * 带看的配置选项
+     */
+    private _options;
+    get options(): LiveOptions;
+    /**
+     * 带看状态
+     */
+    get state(): LiveState;
+    /**
+     * 兼容老逻辑
+     * @deprecated 请直接读取 state 属性字段，未来将移除该属性
+     */
+    get readyState(): LiveState;
+    /**
+     * 获取当前WebSocket连接的URL。(注意：这个是WebSocket连接的完整连接，附带一些query参数)。
+     * @deprecated 带看不需要关注底层ws的相关信息，未来将移除
+     */
+    get url(): string | undefined;
+    /**
+     * 获取当前live使用的RTC实例
+     */
+    get $RTC(): RTCProtocol;
+    /**
+     * 获取当前live使用的jsBridge实例
+     */
+    get jsBridge(): JSBridgeProtocol;
+    /**
+     * 帧数据监听
+     */
+    keyframes: Subscribe<KeyframeEventType<KeyframesSnapshot>>;
+    /**
+     * 带看的 yDoc
+     */
+    private _yDoc;
+    /**
+     * 内置的一些数据
+     */
+    private _buildInData;
+    constructor(opts: LiveOptions);
+    /**
+     * 当前帧数据快照
+     */
+    get snapshot(): Partial<KeyframesSnapshot>;
+    _initializeKeyframesObservers: () => void;
+    _handleKeyframesChange: (event: Y.YMapEvent<KeyframesSnapshot>) => void;
+    /**
+     * 根据键值取帧数据
+     * @param key 帧数据的键值
+     * @returns
+     */
+    getFramesByKey: <Key extends keyof KeyframesSnapshot>(key: Key) => Partial<KeyframesSnapshot>[Key] | undefined;
+    /**
+     * 发送帧数据（需要能够被序列化）
+     * @param key 帧数据键值
+     * @param frame 帧数据本体
+     * @returns 发送结果，成功返回true，失败返回false或Error
+     */
+    sendKeyframe: <Key extends keyof KeyframesSnapshot>(key: Key, frame: KeyframesSnapshot[Key]) => boolean | Error;
+    /**
+     * 当前用户信息
+     */
+    get selfInfo(): UserInfo | undefined;
+    /**
+     * 当前用户列表
+     */
+    get userList(): UserInfo[];
+    /**
+     * 当前带看房间信息
+     */
+    get roomInfo(): RoomInfo | undefined;
+    /**
+     * 带看控制器
+     */
+    private _controller;
+    private _initializeOptions;
+    private _initializeJsBridge;
+    private _initializeRTC;
+    private _createBuiltInRTC;
+    private _createVRWebViewRTC;
+    private _createBrowserRTC;
+    private _createDefaultRTC;
+    private _autoConnect;
+    private _debugSetup;
+    /**
+     * 添加带看控制的事件监听
+     */
+    private _addLiveControllerEventListeners;
+    /**
+     * 移除带看控制的事件监听
+     */
+    private _removeLiveControllerEventListeners;
+    /**
+     * 带看状态变化处理
+     * @param state 当前状态
+     * @param prevState 之前的状态
+     */
+    private _handleStateChange;
+    /**
+     * 消息接收
+     * @param liveMsg
+     */
+    private _handleMessage;
+    /**
+     * 清理带看缓存的数据
+     */
+    private _clearLiveData;
+    /**
+     * 连接带看
+     * @param options 连接选项
+     * @returns 连接结果，成功返回true，失败返回Error
+     */
+    connect: (options?: LiveConnectOptions) => Promise<true | Error>;
+    /**
+     * 退出带看
+     * @returns
+     */
+    _exit: () => Promise<boolean>;
+    /**
+     * 退出带看
+     * @returns
+     */
+    exit: () => Promise<void>;
+    /**
+     * 关闭带看房间
+     * @returns 关闭结果
+     */
+    close: () => Promise<void>;
+    /**
+     * 销毁带看
+     * @returns
+     */
+    dispose: () => Promise<boolean>;
+    /**
+     * 修改状态
+     * @param evtType
+     * @param atnType
+     * @param status
+     * @param toUserIds
+     * @returns
+     */
+    updateStatus(evtType: BuiltinEventType, atnType: BuiltinActionType, status: Record<string, any>, toUserIds?: string | string[]): Promise<boolean>;
+    /**
+     * 设置自己的用户信息
+     * @param userInfo
+     * @returns
+     */
+    setSelfInfo: (userInfo: Partial<UserInfo>) => Promise<boolean>;
+    /**
+     * 自定义广播
+     * @param request 广播请求的数据
+     * @param toUserIds
+     * @param timeout
+     * @returns
+     */
+    broadcast: <Request extends Record<string, any>, Response>(request: Request, toUserIds: string | string[], timeout: number) => Promise<Response> | Error | false;
+    toggleMicro: (microStatus: boolean) => Promise<boolean>;
+    /**
+     * 控制别人的麦
+     * @param microStatus
+     * @param toUserIds
+     * @returns
+     */
+    forbidMicro: (microStatus: MicroStatus, toUserIds: string | string[]) => Promise<boolean>;
+    /**
+     * 控制别人的同步全量帧数据权限
+     * @param sync
+     * @param toUserIds
+     * @returns
+     */
+    forbidSync: (sync: boolean, toUserIds: string | string[]) => Promise<boolean>;
+    /**
+     * 把用户踢出带看
+     * @param toUserIds
+     * @returns
+     */
+    kick: (toUserIds: string | string[]) => Promise<boolean>;
+    /**
+     * 获取当前某个 keyframe 的数据快照
+     */
+    getSnapshotForKey: <Key extends keyof KeyframesSnapshot>(key: Key) => any;
+}

package/dist/rtc/BrowserRTC.d.ts

@@ -0,0 +1,39 @@
+import { Client, LocalStream } from 'trtc-js-sdk';
+import { GetVoiceSign } from '../typings/live/GetVoiceSign';
+import { RTCType } from '../typings/rtc/type';
+import { CoreRTC } from './CoreRTC';
+export interface ITrtcInstance {
+    client: Client | null;
+    stream: LocalStream | null;
+}
+export declare class BrowserRTC extends CoreRTC {
+    type: RTCType;
+    joined: boolean;
+    micro: boolean;
+    voiceId: string;
+    private _getVoiceSign;
+    private _autoPlayConfirm;
+    checkRequirement: () => Promise<import('trtc-js-sdk').CheckResult>;
+    private $dom;
+    private _trtc;
+    constructor(options: {
+        getVoiceSign: GetVoiceSign;
+        autoPlayConfirm?: (opts: {
+            onConfirm: () => void;
+        }) => void;
+    });
+    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/dist/rtc/BrowserRTC4Chime.d.ts

@@ -0,0 +1,60 @@
+import { AudioMixObserver, 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;
+    audioMixObserver?: AudioMixObserver;
+    private _getVoiceSign;
+    private _autoPlayConfirm;
+    private $dom;
+    private $audio;
+    constructor(options: {
+        getVoiceSign: GetVoiceSign;
+        autoPlayConfirm?: (opts: {
+            onConfirm: () => void;
+        }) => void;
+        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/dist/rtc/VRWebViewRTC.d.ts

@@ -0,0 +1,97 @@
+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 _joinOptions;
+    private options;
+    get jsBridge(): import('@realsee/jsbridge-x').JSBridgeProtocol;
+    constructor({ jsBridge, getVoiceSign }: VRWebViewRTCOptions);
+    /**
+     * 处理用户音量
+     * @param userVolumes
+     */
+    private handleUserVolumes;
+    /**
+     * 处理弱网络情况
+     * @param weakNetwork
+     */
+    private handleWeakNetwork;
+    /**
+     * 加入语音房间
+     * @param options
+     * @returns
+     */
+    join: (options: {
+        voiceId: string;
+        userId: string;
+        roomId: string;
+        type: RTCType;
+    }) => Promise<boolean>;
+    /**
+     * 重连
+     * @returns
+     */
+    reJoin: () => Promise<boolean>;
+    /**
+     * 获取 rtc 签名
+     * @param params
+     * @returns
+     */
+    private getVoiceSignOrEmitError;
+    /**
+     * 处理小程序的加入房间
+     * @param options
+     * @returns
+     */
+    private handleWxMiniProgramWebViewJoin;
+    /**
+     * 处理App WebView的加入房间
+     * @param options
+     * @returns
+     */
+    private handleAppWebViewJoin;
+    /**
+     * 加入语音房间，给小程序使用
+     * @param param0
+     * @returns
+     */
+    private joinRoomOrEmitError;
+    /**
+     * 处理加入语音房间结果
+     * @param res
+     * @returns
+     */
+    private handleJoinResult;
+    /**
+     * 将错误信息发送出去，并将 joined 置为 false
+     * @param message
+     */
+    private emitErrorAndSetJoinedFalse;
+    /**
+     * 退出房间
+     * @returns
+     */
+    quit: () => Promise<boolean>;
+    /**
+     * 监测麦克风权限
+     * @returns
+     */
+    detectMicro: () => Promise<boolean>;
+    /**
+     * 修改麦克风状态
+     * @param flag
+     * @returns
+     */
+    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/dist/typings/chime/AttendeeResponse.d.ts

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

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

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

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

@@ -0,0 +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;
+}

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

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

package/dist/typings/index.d.ts

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