import { EventEmitter, ConversationType, RTCPluginContext, BasicLogger, LogL, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine'; import { IMicphoneAudioProfile, RTCJoinType, ICameraVideoProfile, RCRTCCode, IRCRTCStateReport, RCRTCPingResult } from '@rongcloud/plugin-rtc'; import { RCCallPlusClient, RCCallPlusMediaType, RCCallPlusPacketLossStats, IRCCallPlusPushConfig } from '@rongcloud/plugin-call-plus'; declare enum RCCallUserState { /** * 用户不存在于通话中 */ NONE = 0, /** * 等待接听 */ WAITING = 1, /** * 通话中 */ KEEPING = 2 } /** * 错误码，与移动端对齐 * @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, /** * callPlus 中新增 */ /** * 参数错误 */ PARAM_ERROR = 53313, /** * 未加入通话 */ NOT_IN_CALL = 53314, /** * 媒体类型被禁止 */ MEDIATYPE_INVALID = 53315, /** * 当前不是视频通话 */ NOT_VIDEO_CALL = 53316, /** * 开通的音视频服务没有及时生效或音视频服务已关闭 */ RTC_SERVICE_UNAVAILABLE = 53317, /** * 调用函数时，传入的用户列表为空错误 */ USER_LIST_INVAILD = 53318, /** * 调用函数时，传入的通话 Id 为空错误 */ CALL_ID_INVALID = 53319, /** * 事务 Id 为空错误 */ TRANSACTION_ID_INVALID = 53320, /** * 调用函数时，传入的用户Id为空错误 */ USER_ID_INVALID = 53321, /** * 发起单人呼叫时，人员列表中只能有一个人 */ SINGLE_CALL_NOT_SUPPORT_MULTI_PERSON = 53322, /** * 麦克风未打开 */ MICROPHONE_CLOSED = 53323, /** * 无媒体资源 */ MEDIA_RESOURCE_INVALIED = 53324, /** * 未 install RTC 插件 */ NOT_INSTALL_RTC_PLUGIN = 53325, /** * 播放异常 */ PLAY_MEDIA_FAILED = 53326, /** * 播放视频需要 video 元素 */ VIDEO_VIEW_NOT_SET = 53327 } declare enum RCCallSessionState { /** * 等待建立连接 */ WAITING = 0, /** * 会话维持中 */ KEEPING = 1, /** * 会话已结束 */ END = 2 } /** * 通话媒体类型 */ declare enum RCCallMediaType { /** * 音频通话 */ AUDIO = 1, /** * 视频通话 */ AUDIO_VIDEO = 2 } declare class RCCallSession extends EventEmitter { private _callId; private _callPlusClient; private _channelId; private _targetId; private _callType; private _mediaType; private _context; private _logger; private _options; private _descendResolve; private _audioConfigBuilder; private _videoConfigBuilder; private _reportAppEventModule; constructor(_callId: string, _callPlusClient: RCCallPlusClient, _channelId: string, _targetId: string, _callType: ConversationType, _mediaType: RCCallPlusMediaType, _context: RTCPluginContext, _logger: BasicLogger, _options: { callPushConfig?: IPushConfig; hangupPushConfig?: IPushConfig; }); /** * 用户调用的，注册session上的监听 */ registerSessionListener(listener: ISessionListener): void; /** * 通话中更换音频设备 */ changeAudioDevice(audioConstraints?: IMicphoneAudioProfile): Promise<{ code: RCCallErrorCode; }>; /** * 群呼叫中继续邀请 * @param userIds 被邀请用户 ID 列表 * @param options 透传配置及移动端推送配置 */ invite(userIds: string[], options?: IInviteOptions): Promise<{ code: RCCallErrorCode; }>; /** * 同意接听 */ accept(constraints?: IMediaStreamConstraints): Promise<{ code: RCCallErrorCode; }>; /** * 挂断 */ hungup(): Promise<{ code: RCCallErrorCode; }>; /** * 通话降级，目前需求只做通话降级，音视频可以降级为音频，音频不能升到音视频, 发消息成功才算降级成功 */ descendAbility(): Promise<{ code: RCCallErrorCode; }>; /** * 禁用视频track */ disableVideoTrack(): Promise<{ code: RCCallErrorCode; }>; /** * 启用视频track */ enableVideoTrack(): Promise<{ code: RCCallErrorCode; }>; /** * 禁用音频track */ disableAudioTrack(): Promise<{ code: RCCallErrorCode; }>; /** * 启用音频track */ enableAudioTrack(): Promise<{ code: RCCallErrorCode; }>; /** * 通话唯一标识 */ getSessionId(): string; /** * 获取房间当前会话 Id，当房间内已无成员时房间会回收，重新加入时 sessionId 将更新，(用户录制资源用的) */ getRTCSessionId(): string | null; /** * 目标 ID，单呼对方人员 Id, 群呼群组 Id */ getTargetId(): string; /** * 获取组织 ID */ getChannelId(): string; /** * 获取会话类型 */ getConversationType(): ConversationType; /** * 房间人员列表，不包含本端信息 */ getRemoteUsers(): IUserData[]; /** * 获取人员状态 */ getUserState(userId: string): RCCallUserState; /** * 获取session状态 */ getState(): RCCallSessionState; /** * 获得会话发起者id */ getCallerId(): string; /** * 获得mediaType */ getMediaType(): RCCallMediaType; /** * @private * @param mediaType */ __innerEndTranction(mediaType: RCCallPlusMediaType, transactionId: string): void; } /** * 挂断原因 * @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 } /** * @deprecated */ declare enum RCCallLanguage { ZH = "zh", EN = "en" } declare type RCCallPacketLossStats = RCCallPlusPacketLossStats; interface IEndSummary { /** * 通话类型 */ conversationType: ConversationType; /** * 多组织 ID */ channelId: string; /** * 目标 ID */ targetId: string; /** * 通话媒体类型 */ mediaType: RCCallMediaType; /** * 通话开始时间戳 */ beginTimestamp: number; /** * 通话结束时间戳 */ endTimestamp: number; /** * 通话时间 */ duration: number; /** * 通话结束原因 */ endReason: RCCallEndReason; } interface IRCCallInitOptions { /** * RTC实例 */ callPlusClient: RCCallPlusClient; /** * 收到邀请后，产生新的session */ onSession: (session: RCCallSession, extra?: string) => void; /** * session已关闭 */ onSessionClose: (session: RCCallSession, summary?: IEndSummary) => void; /** * 离线期间收到的呼叫记录 * @returns */ onOfflineRecord?: (record: IOfflineRecord) => void; /** * 是否允许订阅重试，默认为 true * @deprecated */ isAllowSubscribeRetry?: boolean; /** * 是否允许发布重试，默认为 true * @deprecated */ isAllowPublishRetry?: boolean; /** * 禁用视频时关摄像头, 默认为 true * @deprecated */ isOffCameraWhenVideoDisable?: boolean; /** * RTC 房间加入类型，默认为：踢前一个设备 * @deprecated */ joinType?: RTCJoinType; /** * CallPlus Wrapper 中默认允许降级获取流，无需配置 * @deprecated */ isAllowDemotionGetStream?: boolean; /** * 日志输出等级 */ logOutputLevel?: LogL.DEBUG | LogL.INFO | LogL.WARN | LogL.ERROR; /** * 语言设置 (推送), 不传默认为中文 * @deprecated */ lang?: RCCallLanguage; } /** * 发送邀请时的可选项 */ interface IInviteOptions { /** * 消息的扩展信息 */ extra?: string; /** * @deprecated 请使用 `pushConfig` 属性代替 */ pushTitle?: string; /** * @deprecated 请使用 `pushConfig` 属性代替 */ pushContent?: string; /** * 移动端推送配置 */ pushConfig?: IPushConfig; } interface IMediaStreamConstraints { video?: ICameraVideoProfile; audio?: IMicphoneAudioProfile; } interface IUserProfile { /** * 用户名 */ name?: string; /** * 用户头像地址 */ portraitUri?: string; /** * user info 中附加信息 */ extra?: string; } interface IUserData extends IUserProfile { /** * 用户 ID */ userId: string; /** * 用户 状态 */ state: RCCallUserState; /** * 是否是通话发起者 */ isCaller: boolean; /** * 是否是远端用户 */ isRemote: boolean; /** * 用户 deviceId * 主要用于记录远端的用户的 deviceId, 用于处理多端消息 * @deprecated */ deviceId?: string; } interface ISender { /** * 用户 id */ userId: string; /** * @deprecated */ name?: string; /** * @deprecated */ portraitUri?: string; /** * @deprecated */ extra?: string; } interface IMuteUser extends ISender { /** * 是否禁用 */ muted: boolean; /** * track类型 */ kind: string; /** * trackId */ trackId: string; } /** * 通话发起者信息 */ interface ISenderInfo extends IUserProfile { /** * 发起者 userId */ userId: string; } declare type IInvitedUsers = ISenderInfo; /** * session上的监听 */ interface ISessionListener { /** * 当对方已响铃 */ onRinging: (sender: ISender, session: RCCallSession) => void; /** * 当对方已同意 */ onAccept: (sender: ISender, session: RCCallSession) => void; /** * 当对方已挂断 */ onHungup: (sender: ISender, reason: RCCallEndReason, session: RCCallSession) => void; /** * 群组通话，人员改变 */ onMemberModify: (sender: ISender, invitedUsers: IInvitedUsers[], session: RCCallSession) => void; /** * 通话降级 */ onMediaModify: (sender: ISender, mediaType: RCCallMediaType, session: RCCallSession) => void; /** * 当接到流 */ onTrackReady: (userId: string, mediaType: RCCallMediaType, session?: RCCallSession) => void; /** * 关闭 或 开启 音频 */ onAudioMuteChange: (muteUser: IMuteUser, session: RCCallSession) => void; /** * 关闭 或 开启 视频 */ onVideoMuteChange: (muteUser: IMuteUser, session: RCCallSession) => void; /** * 资源订阅失败 * @deprecated */ onTrackSubscribeFail?: (code: RCRTCCode, session: RCCallSession) => void; /** * 用于接收RTC状态数据报告 * @deprecated */ onRTCStateReport?: (report: IRCRTCStateReport, session: RCCallSession) => void; /** * 资源发布失败 * @deprecated */ onTrackPublishFail?(code: RCRTCCode, session: RCCallSession): void; /** * RTC 每次 Ping 结果 * @deprecated */ onPing?(result: RCRTCPingResult, session: RCCallSession): void; /** * ~ICE 连接状态变更通知~ * @deprecated */ onICEConnectionStateChange?(state: RTCIceConnectionState, session: RCCallSession): void; /** * 上行丢包率及延迟信息回调，每秒回调一次 * @param packetLostRate 丢包率，0-100 * @param delay 发送端的网络延迟，单位毫秒 */ onSendPacketLoss?(packetLostRate: number, delay: number, session: RCCallSession): void; /** * 下行丢包率及码率信息回调，每秒回调一次 * @param data key: userId, value: 接收丢包统计数据 * @param data[userId].packetLostRate 丢包率:取值范围是 0-100 * @param data[userId].bitRate 码率大小，单位是 kbps */ onReceivePacketLoss?(data: { [userId: string]: RCCallPacketLossStats; }, session: RCCallSession): void; } /** * 呼叫、挂断推送信息 */ interface IPushConfig extends Partial { /** * @deprecated */ pushContent?: string; /** * @deprecated */ pushData?: string; /** * @deprecated */ forceShowDetailContent?: boolean; } interface IRCTrackBitrate { /** * 最大码率 */ max: number; /** * 最小码率 */ min: number; /** * 上行起始码率 */ start?: number; } /** * RCCallClient callInGroup方法的传参 */ interface IRCCallInGroupParams { targetId: string; userIds: string[]; mediaType: RCCallMediaType; /** * session上要注册的监听事件 */ listener: ISessionListener; /** * 组织 Id，可选 */ channelId?: string; /** * 用于获取己方媒体资源的参数 */ constraints?: IMediaStreamConstraints; /** * 消息的扩展信息 */ extra?: string; /** * 对方显示通知的标题 */ pushTitle?: string; /** * 对方显示的通知内容 */ pushContent?: string; /** * 设置码率 */ bitrate?: { video?: IRCTrackBitrate; audio?: number; }; } /** * RCCallClient call方法的传参 */ interface IRCCallParams { /** * 被叫 Id */ targetId: string; /** * 音频 or 音视频, 默认音频 */ mediaType: RCCallMediaType; /** * session上要注册的监听事件 */ listener: ISessionListener; /** * 组织 Id，可选 */ channelId?: string; /** * 用于获取己方媒体资源的参数 */ constraints?: { video?: ICameraVideoProfile; audio: IMicphoneAudioProfile; }; /** * 消息的扩展信息 */ extra?: string; /** * 对方显示通知的标题 */ pushTitle?: string; /** * 对方显示的通知内容 */ pushContent?: string; /** * 设置码率 */ bitrate?: { video?: IRCTrackBitrate; audio?: number; }; /** * 是否为跨 appkey 通话 */ isCrossAppkey?: boolean; } interface IOfflineRecord { channelId: string; conversationType: ConversationType; targetId: string; mediaType: RCCallMediaType; callId: string; inviterId: string; endReason: RCCallEndReason; beginTimestamp: number; endTimestamp: number; duration: number; } interface IDeviceChangeParams { audio?: IMicphoneAudioProfile; video?: ICameraVideoProfile; } declare class RCCallClient { private _context; private readonly _logger; private readonly _options; private _callPlusClient; private _targetId; private _channelId; private _session; private _sessionStartTime; private _listener; private _mediaType; private _audioConfigBuilder; private _videoConfigBuilder; private _callPushConfig; private _hangupPushConfig; private _isSelfHangup; private _reportAppEventModule; constructor(_context: RTCPluginContext, _logger: BasicLogger, _options: IRCCallInitOptions); private _setCallPlusEventListener; /** * 接口已废弃，CallPlusWrapper 不再支持用户信息透传 * @deprecated */ registerUserInfo(info?: { name?: string; portraitUri?: string; extra?: string; }): void; /** * 接口已废弃，CallPlus Wrapper 不支持跨 appkey 呼叫 * @deprecated */ startCrossCall(_: IRCCallParams): Promise; private __startCall; /** * 单呼，发送invite消息，回调回来接收stateMachine, 建session * @param params.targetId 被呼叫一方的用户 id 必填 * @param params.mediaType 音频呼叫 or 音视频呼叫 必填 * @param params.listener (session上的监听) 必填 * @param params.constraints 获取音频或音视频资源时的参数 可选 * @param params.channelId 组织 Id 可选 * @param params.extra 消息扩展信息 * @param params.bitrate 需要设置的码率参数 * */ call({ targetId, mediaType, listener, constraints, channelId, extra, bitrate, }: IRCCallParams): Promise<{ code: RCCallErrorCode; session?: RCCallSession; }>; /** * 发起群组呼叫 * @param params.targetId 群组 Id 必填 * @param params.userIds 被呼叫的群内成员 Id 必填 * @param params.mediaType 音频呼叫 or 音视频呼叫 必填 * @param params.listener (session上的监听) 必填 * @param params.constraints 获取音频或音视频资源时的参数 可选 * @param params.channelId 组织 Id 可选 * @param params.extra 消息扩展信息 可选 * @param params.bitrate 需要设置的码率参数 */ callInGroup({ targetId, userIds, mediaType, listener, constraints, channelId, extra, bitrate, }: IRCCallInGroupParams): Promise<{ code: RCCallErrorCode; session?: RCCallSession; }>; /** * 获取己方其他端加入通话（已加入 RTC 房间）的用户信息 */ getJoinedRoomInfo(): Promise<{ code: RCCallErrorCode; data?: IRTCJoinedInfo[]; }>; /** * 设置呼叫、挂断推送数据 * @param callPushConfig 呼叫推送配置 * @param hangupPushConfig 挂断推送配置 */ setPushConfig(callPushConfig?: IPushConfig, hangupPushConfig?: IPushConfig): void; } declare const installer: IPluginGenerator; export { IDeviceChangeParams, IEndSummary, IInviteOptions, IInvitedUsers, IMediaStreamConstraints, IMuteUser, IOfflineRecord, IPushConfig, IRCCallInGroupParams, IRCCallInitOptions, IRCCallParams, IRCTrackBitrate, ISender, ISenderInfo, ISessionListener, IUserData, IUserProfile, RCCallClient, RCCallEndReason, RCCallErrorCode, RCCallLanguage, RCCallMediaType, RCCallPacketLossStats, RCCallSession, RCCallSessionState, RCCallUserState, installer };