@realsee/live 0.6.14 → 0.7.0

package/dist/live/createLiveReact.d.ts

@@ -1,52 +0,0 @@
-import React from 'react';
-import { BuiltinActionType, BuiltinEventType, KeyframeTypes, 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>;
-};
-/**
- * 创建 {@link LiveReact} 实例，并提供 `React` 技术栈相关工具链。
- */
-export declare function createLiveReact<KeyframesSnapshot extends Record<string, any>>(options: LiveOptions): {
-    live: Live<KeyframesSnapshot>;
-    jsBridge: import("@realsee/jsbridge-x").JSBridgeProtocol;
-    LiveProvider: (props: LiveProviderPropTypes<KeyframesSnapshot>) => JSX.Element;
-    unsafe__useLiveInstance: () => Live<KeyframesSnapshot>;
-    unsafe__useRTCInstance: () => import("../typings").RTCProtocol;
-    useConnect: () => (options: LiveConnectOptions) => Promise<boolean | Error>;
-    useKeyframe: <K extends keyof KeyframesSnapshot>(key: K) => [frame: KeyframesSnapshot[K] | undefined, setFrame: (frame: KeyframesSnapshot[K]) => boolean | Error];
-    useKeyframeUpdateCallback: <KeyOfKeyframe extends keyof KeyframeTypes<KeyframesSnapshot>>(key: KeyOfKeyframe, callback: (...args: Parameters<KeyframeTypes<KeyframesSnapshot>[KeyOfKeyframe]>) => ReturnType<KeyframeTypes<KeyframesSnapshot>[KeyOfKeyframe]>, deps?: React.DependencyList) => () => void;
-    useLiveAction: () => {
-        connect: (options: LiveConnectOptions) => Promise<boolean | Error>;
-        broadcast: (data: Record<string, any>, toUserIds: string | string[], timeout?: number) => Promise<unknown>;
-        exit: () => Promise<void>;
-        kick: (toUserIds: string | string[]) => Promise<boolean>;
-        toggleMicro: (microStatus: boolean) => Promise<boolean>;
-        forbidMicro: (micro: MicroStatus, toUserIds?: string | string[]) => Promise<boolean>;
-        forbidSync: (sync: boolean, toUserIds?: string | string[]) => Promise<boolean>;
-        sendKeyframe: (key: keyof KeyframesSnapshot, frame: KeyframesSnapshot[keyof KeyframesSnapshot]) => boolean | Error;
-        getFramesByKey: (key: keyof KeyframesSnapshot) => Partial<KeyframesSnapshot>[keyof KeyframesSnapshot] | undefined;
-        setSelfInfo: (userInfo: Partial<UserInfo>) => Promise<boolean>;
-        updateStatus: (evtType: BuiltinEventType, atnType: BuiltinActionType, status: Record<string, any>, toUserIds?: string | string[]) => Promise<boolean>;
-    };
-    useLiveEventCallback: <K_1 extends keyof LiveEventType<KeyframesSnapshot>>(name: K_1, callback: (...args: Parameters<LiveEventType<KeyframesSnapshot>[K_1]>) => ReturnType<LiveEventType<KeyframesSnapshot>[K_1]>, 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_2 extends keyof RTCEventType>(name: K_2, callback: (...args: Parameters<RTCEventType[K_2]>) => ReturnType<RTCEventType[K_2]>, deps?: React.DependencyList) => () => void;
-    useSelfInfo: () => [Partial<UserInfo>, (userInfo: Partial<UserInfo>) => Promise<boolean | Error>];
-    useKeyframesSnapshot: () => Partial<KeyframesSnapshot>;
-    useUserList: () => UserInfo[];
-};

package/dist/live/live.d.ts

@@ -1,182 +0,0 @@
-import { JSBridgeProtocol } from '@realsee/jsbridge-x';
-import { RTCProtocol } from '../rtc';
-import { EventType, KeyframeTypes, LiveOptions, RoomInfo, RTCType, UserInfo, BuiltinEventType, BuiltinActionType, MicroStatus, LiveConnectOptions } from '../typings';
-import { LiveState } from '../typings/live/LiveState';
-import { Subscribe } from '../utils/subscribe';
-export type LiveBuiltInData<KeyframesSnapshot> = {
-    selfInfo?: UserInfo;
-    userList?: UserInfo[];
-    roomInfo?: RoomInfo;
-    rtcInfo?: {
-        voiceId: string;
-        type: RTCType;
-    };
-    keyframes: Partial<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<KeyframeTypes<KeyframesSnapshot>>;
-    /**
-     * 内置的一些数据
-     */
-    private _buildInData;
-    /**
-     * 当前帧数据快照
-     */
-    get snapshot(): Partial<KeyframesSnapshot>;
-    /**
-     * 根据键值取帧数据
-     * @param key 帧数据的键值
-     * @returns
-     */
-    getFramesByKey: <Key extends keyof KeyframesSnapshot>(key: Key) => Partial<KeyframesSnapshot>[Key] | undefined;
-    /**
-     * 发送帧数据（需要能够被序列化）
-     * @param key 帧数据键值
-     * @param frame 帧数据本体
-     * @returns
-     */
-    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;
-    constructor(opts: LiveOptions);
-    /**
-     * 添加带看控制的事件监听
-     */
-    private _addLiveControllerEventListeners;
-    /**
-     * 移除带看控制的事件监听
-     */
-    private _removeLiveControllerEventListeners;
-    /**
-     * 带看状态变化
-     * @param state
-     * @returns
-     */
-    private _handleStateChange;
-    /**
-     * 消息接收
-     * @param liveMsg
-     */
-    private _handleMessage;
-    /**
-     * 清理带看缓存的数据
-     */
-    private _clearLiveData;
-    /**
-     * 连接带看
-     * @param options
-     * @returns
-     */
-    connect: (options?: LiveConnectOptions) => Promise<boolean | Error>;
-    /**
-     * 退出带看
-     * @returns
-     */
-    _exit: () => Promise<boolean>;
-    /**
-     * 退出带看
-     * @returns
-     */
-    exit: () => Promise<void>;
-    /**
-     * 关闭带看房间
-     * @param code
-     * @param reason
-     * @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>;
-}

package/dist/rtc/BrowserRTC.d.ts

@@ -1,39 +0,0 @@
-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

@@ -1,60 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

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

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

@@ -1,12 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

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

package/dist/typings/index.d.ts

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

package/dist/typings/live/EventType.d.ts

@@ -1,74 +0,0 @@
-import { BuiltinMsg, LiveMsg } from './LiveMsg';
-import { LiveState } from './LiveState';
-import { UserInfo } from './UserInfo';
-/**
- * 带看事件列表
- */
-export type LiveEventType<KeyframesSnapshot> = {
-    /**
-     * 带看状态变化
-     * @param state
-     * @param prevState
-     */
-    'stateChange'(state: LiveState, prevState?: LiveState): void;
-    /**
-     * 内置消息事件
-     * @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<KeyframesSnapshot>): void;
-    /**
-     * 获取其他用户输送的帧数据：根据此帧数据更新UI状态。
-     * @param keyframes
-     */
-    'keyframes'(keyframes: Partial<KeyframesSnapshot>, 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;
-};
-/**
- * 帧数据类型
- */
-export type KeyframeTypes<Type> = {
-    [Property in keyof Type as Property]: (nextKeyframes: Type[Property], prevKeyframes: Type[Property], frontRequestId: string) => void;
-};
-/**
- * 事件解析
- */
-export type EventType<KeyframesSnapshot> = LiveEventType<KeyframesSnapshot>;

package/dist/typings/live/GetVoiceSign.d.ts

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

package/dist/typings/live/LiveConnectOptions.d.ts

@@ -1,7 +0,0 @@
-import { MicroStatus } from "./LiveMsg";
-export type LiveConnectOptions = {
-    url?: string;
-    force?: boolean;
-    getTicket?: () => Promise<string>;
-    rtcMicStatus?: MicroStatus;
-};

package/dist/typings/live/LiveMsg.d.ts

@@ -1,119 +0,0 @@
-/**
- * WebSocket 通信指令
- * - 下行：服务端推送数据
- * - 上行：客户端上报数据
- */
-export declare enum Command {
-    SelfUserInfo = "SELF_USER_INFO",
-    RoomInfo = "ROOM_INFO",
-    RTCInfo = "RTC_INFO",
-    UserList = "USER_LIST",
-    BuiltinMsg = "BUILTIN_MSG",
-    CustomEvent = "CUSTOM_EVENT",
-    KeyframeSync = "KEYFRAME_SYNC",
-    UserKickOut = "USER_KICK_OUT"
-}
-/**
- * 向服务端请求数据时的数据格式。
- */
-export type ReqLiveMsg = {
-    /**
-     * 请求指令。
-     */
-    command: Command;
-    /**
-     * 前端请求时生成的uuid()。
-     */
-    front_request_id: string;
-    /**
-     * 数据内容
-     */
-    data: {
-        /**
-         * 如果此数据仅发送给某些用户，请提供这些用户的ucid。
-         */
-        to_user_ids?: string[];
-        [key: string]: any;
-    };
-};
-/**
- * 内置事件类型。
- */
-export declare enum BuiltinEventType {
-    /**
-     * 变更用户状态。
-     */
-    UserChange = "user_change",
-    /**
-     * 变更房间状态。
-     */
-    RoomChange = "room_change"
-}
-/**
- * 内置事件行为类型。
- */
-export declare enum BuiltinActionType {
-    /**
-     * 修改麦克风状态。
-     */
-    UserMicroStatus = "change_micro_status",
-    /**
-     * 同步当前用户状态：客户端麦克风状态已经修改成功，通知服务端
-     */
-    UserMicroStatusSync = "sync_micro_status",
-    /**
-     * 调整某些用户的权限。
-     */
-    UserPermission = "change_permission",
-    /**
-     * 用户状态发生改变。
-     */
-    UserStatus = "change_status",
-    /**
-     * 更新用户信息。
-     */
-    UserInfo = "change_info",
-    /**
-     * 关闭房间。
-     */
-    RoomClose = "close"
-}
-/**
- * 内置事件数据结构体。
- */
-export type BuiltinMsg = {
-    event_type: BuiltinEventType;
-    action: BuiltinActionType;
-    to_user_ids: string[];
-    data: {
-        extension?: Record<string, any>;
-        [key: string]: any;
-    };
-};
-/**
- * 麦克风状态。
- */
-export declare enum MicroStatus {
-    OPEN = "OPEN",
-    CLOSE = "CLOSE"
-}
-/**
- * 响应的信息结构体。
- */
-export type LiveMsg = {
-    code: string;
-    message: string;
-    command: Command;
-    roomCode: string;
-    appId: string;
-    requestId: string;
-    frontRequestId: string;
-    triggerUserId: string;
-    data: Record<string, any> | Record<string, any>[];
-};
-/**
- * 解析下后端数据格式。
- * @param jsonTxt - JSON序列化后的文本。
- * @returns false 标识解析失败；解析成功返回 {@link LiveMsg} 实例。
- */
-export declare function parseLiveMsg(jsonTxt: string): LiveMsg | boolean;