@rongcloud/plugin-call-plus 2.1.10 → 2.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -508,9 +508,13 @@ interface IStartCallCon {
508
508
  */
509
509
  oldRoomId?: string;
510
510
  /**
511
- * 服务端接收的推送扩展
512
- */
511
+ * 服务端接收的推送扩展
512
+ */
513
513
  pushExt?: string;
514
+ /**
515
+ * 推送内容
516
+ */
517
+ pushContent?: string;
514
518
  /**
515
519
  * 附加信息,服务器透传
516
520
  */
@@ -565,6 +569,10 @@ interface IStartSingleCon {
565
569
  * 服务端接收的推送扩展
566
570
  */
567
571
  pushExt?: string;
572
+ /**
573
+ * 推送内容
574
+ */
575
+ pushContent?: string;
568
576
  }
569
577
  /**
570
578
  * 群呼信令内容
@@ -606,6 +614,10 @@ interface IStartGroupCon {
606
614
  * 服务端接收的推送扩展
607
615
  */
608
616
  pushExt?: string;
617
+ /**
618
+ * 推送内容
619
+ */
620
+ pushContent?: string;
609
621
  }
610
622
  /**
611
623
  * 开始呼叫 Server 返回
@@ -642,6 +654,10 @@ interface IInviteCallCon extends IBaseSingalCon {
642
654
  * 服务端接收的推送扩展
643
655
  */
644
656
  pushExt?: string;
657
+ /**
658
+ * 推送内容
659
+ */
660
+ pushContent?: string;
645
661
  }
646
662
  /**
647
663
  * 邀请好友加入信令结果
@@ -770,6 +786,10 @@ interface IHangupCallCon extends IBaseSingalCon {
770
786
  * 服务端接收的推送扩展
771
787
  */
772
788
  pushExt?: string;
789
+ /**
790
+ * 推送内容
791
+ */
792
+ pushContent?: string;
773
793
  }
774
794
  /**
775
795
  * 通话状态上报信令内容
@@ -1952,6 +1972,7 @@ declare class RCCallPlusReportModule {
1952
1972
  audioLevel: number;
1953
1973
  }[]): void;
1954
1974
  onReceivedCallPlusSummaryMessage(message: IRCCallPlusReceivedSummaryMessage): void;
1975
+ onReceivedGroupCallStatusMessage(message: IReceivedGroupCallStatusMessage): void;
1955
1976
  }
1956
1977
 
1957
1978
  declare class SignalTransporter extends EventEmitter {
@@ -1975,6 +1996,8 @@ declare class SignalTransporter extends EventEmitter {
1975
1996
  */
1976
1997
  constructor(_context: PluginContext, _runtime: IRuntime, _initOpts: ICallPlusInitOpts, _timeCorrectioner: TimeCorrectioner, _logger: BasicLogger, _reportAppEventModule: RCCallPlusReportModule);
1977
1998
  private _onMessage;
1999
+ private _dealMissMessage;
2000
+ private _dealGroupCallMessage;
1978
2001
  getSessionId(): string;
1979
2002
  getDeviceId(): string;
1980
2003
  registerListener(listener: ISignalTransporterListener): void;
@@ -2846,7 +2869,7 @@ interface ICallPlusInitOpts {
2846
2869
  isAllowNewCallWhenRinging?: boolean;
2847
2870
  }
2848
2871
  /**
2849
- * 通话记录的消息 content 字段
2872
+ * 单呼通话记录的消息 content 字段
2850
2873
  */
