@rongcloud/plugin-wechat-rtc
Version:
@rongcloud/plugin-wechat-rtc
68 lines • 2.25 kB
TypeScript
import { EnableLogL, ILogger, IRuntime, LogLevel, RTCJoinType } from '@rongcloud/engine';
import { RCRTCCode } from './enums/RCRTCCode';
import RCRTCRoom from './room/RCRTCRoom';
import { IJoinRTCRoomResp } from './command/JoinRTCRoomCommand';
import { RTCContext } from './codec/RTCContext';
export interface IRCRTCInitOptions {
/**
* @deprecated
*/
logLevel?: LogLevel;
/**
* 输出日志等级,生产环境默认使用 WARN,开发环境默认为 DEBUG
* @description
* * 4 - DEBUG
* * 3 - INFO
* * 2 - WARN
* * 1 - ERROR
*/
logOutputLevel?: EnableLogL;
/**
* @deprecated
*/
logStdout?: (level: LogLevel, content: string) => void;
/**
* 与 MediaServer 的 http 请求超时时间,单位为毫秒,默认值为 `5000`,有效值 `5000-30000`。
* 优先级:用户配置 > 导航配置 > 默认时间。
*/
timeout?: number;
/**
* 房间 Ping 间隔时长,默认 `10000` ms,有效值 `3000`-`10000`
*/
pingGap?: number;
/**
* MediaServer 地址,私有云环境需指定
*/
mediaServer?: string;
}
export declare class RCRTCClient {
private readonly _context;
private readonly _logger;
private readonly _runtime;
private readonly _options;
private _crtRoom;
constructor(_context: RTCContext, _logger: ILogger, _runtime: IRuntime, _options: IRCRTCInitOptions);
private _onIMStatusChange;
private _onIMDisconnect;
private _onIMUninit;
private _handleMessage;
/**
* 加入 RTC 房间
* @param roomId 房间 Id
* @param _ 参数已废弃
* @param joinType 加入房间时的多端处理方式:
* - RTCJoinType.KICK:踢出其他端
* - RTCJoinType.REFUSE:拒绝当前端加入
* - RTCJoinType.COEXIST: 多端共存,但发布资源时,以最后发布端为准,资源会相互覆盖
*/
joinRTCRoom(roomId: string, _: any, joinType?: RTCJoinType): Promise<{
code: RCRTCCode;
data?: IJoinRTCRoomResp;
}>;
/**
* 离开房间
* @param room 加入房间返回的房间实例
*/
leaveRoom(room: RCRTCRoom): Promise<void>;
}
//# sourceMappingURL=RCRTCClient.d.ts.map