@rongcloud/plugin-call 5.0.5 → 5.0.9

package/dist/interface.d.ts

@@ -0,0 +1,294 @@
+import { LogLevel, RTCJoinType } from '@rongcloud/engine';
+import { RCRTCClient, RCTrack, RCLocalTrack, RCRTCCode, ICameraVideoProfile, IMicphoneAudioProfile, IRCRTCStateReport, RCRTCPingResult } from '@rongcloud/plugin-rtc';
+import { ProduceTypes } from './enums';
+import { RCCallSession } from './RCCallSession';
+import { RCCallMediaType, RCCallEndReason, RCCallLanguage, IEndSummary, IInvitedUsers, IOfflineRecord } from '@rongcloud/plugin-call-engine';
+export interface ISender {
+    userId: string;
+    /**
+    * 用户名
+    */
+    name?: string;
+    /**
+    * 用户头像地址
+    */
+    portraitUri?: string;
+    /**
+    * user info 中附加信息
+    */
+    extra?: string;
+}
+export interface IMuteUser extends ISender {
+    /**
+     * 是否禁用
+     */
+    muted: boolean;
+    /**
+     * track类型
+     */
+    kind: string;
+    /**
+     * trackId
+     */
+    trackId: string;
+}
+/**
+ * CallLib 初始化参数
+ */
+export interface IRCCallInitOptions {
+    /**
+     * RTC实例
+     */
+    rtcClient: RCRTCClient;
+    /**
+     * 收到邀请后，产生新的session
+     */
+    onSession: (session: RCCallSession, extra?: string) => void;
+    /**
+     * session已关闭
+     */
+    onSessionClose: (session: RCCallSession, summary?: IEndSummary) => void;
+    onOfflineRecord?: (record: IOfflineRecord) => void;
+    /**
+     * 是否允许接听新呼叫，当前正在通话，如果收到新的邀请，是直接挂断，还是允许选择, 默认值false,直接挂断新的session
+     *
+     * 暂不对外暴露
+     */
+    /**
+    * 是否允许订阅重试， 默认为false
+    */
+    isAllowSubscribeRetry?: boolean;
+    /**
+     * 是否允许发布重试， 默认为false
+     */
+    isAllowPublishRetry?: boolean;
+    /**
+     * 禁用视频时关摄像头, 默认false
+     */
+    isOffCameraWhenVideoDisable?: boolean;
+    /**
+     * RTC 房间加入类型
+     */
+    joinType?: RTCJoinType;
+    /**
+     * 允许降级获得流，获得音视频不成功 ，降级获得音频
+     */
+    isAllowDemotionGetStream?: boolean;
+    /**
+     * 日志等级
+     */
+    logLevel?: LogLevel;
+    logStdout?: (logLevel: LogLevel, content: string) => void;
+    /**
+     * 语言设置 (推送), 不传默认为中文
+     */
+    lang?: RCCallLanguage;
+}
+/**
+ * session上的监听
+ */
+export 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: (track: RCTrack, session?: RCCallSession) => void;
+    /**
+     * 关闭 或 开启 音频
+     */
+    onAudioMuteChange: (muteUser: IMuteUser, session: RCCallSession) => void;
+    /**
+     * 关闭 或 开启 视频
+     */
+    onVideoMuteChange: (muteUser: IMuteUser, session: RCCallSession) => void;
+    /**
+    * 资源订阅失败
+    */
+    onTrackSubscribeFail?: (code: RCRTCCode, session: RCCallSession) => void;
+    /**
+    * 资源发布失败
+    */
+    onTrackPublishFail?: (code: RCRTCCode, session: RCCallSession) => void;
+    /**
+     * 用于接收RTC状态数据报告
+     */
+    onRTCStateReport?: (report: IRCRTCStateReport, session: RCCallSession) => void;
+    /**
+     * RTC 每次 Ping 结果
+     */
+    onPing?: (result: RCRTCPingResult, session: RCCallSession) => void;
+    /**
+     * ~ICE 连接状态变更通知~
+     * @since version 5.1.5
+     */
+    onICEConnectionStateChange?: (state: RTCIceConnectionState, session: RCCallSession) => void;
+}
+/**
+ * 创建session的options
+ */
+export interface IRCCallSessionOptions {
+    /**
+     * 本地资源,用户主动发起会话的时候，会先获得本地资源
+     */
+    localTracks?: RCLocalTrack[];
+    /**
+     * 是否允许订阅重试， 默认为false
+     */
+    isAllowSubscribeRetry?: boolean;
+    /**
+     * 是否允许发布重试， 默认为false
+     */
+    isAllowPublishRetry?: boolean;
+    /**
+     * 禁用视频时关摄像头, 默认false
+     */
+    isOffCameraWhenVideoDisable?: boolean;
+    /**
+     * RTC 房间加入类型
+     */
+    joinType?: RTCJoinType;
+    /**
+     * 允许降级获得流，获得音视频不成功 ，降级获得音频
+     */
+    isAllowDemotionGetStream?: boolean;
+    /**
+     * 产生session的场景，是主叫产生 或 被叫产生
+     */
+    produceType?: ProduceTypes;
+}
+export interface IRCTrackBitrate {
+    /**
+     * 最大码率
+     */
+    max: number;
+    /**
+     * 最小码率
+     */
+    min: number;
+    /**
+     * 上行起始码率
+     */
+    start?: number;
+}
+/**
+ * RCCallClient call方法的传参
+ */
+export interface IRCCallParams {
+    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;
+    };
+}
+export interface IMediaStreamConstraints {
+    video?: ICameraVideoProfile;
+    audio?: IMicphoneAudioProfile;
+}
+export interface IMediaStreamDevice {
+    video?: ICameraVideoProfile;
+    audio?: IMicphoneAudioProfile;
+}
+/**
+ * RCCallClient callInGroup方法的传参
+ */
+export 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;
+    };
+}
+export interface IDevice {
+    deviceId: string;
+}
+export interface IDeviceChangeParams {
+    audio?: IMicphoneAudioProfile;
+    video?: ICameraVideoProfile;
+}
+export interface IValidationResult {
+    result: boolean;
+    msg?: string;
+}
+//# sourceMappingURL=interface.d.ts.map