2851
2874
  interface IRCCallPlusSummaryMessageContent {
2852
2875
  /**
@@ -2883,30 +2906,94 @@ interface IRCCallPlusSummaryMessageContent {
2883
2906
  hangupReason: RCCallPlusReason;
2884
2907
  }
2885
2908
  /**
2886
- * 通话记录的消息结构定义
2909
+ * 群呼通话记录的类型
2910
+ */
2911
+ declare enum IGroupCallStatusMessageType {
2912
+ /**
2913
+ * 群呼通话开始
2914
+ */
2915
+ START = 1,
2916
+ /**
2917
+ * 群呼通话结束
2918
+ */
2919
+ END = 2
2920
+ }
2921
+ /**
2922
+ * 群呼通话记录的消息 content 字段
2923
+ */
2924
+ interface IRCCallPlusGroupCallStatusMessageContent {
2925
+ /**
2926
+ * 通话呼叫id
2927
+ */
2928
+ callId: string;
2929
+ /**
2930
+ * 群呼状态:
2931
+ * 1:群呼通话开始
2932
+ * 2:群呼通话结束
2933
+ */
2934
+ eventType: IGroupCallStatusMessageType;
2935
+ /**
2936
+ * 群组 Id
2937
+ */
2938
+ groupId: string;
2939
+ /**
2940
+ * 通话类型(0: AUDIO, 1: VIDEO)
2941
+ */
2942
+ mediaType: RCCallPlusMediaType;
2943
+ /**
2944
+ * 发起者 ID
2945
+ */
2946
+ startUserId: string;
2947
+ /**
2948
+ * 通话开始时间
2949
+ */
2950
+ startTime: number;
2951
+ /**
2952
+ * 同步时间
2953
+ */
2954
+ syncTime: number;
2955
+ /**
2956
+ * 通话结束时间
2957
+ */
2958
+ endTime: number;
2959
+ /**
2960
+ * 是否加密通话
2961
+ */
2962
+ secretChat: SecretCallType;
2963
+ }
2964
+ /**
2965
+ * 单呼通话记录的消息结构定义
2887
2966
  */
2888
2967
  interface IRCCallPlusReceivedSummaryMessage extends IReceivedMessage {
2889
2968
  }
2969
+ /**
2970
+ * 群呼通话记录的消息结构定义
2971
+ */
2972
+ interface IReceivedGroupCallStatusMessage extends IReceivedMessage {
2973
+ }
2890
2974
  /**
2891
2975
  * callPlus 对外事件定义
2892
2976
  */
2893
2977
  interface ICallPlusEventListener {
2894
2978
  /**
2895
- * 呼入通知
2896
- * 收到呼入时,可选择接听或挂断通话
2979
+ * 被呼叫通知
2980
+ * 被呼叫或被邀请时,收到的通知
2981
+ * 收到被呼叫时,可选择接听或挂断通话
2897
2982
  * @param session 通话实例
2898
2983
  * @param extra 透传呼叫方发起呼叫时携带的附加信息
2899
2984
  */
2900
2985
  onReceivedCall(session: RCCallPlusSession, extra?: string): void;
2901
2986
  /**
2902
- * 群组通话收到远端人员被邀请加入通话通知,如 A 与 B 通话中,A 邀请 C,则 B 会收到此回调
2903
- * @param inviteeUserList - 受邀人用户 ID 列表
2904
- * @param inviterUserId - 邀请者用户 ID
2987
+ * 群组通话中,远端人员被邀请通知,如 A 与 B 通话中,A 邀请 C,则 B 会收到此回调
2988
+ * @param inviteeUserList - 被邀请用户 ID 列表
2989
+ * @param inviterUserId - 发起邀请者的用户 ID
2905
2990
  * @param callId - 所属通话;群聊中,己方已不在通话中的情况下,也会收到服务侧的事件通知
2906
2991
  */
2907
2992
  onRemoteUserInvited(inviteeUserList: string[], inviterUserId: string, callId: string): void;
2908
2993
  /**
2909
- * 通话已建立,sdk 内部会发布音视频资源
2994
+ * 通话建立成功通知
2995
+ * 通话建立后,sdk 内部会发布音视频资源
2996
+ * @param session 通话实例
2910
2997
  */
2911
2998
  onCallConnected(session: RCCallPlusSession): void;
2912
2999
  /**
@@ -2917,54 +3004,54 @@ interface ICallPlusEventListener {
2917
3004
  */
2918
3005
  onUserMediaAvailable(userId: string, mediaType: RCCallPlusMediaType): void;
2919
3006
  /**
2920
- * 通话结束(群组通话时,客户端挂断不代表通话结束)
3007
+ * 通话结束通知
3008
+ * @description 群组通话,收到此通知时,仅代表本人退出通话,不代表通话结束,因为其他人可能仍在通话中
2921
3009
  * @param session 通话实例
2922
3010
  * @param reason 通话结束原因
2923
3011
  */
2924
3012
  onCallEnded(session: RCCallPlusSession, reason: RCCallPlusReason): void;
2925
3013
  /**
2926
- * 通话类型变更
2927
- * @param type 单呼或群呼
3014
+ * 通话类型变更通知
3015
+ * @param type 通话类型,单呼或群呼
2928
3016
  * @param callId 通话 id
2929
3017
  */
2930
3018
  onCallTypeChanged?(type: RCCallPlusType, callId: string): void;
2931
3019
  /**
2932
- * 人员状态变更
2933
- * @param callId 通话 id
2934
- * @param userId 状态变更人员 id
2935
- * @param state 人员变更后状态
2936
- * @param reason 变更原因
2937
- * @param extra 透传远端人员接听、挂断时携带的附加信息
3020
+ * 远端人员状态变更通知
3021
+ * @param callId 通话 Id
3022
+ * @param userId 远端人员的 userId
3023
+ * @param state 远端用户变更后的状态
3024
+ * @param reason 远端用户状态变更原因
2938
3025
  */
2939
3026
  onRemoteUserStateChanged?(callId: string, userId: string, state: RCCallPlusSessionUserState, reason?: RCCallPlusReason): void;
2940
3027
  /**
2941
- * 远端摄像头开、关通知
3028
+ * 远端用户摄像头开、关状态通知
2942
3029
  * @param callId 通话 id
2943
- * @param userId 用户 id
2944
- * @param disabled 是否关闭
3030
+ * @param userId 远端用户 id
3031
+ * @param disabled 摄像头是否关闭,true 为关闭状态,false 为打开状态
2945
3032
  */
2946
3033
  onRemoteCameraStateChanged?(callId: string, userId: string, disabled: boolean): void;
2947
3034
  /**
2948
- * 远端麦克风开、关通知
3035
+ * 远端用户麦克风开、关状态通知
2949
3036
  * @param callId 通话 id
2950
- * @param userId 用户 id
2951
- * @param disabled 是否关闭
3037
+ * @param userId 远端用户 id
3038
+ * @param disabled 麦克风是否关闭,true 为关闭状态,false 为打开状态
2952
3039
  */
2953
3040
  onRemoteMicrophoneStateChanged?(callId: string, userId: string, disabled: boolean): void;
2954
3041
  /**
2955
- * 单呼或群呼结束后,服务器下发的通话日志
3042
+ * 单呼或群呼结束后,服务器下发通话记录通知
2956
3043
  * @param record 数据接口定义为:IRCCallPlusCallRecord,可通过 apiDoc 查看具体包含字段
2957
3044
  */
2958
3045
  onReceivedCallRecord?(record: IRCCallPlusCallRecord): void;
2959
3046
  /**
2960
- * 收到媒体类型变更请求(仅单聊)
2961
- * @param userId 请求发起人
3047
+ * 通话中,收到远端用户请求切换媒体类型通知(仅单聊)
3048
+ * @param userId 远端用户 id,即请求发起人
2962
3049
  * @param transactionId 事物 id,本次请求和应答的唯一标识
2963
- * @param mediaType 请求变更的媒体类型
3050
+ * @param mediaType 请求切换的媒体类型,音频或音视频
2964
3051
  */
2965
3052
  onReceivedChangeMediaTypeRequest?(userId: string, transactionId: string, mediaType: RCCallPlusMediaType): void;
2966
3053
  /**
2967
- * 媒体类型变更结果(仅单聊)
3054
+ * 通话中,收到切换媒体类型结果通知(仅单聊)
2968
3055
  * @param info.userId
2969
3056
  * @param info.transactionId 事物 id,本次请求和应答的唯一标识
2970
3057
  * @param info.mediaType 最终的媒体类型
@@ -2980,10 +3067,11 @@ interface ICallPlusEventListener {
2980
3067
  code: RCCallPlusMediaTypeChangeResult;
2981
3068
  }): void;
2982
3069
  /**
2983
- * 收到通话开始计时
3070
+ * 通话开始时间通知
2984
3071
  * @param info.callId 通话 id
2985
- * @param info.callType 单聊或群聊
2986
- * @param info.callStartTime 通话开始时间
3072
+ * @param info.callType 通话类型,单聊或群聊
3073
+ * @param info.callStartTime 通话开始时间戳(ms)
3074
+ * @description 通话开始时间戳,为通话对应的房间首次被加入时的时间
2987
3075
  */
2988
3076
  onReceivedCallStartTime?(info: {
2989
3077
  callId: string;
@@ -2991,10 +3079,11 @@ interface ICallPlusEventListener {
2991
3079
  callStartTime: number;
2992
3080
  }): void;
2993
3081
  /**
2994
- * 收到首帧时间
2995
- * 收到首帧开始计费
3082
+ * 收到首帧时间通知
3083
+ * 通话从首帧时间开始计费
2996
3084
  * @param callId 通话 id
2997
3085
  * @param callFirstFrameTime 通话首帧到达时间
3086
+ * @description 首帧时间戳,为通话中所有用户最早收到首帧的时间
2998
3087
  */
2999
3088
  onReceivedCallFirstFrameTime?(callId: string, callFirstFrameTime: number): void;
3000
3089
  /**
@@ -3004,20 +3093,32 @@ interface ICallPlusEventListener {
3004
3093
  */
3005
3094
  onFetchRemoteMediaError?(userId: string, code: number): void;
3006
3095
  /**
3007
- * 人员音量变化
3096
+ * 通话中人员音量通知
3097
+ * @description 默认每秒上报一次
3008
3098
  * @param userId 本端或远端人员 id
3009
3099
  * @param audioLevel 音量值(0-100)
3010
3100
  */
3011
3101
  onUserAudioLevelChanged?(userId: string, audioLevel: number): void;
3012
3102
  /**
3013
- * 收到通话结束的消息记录,可用于在 IM 聊天界面插入通话结束消息
3014
- * 仅单聊可收到
3103
+ * 收到通话结束的消息记录通知
3104
+ * @description 仅单聊可收到,可用于在 IM 聊天界面插入通话结束消息
3015
3105
  * 触发时机:
3016
3106
  * 1.单聊在线通话结束后
3017
3107
  * 2.离线时收到单聊呼叫,通话结束后,重新连接 IM 在线时
3018
3108
  * @param message 通话记录的消息体
3019
3109
  */
3020
3110
  onReceivedCallPlusSummaryMessage?(message: IRCCallPlusReceivedSummaryMessage): void;
3111
+ /**
3112
+ * 收到群组通话开始和结束的消息,可用于在 IM 聊天界面插入通话开始和结束消息
3113
+ * 触发条件:
3114
+ * 1.仅在同一个群组中的人员可收到
3115
+ * 2.需在发起呼叫时设置 targtId 参数,targtId 为群组 id
3116
+ * 触发时机:
3117
+ * 1.群组通话开始或结束后
3118
+ * 2.离线时群组里产生新通话,重新连接 IM 在线时
3119
+ * @param message 通话记录的消息体
3120
+ */
3121
+ onReceivedGroupCallStatusMessage?(message: IReceivedGroupCallStatusMessage): void;
3021
3122
  }
3022
3123
  /**
3023
3124
  * 通话前视频配置
@@ -3157,6 +3258,10 @@ interface IRCCallPlusPushConfig {
3157
3258
  * 推送标题
3158
3259
  */
3159
3260
  pushTitle: string;
3261
+ /**
3262
+ * 推送内容
3263
+ */
3264
+ pushContent?: string;
3160
3265
  /**
3161
3266
  * iOSConfig
3162
3267
  */
@@ -3263,19 +3368,6 @@ interface IAndroidPushConfig {
3263
3368
  */
3264
3369
  imageUrlHonor?: string;
3265
3370
  }
3266
- /**
3267
- * 服务端需要的 pushConfig 数据格式
3268
- */
3269
- interface IServerPushExt {
3270
- title: string;
3271
- templateId: string;
3272
- pushId: string;
3273
- disableTitle: boolean;
3274
- forceShowPushContent: boolean;
3275
- pushConfigs: {
3276
- [key: string]: any;
3277
- }[];
3278
- }
3279
3371
 
3280
3372
  declare class RCAudioConfigBuilder {
3281
3373
  private _logger;
@@ -3392,11 +3484,8 @@ declare class RCCallPlusAndroidPushConfigBuilder {
3392
3484
  setimageUrlHonor(imageUrlHonor: string): this;
3393
3485
  /**
3394
3486
  * 构建 IAndroidPushConfig
3395
- <<<<<<< HEAD
3396
- =======
3397
3487
  * @returns IAndroidPushConfig 安卓推送配置数据
3398
3488
  * 返回值需传入 startCall、invite、hangup 方法的 pushConfig.androidConfig 中
3399
- >>>>>>> develop
3400
3489
  */
3401
3490
  build(): IAndroidPushConfig;
3402
3491
  }
@@ -3469,10 +3558,11 @@ declare class RCCallPlusClient {
3469
3558
  * 注册应用层事件
3470
3559
  * 包含“收到呼叫、通话结束、通话人员状态变更、通话类型变更”等事件
3471
3560
  * ICallPlusEventListener 对象请参考 apiDoc
3561
+ * @description 重复调用时,会覆盖前一次的设置
3472
3562
  */
3473
3563
  setCallPlusEventListener(listener: ICallPlusEventListener): void;
3474
3564
  /**
3475
- * 注册音视频上下行丢包数据监听
3565
+ * 设置通话质量数据监听
3476
3566
  * 每秒上报一次
3477
3567
  * @param listener 类型为 IStatusReportListener,详细定义可参考 apiDoc
3478
3568
  * @param listener.onSendPacketLoss 发送丢包率信息回调
@@ -3480,11 +3570,12 @@ declare class RCCallPlusClient {
3480
3570
  */
3481
3571
  setStatusReportListener(listener: IStatusReportListener): void;
3482
3572
  /**
3483
- * 设置要观看人员(包括自己和对方)的媒体播放器
3573
+ * 设置渲染视图(包括自己和对方)
3484
3574
  * @param list 为一个列表,可传入多人的媒体播放器
3485
3575
  * @param item.userId 用户 id
3486
3576
  * @param item.videoElement 一个 video 元素,用于播放视频,需要挂载在业务层页面上
3487
3577
  * @param item.isTiny 是否观看别人的小流,小窗口时可以配置为 true,可节省带宽,userId 为远端用户时有效
3578
+ * @description 暂不支持动态切换大小流
3488
3579
  * @returns code 返回是否设置成功
3489
3580
  */
3490
3581
  setVideoView(list: {
@@ -3495,7 +3586,7 @@ declare class RCCallPlusClient {
3495
3586
  code: number;
3496
3587
  };
3497
3588
  /**
3498
- * 删除某个人的媒体播放器
3589
+ * 删除渲染视图
3499
3590
  * 不观看某个人的视频时,业务层可以直接移除对应的 video 标签,
3500
3591
  * 调 removeVideoView 方法,SDK 内部会停止接收对方的媒体传输
3501
3592
  * @param userIds 用户 id 列表
@@ -3521,8 +3612,8 @@ declare class RCCallPlusClient {
3521
3612
  */
3522
3613
  createVideoConfigBuilder(): RCVideoConfigBuilder;
3523
3614
  /**
3524
- * 设置视频配置
3525
- * 下次采集时生效,如切换摄像头、重新建立通话
3615
+ * 设置视频配置:分辨率、最大/最小码率、帧率、摄像头 ID 等信息
3616
+ * 需要通话建立前设置
3526
3617
  */
3527
3618
  setVideoConfig(cfg: IVideoConfig): {
3528
3619
  code: number;
@@ -3541,8 +3632,8 @@ declare class RCCallPlusClient {
3541
3632
  */
3542
3633
  createAndroidPushConfigBuilder(): RCCallPlusAndroidPushConfigBuilder;
3543
3634
  /**
3544
- * 设置音频配置
3545
- * 下次采集时生效,如重新建立通话
3635
+ * 设置音频配置:码率、采样率、音频采集设备 ID
3636
+ * 需要通话建立前设置
3546
3637
  */
3547
3638
  setAudioConfig(cfg: IAudioConfig): {
3548
3639
  code: number;
@@ -3557,26 +3648,31 @@ declare class RCCallPlusClient {
3557
3648
  /**
3558
3649
  * 发起呼叫
3559
3650
  * @param userIds 被叫人员 userId 列表,单人呼叫仅需在数组中放置对方一人的 userId
3560
- * @param type 单人呼叫 or 多人呼叫
3561
- * @param mediaType 通话媒体类型: 音频 or 音视频
3651
+ * @param type 单人呼叫或多人呼叫
3652
+ * @param mediaType 通话媒体类型: 音频或音视频
3562
3653
  * @param pushConfig 移动端推送信息
3563
3654
  * @param extra 附加信息,会透传给被呼叫方
3655
+ * @param targetId 多人通话时,共同所在的群组 id
3656
+ * @description 重试逻辑:信令发送失败时,sdk 内部会间隔 2 秒重试一次,直到成功或超过,超时时间为一分钟
3564
3657
  * @returns callId 呼叫成功后,产生的会话 id
3565
3658
  */
3566
- startCall(userIds: string[], callType?: RCCallPlusType, mediaType?: RCCallPlusMediaType, pushConfig?: IRCCallPlusPushConfig, extra?: string): Promise<{
3659
+ startCall(userIds: string[], callType?: RCCallPlusType, mediaType?: RCCallPlusMediaType, pushConfig?: IRCCallPlusPushConfig, extra?: string, targetId?: string): Promise<{
3567
3660
  code: number;
3568
3661
  callId?: string;
3569
3662
  }>;
3570
3663
  /**
3571
3664
  * 直接加入进行中的群组通话
3665
+ * @description 只要能获取到群组通话ID,无论是否被邀请过,都可以直接加入
3666
+ * @description 重试逻辑:信令发送失败时,sdk 内部会间隔 2 秒重试一次,直到成功或超过,超时时间为一分钟
3572
3667
  * @param callId 通话 id
3573
3668
  */
3574
3669
  joinMultiCall(callId: string): Promise<{
3575
3670
  code: number;
3576
3671
  }>;
3577
3672
  /**
3578
- * 通话中邀请他人
3579
- * 单人通话中邀请他人会引发通话类型变更
3673
+ * 单聊或群组通话过程中邀请其他人加入
3674
+ * @description 单人通话中邀请他人会引发通话类型变更
3675
+ * @description 重试逻辑:信令发送失败时,sdk 内部会间隔 2 秒重试一次,直到成功或超过,超时时间为一分钟
3580
3676
  * @param userIds 被邀请人列表
3581
3677
  * @param pushConfig 移动端推送信息
3582
3678
  * @param extra 附加信息,会透传给被邀请方
@@ -3588,6 +3684,7 @@ declare class RCCallPlusClient {
3588
3684
  }>;
3589
3685
  /**
3590
3686
  * 接听通话
3687
+ * @description 重试逻辑:信令发送失败时,sdk 内部会间隔 2 秒重试一次,直到成功或超过,超时时间为一分钟
3591
3688
  * @param callId 通话 id
3592
3689
  * @param pushConfig 移动端推送信息
3593
3690
  */
@@ -3598,16 +3695,17 @@ declare class RCCallPlusClient {
3598
3695
  /**
3599
3696
  * 挂断通话
3600
3697
  * @param callId 为可选参数,不传时,挂断正在进行的主 session,传入时可指定挂断主通话或暂未建立连接的通话
3601
- * @param pushConfig 移动端推送信息
3602
3698
  * 暂未建立连接的通话:指已在通话中时,收到呼叫但暂未接听的通话
3699
+ * 挂断指定通话时,不影响其他通话状态
3603
3700
  * @param pushConfig 移动端推送信息
3604
3701
  */
3605
3702
  hangup(callId?: string, pushConfig?: IRCCallPlusPushConfig): Promise<{
3606
3703
  code: number;
3607
3704
  }>;
3608
3705
  /**
3609
- * 通话中发起媒体类型变更请求
3610
- * @param mediaType 媒体类型
3706
+ * 通话中发起媒体类型切换请求
3707
+ * @param mediaType 媒体类型,音频或音视频
3708
+ * @description 仅单呼时支持媒体类型切换,无需业务层操作摄像头
3611
3709
  * @returns transactionId 客户端和服务端交互的事务 id,在取消或应答媒体类型切换时传入
3612
3710
  */
3613
3711
  requestChangeMediaType(mediaType: RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO): Promise<{
@@ -3615,26 +3713,29 @@ declare class RCCallPlusClient {
3615
3713
  transactionId?: string;
3616
3714
  }>;
3617
3715
  /**
3618
- * 取消切换媒体类型变更请求
3716
+ * 取消已经发起的媒体类型切换请求
3619
3717
  * @param transactionId 客户端和服务端交互的事务 id,为发起媒体类型变更请求返回的 transactionId
3718
+ * @description 仅单呼时支持,可在调用 requestChangeMediaType 之后执行取消
3620
3719
  */
3621
3720
  cancelChangeMediaType(transactionId: string): Promise<{
3622
3721
  code: number;
3623
3722
  }>;
3624
3723
  /**
3625
- * 媒体类型变更应答
3724
+ * 响应通话中媒体类型切换请求
3626
3725
  * @param transactionId 客户端和服务端交互的事务 id,为 onReceivedChangeToVideo 监听收到 transactionId 参数值
3726
+ * @param isAgree 是否同意切换媒体类型
3727
+ * @description 仅单呼时支持
3627
3728
  */
3628
3729
  replyChangeMediaType(transactionId: string, isAgree: boolean): Promise<{
3629
3730
  code: number;
3630
3731
  }>;
3631
3732
  /**
3632
- * 获取当前进行中的通话
3733
+ * 获取当前进行中的通话实例
3633
3734
  * @returns RCCallPlusSession 对象或 null 为当前正在进行的通话对象
3634
3735
  */
3635
3736
  getCurrentCallSession(): RCCallPlusSession | null;
3636
3737
  /**
3637
- * 从服务器获取未结束的通话记录
3738
+ * 从服务器获取当前用户未结束的通话记录
3638
3739
  * @returns records 一组未结束的通话记录
3639
3740
  */
3640
3741
  getAvailableCallRecordsFromServer(): Promise<{
@@ -3642,7 +3743,7 @@ declare class RCCallPlusClient {
3642
3743
  records?: IRCCallPlusCallRecord[];
3643
3744
  }>;
3644
3745
  /**
3645
- * 分页查找当前用户的全部通话记录
3746
+ * 获取当前用户的通话记录
3646
3747
  * @param startTimestamp 起始时间戳,
3647
3748
  * 首次获取可传 -1,倒序时,返回最新的通话记录,正序时,返回最早的通话记录
3648
3749
  * order 为正序时,返回大于此时间戳的通话记录
@@ -3660,20 +3761,21 @@ declare class RCCallPlusClient {
3660
3761
  result?: IRCCallPlusGetCallRecordRes;
3661
3762
  }>;
3662
3763
  /**
3663
- * 根据 callId 集合批量删除通话记录
3664
- * @param callIds callId 列表
3764
+ * 批量删除当前用户通话记录
3765
+ * @param callIds 需要删除通话记录的 callId 列表
3665
3766
  */
3666
3767
  deleteCallRecordsFromServer(callIds: string[]): Promise<{
3667
3768
  code: number;
3668
3769
  }>;
3669
3770
  /**
3670
- * 清空所有通话记录
3771
+ * 删除当前用户所有通话记录
3671
3772
  */
3672
3773
  deleteAllCallRecordsFromServer(): Promise<{
3673
3774
  code: number;
3674
3775
  }>;
3675
3776
  /**
3676
3777
  * 开启摄像头
3778
+ * @description 视频通话建立后默认状态为开启
3677
3779
  * @description 通话过程中打开摄像头,如果扩散资源失败,即对方没收到本端打开摄像头的通知时,此次行为失败
3678
3780
  * @returns track 摄像头视频资源
3679
3781
  */
@@ -3687,7 +3789,8 @@ declare class RCCallPlusClient {
3687
3789
  code: number;
3688
3790
  }>;
3689
3791
  /**
3690
- * 切换摄像头功能,通话前和通话中都可调用。
3792
+ * 切换指定摄像头
3793
+ * @description 通话建立前和通话过程中都可调用
3691
3794
  * @param cameraId 浏览器中取得的摄像头设备 id,可调 getCameras 方法取得
3692
3795
  * @description 切换成功后,`ICallPlusEventListener` 监听器的 `onUserMediaAvailable` 会被触发,此时调用 `callPlusClient.playMedia` 方法播放新的资源。
3693
3796
  */
@@ -3696,6 +3799,7 @@ declare class RCCallPlusClient {
3696
3799
  }>;
3697
3800
  /**
3698
3801
  * 开启麦克风
3802
+ * @description 通话建立后默认开启
3699
3803
  * @description 通话过程中打开麦克风,如果扩散资源失败,即对方没收到本端打开麦克风的通知时,此次行为失败
3700
3804
  */
3701
3805
  startMicrophone(): Promise<{
@@ -3709,12 +3813,13 @@ declare class RCCallPlusClient {
3709
3813
  code: number;
3710
3814
  }>;
3711
3815
  /**
3712
- * 麦克风是否开启
3816
+ * 获取麦克风开关状态
3713
3817
  */
3714
3818
  isMicrophoneEnabled(): boolean;
3715
3819
  /**
3716
3820
  * 设置所有远端音频流是否可用
3717
3821
  * @param enable 为 true 时,启用所有远端音频流;为 false 时,静音所有远端音频流
3822
+ * @description 静音操作仅不播放远端用户音频流,媒体通道还会继续接收远端音频数据
3718
3823
  */
3719
3824
  setAllRemoteAudioEnable(enable: boolean): Promise<{
3720
3825
  code: number;
@@ -3749,4 +3854,4 @@ declare class RCCallPlusClient {
3749
3854
 
3750
3855
  declare const installer: IPluginGenerator<RCCallPlusClient, ICallPlusInitOpts>;
3751
3856
 
3752
- export { IAndroidPushConfig, IAudioConfig, IAudioConfigBuilder, ICallOpts, ICallPlusEventListener, ICallPlusInitOpts, IRCCallPlusCallRecord, IRCCallPlusGetCallRecordRes, IRCCallPlusPushConfig, IRCCallPlusReceivedSummaryMessage, IRCCallPlusSummaryMessageContent, IServerPushExt, IStatusReportListener, IVideoConfig, IVideoConfigBuilder, IiOSPushConfig, RCAudioConfigBuilder, RCCallPlusAndroidPushConfigBuilder, RCCallPlusCallState, RCCallPlusCallUser, RCCallPlusClient, RCCallPlusCode, RCCallPlusMediaType, RCCallPlusMediaTypeChangeResult, RCCallPlusPacketLossStats, RCCallPlusReason, RCCallPlusSession, RCCallPlusSessionUserState, RCCallPlusType, RCVideoConfigBuilder, installer };
3857
+ export { IAndroidPushConfig, IAudioConfig, IAudioConfigBuilder, ICallOpts, ICallPlusEventListener, ICallPlusInitOpts, IGroupCallStatusMessageType, IRCCallPlusCallRecord, IRCCallPlusGetCallRecordRes, IRCCallPlusGroupCallStatusMessageContent, IRCCallPlusPushConfig, IRCCallPlusReceivedSummaryMessage, IRCCallPlusSummaryMessageContent, IReceivedGroupCallStatusMessage, IStatusReportListener, IVideoConfig, IVideoConfigBuilder, IiOSPushConfig, RCAudioConfigBuilder, RCCallPlusAndroidPushConfigBuilder, RCCallPlusCallState, RCCallPlusCallUser, RCCallPlusClient, RCCallPlusCode, RCCallPlusMediaType, RCCallPlusMediaTypeChangeResult, RCCallPlusPacketLossStats, RCCallPlusReason, RCCallPlusSession, RCCallPlusSessionUserState, RCCallPlusType, RCVideoConfigBuilder, installer };