@rongcloud/plugin-call 5.1.1 → 5.1.2-alpha.2

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.
Files changed (9) hide show
  1. package/dist/RCCallClient.d.ts +23 -10
  2. package/dist/RCCallSession.d.ts +5 -4
  3. package/dist/index.d.ts +51 -16
  4. package/dist/index.esm.js +1883 -15
  5. package/dist/index.js +1912 -15
  6. package/dist/index.umd.js +1914 -15
  7. package/dist/interface.d.ts +21 -0
  8. package/dist/validation.d.ts +2 -1
  9. package/package.json +4 -4
package/dist/RCCallClient.d.ts CHANGED
@@ -1,10 +1,11 @@
1
- import { RTCPluginContext, IRuntime, IRTCJoinedInfo } from '@rongcloud/engine';
1
+ import { RTCPluginContext, IRuntime, IRTCJoinedInfo, BasicLogger } from '@rongcloud/engine';
2
2
  import { RCCallErrorCode, IOfflineRecord } from '@rongcloud/plugin-call-engine';
3
- import { IRCCallInGroupParams, IRCCallInitOptions, IRCCallParams } from './interface';
3
+ import { IRCCallInGroupParams, IRCCallInitOptions, IRCCallParams, IPushConfig } from './interface';
4
4
  import { RCCallSession } from './RCCallSession';