package/dist/logger.d.ts

@@ -0,0 +1,4 @@
+import { Logger } from '@rongcloud/engine';
+declare const logger: Logger;
+export default logger;
+//# sourceMappingURL=logger.d.ts.map

package/dist/timer.d.ts

@@ -0,0 +1,12 @@
+export declare class Timer {
+    private _timerId;
+    private _startTime;
+    constructor(callback: Function, timeout: number);
+    stop(): {
+        startTime: number;
+        endTime: number;
+        duration: number;
+    };
+    reset(): void;
+}
+//# sourceMappingURL=timer.d.ts.map

package/dist/utils.d.ts

@@ -0,0 +1,9 @@
+declare class EventEmitter {
+    private list;
+    on(event: string, fun: (data?: any) => void): this;
+    once(event: string, fun: (data?: any) => void): void;
+    off(event: string, fun?: (data?: any) => void): false | undefined;
+    emit(event: string, data?: any): false | undefined;
+}
+export { EventEmitter };
+//# sourceMappingURL=utils.d.ts.map

package/dist/validation.d.ts

@@ -0,0 +1,14 @@
+import { ISessionListener, IRCCallInitOptions, IValidationResult, IMediaStreamConstraints } from './interface';
+export declare const validateCallInitOptions: (options: IRCCallInitOptions) => IValidationResult;
+/**
+ * 校验registerSessionListener参数
+ */
+export declare const validateListener: (listener: ISessionListener) => IValidationResult;
+export declare const validateTargetId: (targetId: string) => IValidationResult;
+export declare const validateMediaType: (mediaType: number) => IValidationResult;
+export declare const validateExtra: (extra: string) => IValidationResult;
+export declare const validatePushTitle: (pushTitle: string) => IValidationResult;
+export declare const validatePushContent: (pushContent: string) => IValidationResult;
+export declare const validateUserIds: (userIds: string[]) => IValidationResult;
+export declare const validateMediaStreamConstraints: (constraints: IMediaStreamConstraints) => IValidationResult;
+//# sourceMappingURL=validation.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rongcloud/plugin-call",
-  "version": "5.0.5",
+  "version": "5.0.9",
   "description": "@rongcloud/plugin-call",
   "main": "./dist/index.js",
   "__attrs__": {
@@ -32,13 +32,11 @@
     "node": ">=10.0.0"
   },
   "peerDependencies": {
-    "@rongcloud/engine": ">=4.5.2",
-    "@rongcloud/plugin-rtc": "~5.2.2"
+    "@rongcloud/engine": "^4.5.5-enterprise.1",
+    "@rongcloud/plugin-rtc": "^5.1.10-enterprise.5"
   },
   "dependencies": {
-    "@rongcloud/plugin-call-engine": "~5.0.5",
-    "@rongcloud/engine": ">=4.5.2",
-    "@rongcloud/plugin-rtc": "~5.2.2"
+    "@rongcloud/plugin-call-engine": "^5.0.7"
   },
-  "__commit__": "87afc0755fbba331ed398046c2aa4f5c245a4e42"
+  "__commit__": "f294f72dac7c00501b662e7a3beeaafe9ee5def6"
 }