/* * RCCallEngine - v5.1.3 * CommitId - abeb3b841d3b3fb70d415d7e3a88d20832c08f18 * Fri Apr 21 2023 12:00:33 GMT+0800 (China Standard Time) * ©2020 RongCloud, Inc. All rights reserved. */ import { ConversationType, IReceivedMessage, EventEmitter, RTCPluginContext, IRuntime, ILogger, BasicLogger } from '@rongcloud/engine'; /** * 错误码，与移动端对齐 * @description * 1. `51000 - 51999` 为 Android 专用段 * 2. `52000 - 52999` 为 iOS 专用段 * 3. `53000 - 53199` 为 Web RTC 专用段 * 4. `53200 - 53499` 为 Web CallLib 专用段 * * `53200 - 53299` 为 Web CallEngine 专用端 * * `53300 - 53499` 为 Web Call 专用端 * 5. `53500 - 53999` 为 Web 保留段 */ declare enum RCCallErrorCode { /** * 成功 */ SUCCESS = 10000, /** * 存在未结束的状态机 */ STATE_MACHINE_EXIT = 53200, /** * 发送 IM 消息失败 */ SEND_MSG_ERROR = 53201, /** * 被对方加入黑名单 */ REJECTED_BY_BLACKLIST = 53202, /** * 当前用户不再群组中 */ NOT_IN_GROUP = 53203, /** * Call 相关 */ /** * 获得本地音频流失败 */ GET_LOCAL_AUDIO_TRACK_ERROR = 53301, /** * 获得本地视频流失败 */ GET_LOCAL_VIDEO_TRACK_ERROR = 53302, /** * 获得本地音视频流失败 */ GET_LOCAL_AUDIO_AND_VIDEO_TRACK_ERROR = 53303, /** * 加入房间失败 */ JOIN_ROOM_ERROR = 53304, /** * 发布音频失败 */ AUDIO_PUBLISH_ERROR = 53305, /** * 发布视频失败 */ VIDEO_PUBLISH_ERROR = 53306, /** * 发布音视频失败 */ AUDIO_AND_VIDEO_PUBLISH_ERROR = 53307, /** * 查询房间用户信息失败 */ QUERY_JOINED_USER_INFO_ERROR = 53308, /** * 禁用启用视频时，房间内缺少视频流 */ MISSING_VIDEO_TRACK_ERROR = 53309, /** * 取消发布视频失败 */ UNPUBLISH_VIDEO_ERROR = 53310, /** * 会话不是群组 */ CONVERSATION_NOT_GROUP_ERROR = 53311, /** * 不在room中禁用音视频 */ NOT_IN_ROOM_ERROR = 53312 } /** * 挂断原因 * @description * 根据原有 HangupReason 设计，己方原因与对方原因有相差 10 的差距. * 现有本地原因取值范围: 1 ~ 10, 远端原因取值范围: 11 ~ 20. * 为便于 HangupReason 扩展，保留 100 以内的取值. * 需要再次扩展时，己方原因使用: 21 ~ 30, 对应对方原因使用: 31 ~ 40, * 以此类推， * 己方原因使用: 41 ~ 50, 对方原因使用: 51 ~ 60, * 己方原因使用: 61 ~ 70, 对方原因使用: 71 ~ 80, * 己方原因使用: 71 ~ 90, 对方原因使用: 91 ~ 100. * * 各平台独有字段范围 * Android 201 ~ 299 * iOS 301 ~ 399 * Web 401 ~ 499 * 详细文档：https://gitbook.rongcloud.net/rtc-docs/#/rtc-client/ios/analysis/calllib/HangupReason */ declare enum RCCallEndReason { /** * 己方取消已发出的通话请求 */ CANCEL = 1, /** * 己方拒绝收到的通话请求 */ REJECT = 2, /** * 己方挂断 */ HANGUP = 3, /** * 己方忙碌 */ BUSY_LINE = 4, /** * 己方未接听 */ NO_RESPONSE = 5, /** * 己方不支持当前音视频引擎 */ ENGINE_UNSUPPORTED = 6, /** * 己方网络错误 */ NETWORK_ERROR = 7, /** * 己方摄像头资源获取失败，可能是权限原因 */ GET_MEDIA_RESOURCES_ERROR = 8, /** * 己方资源发布失败 */ PUBLISH_ERROR = 9, /** * 己方订阅资源失败 */ SUBSCRIBE_ERROR = 10, /** * 对方取消发出的通话请求 */ REMOTE_CANCEL = 11, /** * 对方拒绝收到的通话请求 */ REMOTE_REJECT = 12, /** * 通话过程中对方挂断 */ REMOTE_HANGUP = 13, /** * 对方忙碌 */ REMOTE_BUSY_LINE = 14, /** * 对方未接听 */ REMOTE_NO_RESPONSE = 15, /** * 对方引擎不支持 */ REMOTE_ENGINE_UNSUPPORTED = 16, /** * 对方网络错误 */ REMOTE_NETWORK_ERROR = 17, /** * 对方摄像头资源获取失败，可能是权限原因 */ REMOTE_GET_MEDIA_RESOURCE_ERROR = 18, /** * 远端资源发布失败 */ REMOTE_PUBLISH_ERROR = 19, /** * 远端订阅资源失败 */ REMOTE_SUBSCRIBE_ERROR = 20, /** * 己方其他端已加入新通话 */ OTHER_CLIENT_JOINED_CALL = 21, /** * 己方其他端已在通话中 */ OTHER_CLIENT_IN_CALL = 22, /** * 己方被禁止通话 */ KICKED_BY_SERVER = 23, /** * 己方接听系统通话（移动端特有） */ ACCEPT_SYSTEM_CALL = 24, /** * 远端其他端已加入新通话 */ REMOTE_OTHER_CLIENT_JOINED_CALL = 31, /** * 远端其他端已在通话中 */ REMOTE_OTHER_CLIENT_IN_CALL = 32, /** * 远端被禁止通话 */ REMOTE_KICKED_BY_SERVER = 33, /** * 远端接听系统通话（移动端特有） */ REMOTE_ACCEPT_SYSTEM_CALL = 34, /** * 其他端接听 */ ACCEPT_BY_OTHER_CLIENT = 101, /** * 其他端挂断 */ HANGUP_BY_OTHER_CLIENT = 102, /** * 己方被对方加入黑名单 */ ADDED_TO_BLACKLIST = 103, /** * 音视频服务未开通 */ SERVICE_NOT_OPENED = 104 } /** * 通话媒体类型 */ declare enum RCCallMediaType { /** * 音频通话 */ AUDIO = 1, /** * 视频通话 */ AUDIO_VIDEO = 2 } declare enum RCCallSessionState { /** * 等待建立连接 */ WAITING = 0, /** * 会话维持中 */ KEEPING = 1, /** * 会话已结束 */ END = 2 } declare enum RCCallUserState { /** * 用户不存在于通话中 */ NONE = 0, /** * 等待接听 */ WAITING = 1, /** * 通话中 */ KEEPING = 2 } interface IEndSummary { /** * 通话类型 */ conversationType: ConversationType; /** * 多组织 ID */ channelId: string; /** * 目标 ID */ targetId: string; /** * 通话媒体类型 */ mediaType: RCCallMediaType; /** * 通话开始时间戳 */ beginTimestamp: number; /** * 通话结束时间戳 */ endTimestamp: number; /** * 通话时间 */ duration: number; /** * 通话结束原因 */ endReason: RCCallEndReason; } interface IUserProfile { /** * 用户名 */ name?: string; /** * 用户头像地址 */ portraitUri?: string; /** * user info 中附加信息 */ extra?: string; } /** * 通话发起者信息 */ interface ISenderInfo extends IUserProfile { /** * 发起者 userId */ userId: string; } interface IUserData extends IUserProfile { /** * 用户 ID */ userId: string; /** * 用户 状态 */ state: RCCallUserState; /** * 是否是通话发起者 */ isCaller: boolean; /** * 是否是远端用户 */ isRemote: boolean; /** * 用户 deviceId * 主要用于记录远端的用户的 deviceId, 用于处理多端消息 */ deviceId?: string; } interface IUserStateChangeInfo { /** * 用户数据 */ user: IUserData; /** * 挂断原因（ user.state 为 RCCallUserState.NONE 时返回） */ reason?: RCCallEndReason; } interface IStateChangeInfo { /** * 状态 */ state: RCCallSessionState; /** * state 为 RCCallSessionState.END 时返回 */ reason?: RCCallEndReason; } type IInvitedUsers = ISenderInfo; interface IMemberModifyInfo { /** * 发起者信息 */ sender: ISenderInfo; /** * 被邀请用户 ID 列表 */ invitedUsers: IInvitedUsers[]; } interface IMediaModifyInfo { /** * 发起者信息 */ sender: ISenderInfo; /** * 修改后的媒体类型 */ mediaType: RCCallMediaType; } interface ICallStateMachineWatchers { /** * 用户状态变更 * @param info */ onUserStateChange: (info: IUserStateChangeInfo) => void; /** * 房间状态变更 * @param info */ onStateChange: (info: IStateChangeInfo) => void; /** * 收到响铃 * @param sender 发起用户信息 */ onRinging: (sender: ISenderInfo) => void; /** * 收到接听 * @param sender 发起用户信息 */ onAccept: (sender: ISenderInfo) => void; /** * 收到挂断 */ onHungup: (sender: ISenderInfo, reason: RCCallEndReason) => void; /** * 收到人员变更 * @param sender 发起用户信息 */ onMemberModify: (info: IMemberModifyInfo) => void; /** * 收到通话类型变更 * @param sender 发起用户信息 */ onMediaModify: (info: IMediaModifyInfo) => void; /** * 是否跨appkey * @param ifCross 是否为跨appkey通信 */ crossAppkey: (ifCross: boolean) => void; } /** * 发送邀请时的可选项 */ interface IInviteOptions { /** * 消息的扩展信息 */ extra?: string; /** * 对方显示通知的标题 */ pushTitle?: string; /** * 对方显示的通知内容 */ pushContent?: string; } /** * 注释 * TODO */ declare enum MsgCallStatus { OUTGOING = 1, INCOMING = 2, RINGING = 3, CONNECTED = 4, IDLE = 5, ACCEPTED = 6 } interface IOfflineRecord { channelId: string; conversationType: ConversationType; targetId: string; mediaType: RCCallMediaType; callId: string; inviterId: string; endReason: RCCallEndReason; beginTimestamp: number; endTimestamp: number; duration: number; } interface ISendBaseOptions { /** * 组织 ID */ channelId: string; /** * 会话类型 */ conversationType: ConversationType; /** * 目标 ID (单聊：对方 Id;群聊： 群组 Id) */ targetId: string; } interface IExistedUserPofiles { /** * 用户 ID */ userId: string; /** * 通话类型 */ mediaType: RCCallMediaType; /** * 与移动端一致的通话状态 */ callStatus: MsgCallStatus; /** * PC 端 mediaId 直接传 userId, mediaId iOS 需要解出来渲染视图用。 */ mediaId?: string; } interface IMsgListener { onInvite?: (msg: IReceivedMessage) => void; onRinging?: (msg: IReceivedMessage) => void; onAccept?: (msg: IReceivedMessage) => void; onMemberModify?: (msg: IReceivedMessage) => void; onMediaModify?: (msg: IReceivedMessage) => void; onHungup?: (msg: IReceivedMessage) => void; sendAccept?: (info: { callId: string; }) => void; onOfflineRecord?: (record: IOfflineRecord) => void; } interface IInviteMsgOptions extends ISendBaseOptions { /** * 呼叫 ID（ RTC 房间 ID ） */ callId: string; /** * 通话媒体类型 */ mediaType: RCCallMediaType; /** * 被邀请人用户 ID 列表 */ inviteUserIds: string[]; /** * 扩展信息 */ extra: string; /** * 对方显示通知的标题 */ pushTitle?: string; /** * 对方显示的通知内容 */ pushContent?: string; /** * 跨appkey参数 */ roomType?: number; } interface IMemberModifyMsgOptions extends ISendBaseOptions { /** * 呼叫 ID（ RTC 房间 ID ） */ callId: string; /** * 通话媒体类型 */ mediaType: RCCallMediaType; /** * 被邀请人用户 ID 列表 */ inviteUserIds: string[]; /** * 获取会话发起者 Id */ callerId: string; /** * 当前通话中的所有人，包含未接听用户 */ existedUserPofiles: IExistedUserPofiles[]; /** * 当前通话中的所有人，包含未接听用户 */ directionalUserIdList: string[]; /** * 扩展信息 */ extra: string; /** * 对方显示通知的标题 */ pushTitle?: string; /** * 对方显示的通知内容 */ pushContent?: string; } interface IRingingMsgOptions extends ISendBaseOptions { /** * 呼叫 ID（ RTC 房间 ID ） */ callId: string; /** * 群呼中需要接收响铃的用户 ID 列表 */ userIds?: string[]; } interface IAcceptMsgOptions extends ISendBaseOptions { /** * 呼叫 ID（ RTC 房间 ID ） */ callId: string; /** * 通话媒体类型 */ mediaType: RCCallMediaType; /** * 群呼中需要接收接听消息的用户 ID 列表 */ userIds: string[]; } interface IHungupMsgOptions extends ISendBaseOptions { /** * 呼叫 ID（ RTC 房间 ID ） */ callId: string; /** * 挂断原因 */ reason: RCCallEndReason; /** * 群呼中需要接收挂断消息的用户 ID 列表 */ userIds: string[]; /** * 对方显示通知的标题 */ pushTitle?: string; /** * 对方显示的通知内容 */ pushContent?: string; } interface IMediaModifyMsgOptions extends ISendBaseOptions { /** * 呼叫 ID（ RTC 房间 ID ） */ callId: string; /** * 通话媒体类型 */ mediaType: RCCallMediaType; /** * 群呼中需要媒体变更消息的用户 ID 列表 */ userIds: string[]; } type MsgListenerKeys = keyof IMsgListener; /** * 消息接收处理: 在线消息、离线消息 * 发送消息处理: 发送不同类型消息封装 */ declare class CallMessageHandler extends EventEmitter { private readonly _context; private readonly _runtime; private readonly _logger; /** * 离线消息处理时间间隔 */ private readonly _offlineMsgItv; private readonly _getStateMachine; private _watchers; private _userInfo; private _msgBufferList; private _hadHandleMsgTimer; private _offlineRecorder; private _deviceId; constructor(_context: RTCPluginContext, _runtime: IRuntime, _logger: ILogger, /** * 离线消息处理时间间隔 */ _offlineMsgItv: number, _getStateMachine: (callId: string) => RCCallStateMachine | null); private _onMessage; /** * 在线消息抛给状态机处理 */ private _onRecvOnlineCallMsg; /** * 消息 buffer 列表处理逻辑 * 1、每 20ms 检查一次 buffer list * 2、取出已经延迟 200 的消息列表进行消费 | 无延迟 200ms 内消息直接递归 * 3、消费分为 离线消息消费逻辑、在线消息消费逻辑，消费后递归 */ private _handleBufferMsgs; registerEventListener(listener: IMsgListener): void; registerStateMachineEvent(callId: string, funcName: MsgListenerKeys, event: (...args: any[]) => void): void; unregisterStateMachineEvent(callId: string): void; registerUserInfo(userInfo: IUserProfile): void; /** * 发送 IM 消息 */ private _sendCallMessage; /** * 发送邀请消息 */ sendInvite(options: IInviteMsgOptions): Promise<{ code: RCCallErrorCode; message?: IReceivedMessage | undefined; }>; /** * 发送人员变更消息 */ sendMemeberModify(options: IMemberModifyMsgOptions): Promise<{ code: RCCallErrorCode; message?: IReceivedMessage | undefined; }>; /** * 发送响铃消息 */ sendRinging(options: IRingingMsgOptions): Promise<{ code: RCCallErrorCode; message?: IReceivedMessage | undefined; }>; /** * 发送同意接听消息 */ sendAccept(options: IAcceptMsgOptions): Promise<{ code: RCCallErrorCode; message?: IReceivedMessage | undefined; }>; /** * 发送挂断消息 */ sendHungup(options: IHungupMsgOptions): Promise<{ code: RCCallErrorCode; message?: IReceivedMessage | undefined; }>; /** * 发送媒体变更消息 */ sendMediaModify(options: IMediaModifyMsgOptions): Promise<{ code: RCCallErrorCode; message?: IReceivedMessage | undefined; }>; } declare class RCCallStateMachine { private readonly _context; private readonly _runtime; private readonly _logger; private readonly _callMsgHandler; private readonly _channelId; private readonly _conversationType; private readonly _targetId; private _mediaType; private readonly _callId; /** * 房间状态 */ private _sessionState; /** * 用户状态及信息 */ private _userInfo; /** * 用户计时器映射 */ private _userTimers; /** * 监听器 */ private _watchers; /** * 呼叫超时时间 (单位：毫秒) */ private _callTimeout; /** * 通话建立开始时间 */ private _beginTimestamp; /** * 通话结束时间 */ private _endTimestamp; /** * 通话结束原因 */ private _endReason; /** * 主叫 ID * 发起邀请为当前用户 ID * 收到邀请为 senderUserId * 收到人员变更邀请为消息体中 callerId */ private _callerId; /** * 当次通话邀请者 ID * 发起邀请为当前用户 ID、收到邀请为 senderUserId、收到人员变更邀请为消息体中 senderUserId */ private _inviterId; /** * 是否是跨 appkey */ private _isCrossAppkey; private _hungupPushTitle; private _hungupPushContent; constructor(_context: RTCPluginContext, _runtime: IRuntime, _logger: ILogger, _callMsgHandler: CallMessageHandler, _channelId: string, _conversationType: ConversationType, _targetId: string, _mediaType: RCCallMediaType, _callId: string); /** * 获取校正后超时时间 */ private _getTimeout; private _clearTimerById; /** * 通知 call 层房间状态变更及原因 */ private _notifyStateChange; /** * 通知 call 层人员状态变更及原因 */ private _notifyUserStateChange; private _otherClientHandle; /** * 正在通话中，且不是当前已接通用户设备（deviceId）发来的消息 */ private _isRemoteInvalidMsg; private _onRinging; private _onAccept; private _onMediaModify; private _onHungup; /** * 注册事件监听 * @params watchers */ registerEventListener(watchers: ICallStateMachineWatchers): void; /** * 收到 invite 消息时状态机更新（CallEngine 内部调用） * @param message 接收消息 */ __onInvite(message: IReceivedMessage): void; /** * 收到 memberModify 消息时状态机更新（CallEngine 内部调用） * @param message 接收消息 */ __onMemberModify(message: IReceivedMessage): void; /** * 处理已有 session ，不允许再接听新会话情况 */ __handleInviteInSession(): void; /** * 主动呼叫 (CallEngine 内部调用) * @param userIds 被邀请用户 ID 列表 * @param extra 消息的扩展信息 * @param pushTitle 通知的标题 * @param pushContent 通知的内容 */ __call(userIds: string[], extra?: string, pushTitle?: string, pushContent?: string, isCrossAppkey?: boolean): Promise<{ code: RCCallErrorCode; }>; /** * 接听 */ accept(): Promise<{ code: RCCallErrorCode; }>; /** * 群呼叫中继续邀请 * @param userIds 被邀请用户 ID 列表 */ invite(userIds: string[], options?: IInviteOptions): Promise<{ code: RCCallErrorCode; }>; private _hungupHandle; /** * 挂断 */ hungup(pushTitle?: string, pushContent?: string): Promise<{ code: RCCallErrorCode; }>; /** * 修改通话媒体类型 * @param mediaType RCCallMediaType.AUDIO 改为音频通话 | RCCallMediaType.AUDIO_VIDEO 改为音视频通话 */ changeMediaType(mediaType: RCCallMediaType): Promise<{ code: RCCallErrorCode; }>; /** * 用户加入通话补偿机制（rtc userJoin 事件触发） * 主叫呼叫后，未收到被叫 accept 消息，但收到了 userJoin 同样补偿更新用户、房间状态、呼叫计时器 */ userJoin(userIds: string[]): void; /** * 用户离开通话补偿机制（rtc userLeave、kickOff 事件触发） * 通话中远端用户挂断，挂断消息未到，但是监听到 rtc userLeave 同样补偿更新用户、房间状态 */ userLeave(userIds: string[]): void; /** * Call 层己方异常失败后调用的方法 * 触发时机：音视频服务异常、获取资源失败、加入 RTC 房间失败、发布|订阅失败 */ close(reason: RCCallEndReason): void; setHungupPushConfig(pushConfig?: string, pushContent?: string): void; /** * 通话唯一标识 */ getCallId(): string; /** * 多组织 ID */ getChannelId(): string; /** * 目标 ID，单呼对方人员 Id, 群呼群组 Id */ getTargetId(): string; /** * 获取会话类型 */ getConversationType(): ConversationType; /** * 获取远端成员 ID 列表 */ getRemoteUserIds(): string[]; /** * 获取远端成员信息列表 */ getRemoteUsers(): IUserData[]; /** * 获取房间状态 */ getState(): RCCallSessionState; /** * 获取人员状态 */ getUserState(userId: string): RCCallUserState; /** * 获取会话发起者 Id */ getCallerId(): string; /** * 获取当次会话邀请者 Id */ getInviterId(): string; /** * 获取当前通话媒体类型 */ getMediaType(): RCCallMediaType; /** * 通话挂断后可调用 */ getSummary(): IEndSummary; } declare enum RCCallLanguage { ZH = "zh", EN = "en" } interface ICallEngineWatchers { onInvite: (callStateMachine: RCCallStateMachine, extra?: string) => void; onOfflineRecord?: (record: IOfflineRecord) => void; } interface ICallEngineOptions { /** * 语言设置 (推送), 不传默认为中文 */ lang: RCCallLanguage; /** * 通话超时时间, 不传默认 60s */ callTimeout?: number; /** * 离线消息处理时间间隔, 不传默认 10s */ offlineMsgItv?: number; /** * 已存在 session 是否允许接听新的通话, 默认为 false */ isAllowAcceptNewCall?: boolean; } declare class RCCallEngine { /** * engine PlguinContext 实例 */ private readonly _context; /** * 运行时相关 */ private readonly _runtime; /** * engine 日志模块实例，由 CallLib 层初始化 */ private readonly _logger; /** * 监听方法 */ private readonly _watchers; /** * 其他配置项 */ private readonly _options; private _stateMachine; private _callMsgHandler; /** * 初始化 */ constructor( /** * engine PlguinContext 实例 */ _context: RTCPluginContext, /** * 运行时相关 */ _runtime: IRuntime, /** * engine 日志模块实例，由 CallLib 层初始化 */ _logger: BasicLogger, /** * 监听方法 */ _watchers: ICallEngineWatchers, /** * 其他配置项 */ _options: ICallEngineOptions); private _onInvite; /** * 允许接听新的通话时，接听完新的通话后，挂断其他通话 */ private _handleSendAccept; /** * 根据 callId 获取状态机 */ private _getStateMachine; /** * 注册用户信息, 发送 call 消息时用户信息携带 */ registerUserInfo(userInfo: IUserProfile): void; /** * 单呼 * @param channelId 组织 ID * @param targetId 对方 ID * @param mediaType 媒体类型 * @param extra 消息扩展信息 * @param pushTitle 通知的标题 * @param pushContent 通知的内容 */ call(channelId: string, targetId: string, mediaType: number, extra?: string, pushTitle?: string, pushContent?: string, isCrossAppkey?: boolean): Promise<{ code: RCCallErrorCode; stateMachine?: RCCallStateMachine; }>; /** * 群呼 * @param channelId 组织 ID * @param targetId 群组 ID * @param mediaType 媒体类型 * @param userIds 被邀请人员列表 * @param extra 消息扩展信息 * @param pushTitle 通知的标题 * @param pushContent 通知的内容 */ callInGroup(channelId: string, targetId: string, mediaType: number, userIds: string[], extra?: string, pushTitle?: string, pushContent?: string): Promise<{ code: RCCallErrorCode; stateMachine?: RCCallStateMachine; }>; /** * 销毁当前的状态机 */ destroy(): void; } export { ICallEngineWatchers, ICallStateMachineWatchers, IEndSummary, IInviteOptions, IInvitedUsers, IMediaModifyInfo, IMemberModifyInfo, IOfflineRecord, ISenderInfo, IStateChangeInfo, IUserData, IUserProfile, IUserStateChangeInfo, RCCallEndReason, RCCallEngine, RCCallErrorCode, RCCallLanguage, RCCallMediaType, RCCallSessionState, RCCallStateMachine, RCCallUserState };