5
5
  export default class RCCallClient {
6
6
  private _context;
7
7
  private readonly _runtime;
8
+ private readonly _logger;
8
9
  /**
9
10
  * rtc实例
10
11
  */
@@ -21,7 +22,9 @@ export default class RCCallClient {
21
22
  * session列表
22
23
  */
23
24
  private _sessionList;
24
- constructor(_context: RTCPluginContext, _runtime: IRuntime, _options: IRCCallInitOptions);
25
+ private _callPushConfig;
26
+ private _hungupPushConfig;
27
+ constructor(_context: RTCPluginContext, _runtime: IRuntime, _logger: BasicLogger, _options: IRCCallInitOptions);
25
28
  /**
26
29
  * 监听onInvite
27
30
  */
@@ -50,8 +53,8 @@ export default class RCCallClient {
50
53
  * @param params.constraints 获取音频或音视频资源时的参数 可选
51
54
  * @param params.channelId 组织 Id 可选
52
55
  * @param params.extra 消息扩展信息
53
- * @param params.pushTitle 通知的标题
54
- * @param params.pushContent 通知的内容
56
+ * @deprecated 5.1.2 版本废弃 params.pushTitle 通知的标题
57
+ * @deprecated 5.1.2 版本废弃 params.pushContent 通知的内容
55
58
  * @param params.bitrate 需要设置的码率参数
56
59
  *
57
60
  */
@@ -67,8 +70,8 @@ export default class RCCallClient {
67
70
  * @param params.constraints 获取音频或音视频资源时的参数 可选
68
71
  * @param params.channelId 组织 Id 可选
69
72
  * @param params.extra 消息扩展信息
70
- * @param params.pushTitle 通知的标题
71
- * @param params.pushContent 通知的内容
73
+ * @deprecated 5.1.2 版本废弃 params.pushTitle 通知的标题
74
+ * @deprecated 5.1.2 版本废弃 params.pushContent 通知的内容
72
75
  * @param params.bitrate 需要设置的码率参数
73
76
  *
74
77
  */
@@ -86,11 +89,11 @@ export default class RCCallClient {
86
89
  * @param params.constraints 获取音频或音视频资源时的参数 可选
87
90
  * @param params.channelId 组织 Id 可选
88
91
  * @param params.extra 消息扩展信息 可选
89
- * @param params.pushTitle 通知的标题
90
- * @param params.pushContent 通知的内容
92
+ * @deprecated 5.1.2 版本废弃 params.pushTitle 通知的标题
93
+ * @deprecated 5.1.2 版本废弃 params.pushContent 通知的内容
91
94
  * @param params.bitrate 需要设置的码率参数
92
95
  */
93
- callInGroup({ targetId, userIds, mediaType, listener, constraints, channelId, extra, pushTitle, pushContent, bitrate }: IRCCallInGroupParams): Promise<{
96
+ callInGroup({ targetId, userIds, mediaType, listener, constraints, channelId, extra, bitrate }: IRCCallInGroupParams): Promise<{
94
97
  code: RCCallErrorCode;
95
98
  session?: RCCallSession;
96
99
  }>;
@@ -110,5 +113,15 @@ export default class RCCallClient {
110
113
  code: RCCallErrorCode;
111
114
  data?: IRTCJoinedInfo[];
112
115
  }>;
116
+ /**
117
+ * 设置呼叫、挂断推送数据
118
+ * @param callPushConfig 呼叫推送配置
119
+ * @param callPushConfig.pushTitle 呼叫推送标题
120
+ * @param callPushConfig.pushContent 呼叫推送内容
121
+ * @param hungupPushConfig 挂断推送配置
122
+ * @param hungupPushConfig.pushTitle 挂断推送标题
123
+ * @param hungupPushConfig.pushContent 挂断推送内容
124
+ */
125
+ setPushConfig(callPushConfig?: IPushConfig, hungupPushConfig?: IPushConfig): void;
113
126
  }
114
127
  //# sourceMappingURL=RCCallClient.d.ts.map
package/dist/RCCallSession.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ConversationType } from '@rongcloud/engine';
1
+ import { ConversationType, ILogger } from '@rongcloud/engine';
2
2
  import { IUserData, IInviteOptions, RCCallErrorCode, RCCallMediaType, RCCallSessionState, RCCallStateMachine, RCCallUserState } from '@rongcloud/plugin-call-engine';
3
3
  import { RCRTCClient, IMicphoneAudioProfile } from '@rongcloud/plugin-rtc';
4
4
  import { IMediaStreamConstraints, IRCCallSessionOptions, ISessionListener } from './interface';
@@ -11,6 +11,7 @@ export declare class RCCallSession {
11
11
  * rtc实例
12
12
  */
13
13
  private readonly _rtcClient;
14
+ private readonly _logger;
14
15
  /**
15
16
  * session的其它选项
16
17
  */
@@ -39,7 +40,7 @@ export declare class RCCallSession {
39
40
  /**
40
41
  * rtc实例
41
42
  */
42
- _rtcClient: RCRTCClient,
43
+ _rtcClient: RCRTCClient, _logger: ILogger,
43
44
  /**
44
45
  * session的其它选项
45
46
  */
@@ -99,8 +100,8 @@ export declare class RCCallSession {
99
100
  * 群呼叫中继续邀请
100
101
  * @param userIds 被邀请用户 ID 列表
101
102
  * @param options.extra 消息的扩展信息
102
- * @param options.pushTitle 通知的标题
103
- * @param options.pushContent 通知内容
103
+ * @deprecated 5.1.2 废弃 options.pushTitle 通知的标题
104
+ * @deprecated 5.1.2 废弃 options.pushContent 通知内容
104
105
  */
105
106
  invite(userIds: string[], options?: IInviteOptions): Promise<{
106
107
  code: RCCallErrorCode;
package/dist/index.d.ts CHANGED
@@ -1,10 +1,10 @@
1
1
  /*
2
- * RCCall - v5.1.1
3
- * CommitId - ba3fba8044d94f2fb2d74a189c4ecc3adbad8e46
4
- * Wed Jan 11 2023 14:39:33 GMT+0800 (China Standard Time)
2
+ * RCCall - v5.1.2-alpha.2
3
+ * CommitId - 8d4f8b00cda704283faad34d0e81a4e048e09d08
4
+ * Tue Feb 28 2023 21:09:53 GMT+0800 (China Standard Time)
5
5
  * ©2020 RongCloud, Inc. All rights reserved.
6
6
  */
7
- import { ConversationType, RTCJoinType, LogLevel, RTCPluginContext, IRuntime, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
7
+ import { ILogger, ConversationType, RTCJoinType, LogLevel, RTCPluginContext, IRuntime, BasicLogger, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
8
8
  import { RCCallStateMachine, RCCallErrorCode, IInviteOptions, RCCallMediaType, IUserData, RCCallUserState, RCCallSessionState, IEndSummary, IOfflineRecord, RCCallLanguage, RCCallEndReason, IInvitedUsers } from '@rongcloud/plugin-call-engine';
9
9
  export { IEndSummary, IInvitedUsers, IOfflineRecord, ISenderInfo, RCCallEndReason, RCCallErrorCode, RCCallLanguage, RCCallMediaType, RCCallSessionState, RCCallUserState } from '@rongcloud/plugin-call-engine';
10
10
  import { RCRTCClient, IMicphoneAudioProfile, RCTrack, RCRTCCode, IRCRTCStateReport, RCRTCPingResult, RCLocalTrack, ICameraVideoProfile } from '@rongcloud/plugin-rtc';
@@ -33,6 +33,7 @@ declare class RCCallSession {
33
33
  * rtc实例
34
34
  */
35
35
  private readonly _rtcClient;
36
+ private readonly _logger;
36
37
  /**
37
38
  * session的其它选项
38
39
  */
@@ -61,7 +62,7 @@ declare class RCCallSession {
61
62
  /**
62
63
  * rtc实例
63
64
  */
64
- _rtcClient: RCRTCClient,
65
+ _rtcClient: RCRTCClient, _logger: ILogger,
65
66
  /**
66
67
  * session的其它选项
67
68
  */
@@ -121,8 +122,8 @@ declare class RCCallSession {
121
122
  * 群呼叫中继续邀请
122
123
  * @param userIds 被邀请用户 ID 列表
123
124
  * @param options.extra 消息的扩展信息
124
- * @param options.pushTitle 通知的标题
125
- * @param options.pushContent 通知内容
125
+ * @deprecated 5.1.2 废弃 options.pushTitle 通知的标题
126
+ * @deprecated 5.1.2 废弃 options.pushContent 通知内容
126
127
  */
127
128
  invite(userIds: string[], options?: IInviteOptions): Promise<{
128
129
  code: RCCallErrorCode;
@@ -337,6 +338,19 @@ interface IRCCallInitOptions {
337
338
  */
338
339
  lang?: RCCallLanguage;
339
340
  }
341
+ /**
342
+ * 呼叫、挂断推送信息
343
+ */
344
+ interface IPushConfig {
345
+ /**
346
+ * 推送标题
347
+ */
348
+ pushTitle?: string;
349
+ /**
350
+ * 推送内容
351
+ */
352
+ pushContent?: string;
353
+ }
340
354
  /**
341
355
  * session上的监听
342
356
  */
@@ -428,6 +442,14 @@ interface IRCCallSessionOptions {
428
442
  */
429
443
  produceType?: ProduceTypes;
430
444
  isCrossAppkey?: boolean;
445
+ /**
446
+ * 呼叫推送配置
447
+ */
448
+ callPushConfig?: IPushConfig;
449
+ /**
450
+ * 挂断推送配置
451
+ */
452
+ hungupPushConfig?: IPushConfig;
431
453
  }
432
454
  interface IRCTrackBitrate {
433
455
  /**
@@ -542,6 +564,7 @@ interface IDeviceChangeParams {
542
564
  declare class RCCallClient {
543
565
  private _context;
544
566
  private readonly _runtime;
567
+ private readonly _logger;
545
568
  /**
546
569
  * rtc实例
547
570
  */
@@ -558,7 +581,9 @@ declare class RCCallClient {
558
581
  * session列表
559
582
  */
560
583
  private _sessionList;
561
- constructor(_context: RTCPluginContext, _runtime: IRuntime, _options: IRCCallInitOptions);
584
+ private _callPushConfig;
585
+ private _hungupPushConfig;
586
+ constructor(_context: RTCPluginContext, _runtime: IRuntime, _logger: BasicLogger, _options: IRCCallInitOptions);
562
587
  /**
563
588
  * 监听onInvite
564
589
  */
@@ -587,8 +612,8 @@ declare class RCCallClient {
587
612
  * @param params.constraints 获取音频或音视频资源时的参数 可选
588
613
  * @param params.channelId 组织 Id 可选
589
614
  * @param params.extra 消息扩展信息
590
- * @param params.pushTitle 通知的标题
591
- * @param params.pushContent 通知的内容
615
+ * @deprecated 5.1.2 版本废弃 params.pushTitle 通知的标题
616
+ * @deprecated 5.1.2 版本废弃 params.pushContent 通知的内容
592
617
  * @param params.bitrate 需要设置的码率参数
593
618
  *
594
619
  */
@@ -604,8 +629,8 @@ declare class RCCallClient {
604
629
  * @param params.constraints 获取音频或音视频资源时的参数 可选
605
630
  * @param params.channelId 组织 Id 可选
606
631
  * @param params.extra 消息扩展信息
607
- * @param params.pushTitle 通知的标题
608
- * @param params.pushContent 通知的内容
632
+ * @deprecated 5.1.2 版本废弃 params.pushTitle 通知的标题
633
+ * @deprecated 5.1.2 版本废弃 params.pushContent 通知的内容
609
634
  * @param params.bitrate 需要设置的码率参数
610
635
  *
611
636
  */
@@ -623,11 +648,11 @@ declare class RCCallClient {
623
648
  * @param params.constraints 获取音频或音视频资源时的参数 可选
624
649
  * @param params.channelId 组织 Id 可选
625
650
  * @param params.extra 消息扩展信息 可选
626
- * @param params.pushTitle 通知的标题
627
- * @param params.pushContent 通知的内容
651
+ * @deprecated 5.1.2 版本废弃 params.pushTitle 通知的标题
652
+ * @deprecated 5.1.2 版本废弃 params.pushContent 通知的内容
628
653
  * @param params.bitrate 需要设置的码率参数
629
654
  */
630
- callInGroup({ targetId, userIds, mediaType, listener, constraints, channelId, extra, pushTitle, pushContent, bitrate }: IRCCallInGroupParams): Promise<{
655
+ callInGroup({ targetId, userIds, mediaType, listener, constraints, channelId, extra, bitrate }: IRCCallInGroupParams): Promise<{
631
656
  code: RCCallErrorCode;
632
657
  session?: RCCallSession;
633
658
  }>;
@@ -647,8 +672,18 @@ declare class RCCallClient {
647
672
  code: RCCallErrorCode;
648
673
  data?: IRTCJoinedInfo[];
649
674
  }>;
675
+ /**
676
+ * 设置呼叫、挂断推送数据
677
+ * @param callPushConfig 呼叫推送配置
678
+ * @param callPushConfig.pushTitle 呼叫推送标题
679
+ * @param callPushConfig.pushContent 呼叫推送内容
680
+ * @param hungupPushConfig 挂断推送配置
681
+ * @param hungupPushConfig.pushTitle 挂断推送标题
682
+ * @param hungupPushConfig.pushContent 挂断推送内容
683
+ */
684
+ setPushConfig(callPushConfig?: IPushConfig, hungupPushConfig?: IPushConfig): void;
650
685
  }
651
686
 
652
687
  declare const installer: IPluginGenerator<RCCallClient, IRCCallInitOptions>;
653
688
 
654
- export { IDeviceChangeParams, IMediaStreamConstraints, IMuteUser, IRCCallInGroupParams, IRCCallInitOptions, IRCCallParams, ISessionListener, RCCallClient, RCCallSession, installer };
689
+ export { IDeviceChangeParams, IMediaStreamConstraints, IMuteUser, IPushConfig, IRCCallInGroupParams, IRCCallInitOptions, IRCCallParams, ISessionListener, RCCallClient, RCCallSession, installer };