fcr-core/lib/room-control/helpers/constants.d.ts

Core APIs for building online scenes

/**
 * 房间控制相关的常量定义
 */
/**
 * 通用加入房间常量
 * room-control 和 room-router 共享的常量
 */
export declare const COMMON_JOIN_CONSTANTS: {
    /** 加入房间最大重试次数 */
    readonly MAX_JOIN_ATTEMPTS: 10;
};
/**
 * 房间控制常量
 */
export declare const ROOM_CONTROL_CONSTANTS: {
    /** 加入房间最大重试次数 */
    readonly MAX_JOIN_ATTEMPTS: 10;
    /** 加入状态 */
    readonly JOIN_STATE: {
        readonly CANCELED: 0;
        readonly JOINING: 1;
    };
    /** 错误消息 */
    readonly ERROR_MESSAGES: {
        readonly NOT_INITIALIZED: "The controller is not initialized, please add the room first";
        readonly JOIN_CONFLICT: "Failed to join the room, the room has been added";
        readonly JOIN_IN_PROGRESS: "Failed to join the room, the previous join operation has not been completed yet";
        readonly JOIN_CANCELED: "Joining operation has been cancelled";
    };
};
/**
 * 房间消息命令码
 */
export declare const ROOM_MESSAGE_COMMANDS: {
    /** 房间路由切换命令 */
    readonly ROOM_ROUTE_SWITCH: 1100;
    /** 云录制命令 */
    readonly CLOUD_RECORDING: 1;
    /** 房间状态更新命令 */
    readonly ROOM_STATE_UPDATE: 4;
    /** 房间属性更新命令 */
    readonly ROOM_PROPERTIES_UPDATE: 8;
    /** 直播状态更新命令 */
    readonly LIVE_STREAMING_UPDATE: 700;
    /** 用户被踢出命令 */
    readonly USER_KICK_OUT: 5;
    /** 房间会话请求命令 */
    readonly ROOM_SESSION_REQUEST: 1001;
    /** 房间会话接受命令 */
    readonly ROOM_SESSION_ACCEPT: 1002;
};
/**
 * 录制状态值
 */
export declare const RECORDING_STATE_VALUES: {
    /** 录制停止 */
    readonly STOPPED: 0;
    /** 录制中 */
    readonly RECORDING: 1;
};
/**
 * 直播状态值
 */
export declare const LIVE_STREAMING_STATE_VALUES: {
    /** 直播停止 */
    readonly STOPPED: 0;
    /** 直播开始 */
    readonly STARTED: 1;
    /** 直播停止（另一种状态） */
    readonly STOPPED_ALT: 2;
};
/**
 * 房间状态值
 */
export declare const ROOM_STATE_VALUES: {
    /** 房间结束 */
    readonly ENDED: 3;
};
/**
 * 响应状态码
 */
export declare const RESPONSE_CODES: {
    /** 成功 */
    readonly SUCCESS: 0;
};