tencentcloud-sdk-nodejs-trtc 4.0.338 → 4.0.341

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.
@@ -1,3 +1,16 @@
1
+ /**
2
+ * DismissRoomByStrRoomId请求参数结构体
3
+ */
4
+ export interface DismissRoomByStrRoomIdRequest {
5
+ /**
6
+ * TRTC的SDKAppId。
7
+ */
8
+ SdkAppId: number;
9
+ /**
10
+ * 房间号。
11
+ */
12
+ RoomId: string;
13
+ }
1
14
  /**
2
15
  * DescribeAbnormalEvent返回参数结构体
3
16
  */
@@ -15,6 +28,36 @@ export interface DescribeAbnormalEventResponse {
15
28
  */
16
29
  RequestId?: string;
17
30
  }
31
+ /**
32
+ * 第三方云存储的账号信息。
33
+ */
34
+ export interface CloudStorage {
35
+ /**
36
+ * 第三方云储存的供应商:
37
+ 0:腾讯云存储 COS,暂不支持其他家。
38
+ */
39
+ Vendor: number;
40
+ /**
41
+ * 第三方云存储的地域信息。
42
+ */
43
+ Region: string;
44
+ /**
45
+ * 第三方存储桶信息。
46
+ */
47
+ Bucket: string;
48
+ /**
49
+ * 第三方存储的access_key账号信息。
50
+ */
51
+ AccessKey: string;
52
+ /**
53
+ * 第三方存储的secret_key账号信息。
54
+ */
55
+ SecretKey: string;
56
+ /**
57
+ * 第三方云存储bucket 的指定位置,由字符串数组组成。合法的字符串范围a~z,A~Z,0~9,举个例子,录制文件xxx.m3u8在 ["prefix1", "prefix2"]作用下,会变成prefix1/prefix2/TaskId/xxx.m3u8。
58
+ */
59
+ FileNamePrefix?: Array<string>;
60
+ }
18
61
  /**
19
62
  * DescribeAbnormalEvent请求参数结构体
20
63
  */
@@ -72,91 +115,88 @@ export interface ModifyPictureResponse {
72
115
  RequestId?: string;
73
116
  }
74
117
  /**
75
- * StartMCUMixTranscodeByStrRoomId请求参数结构体
118
+ * RemoveUser请求参数结构体
76
119
  */
77
- export interface StartMCUMixTranscodeByStrRoomIdRequest {
120
+ export interface RemoveUserRequest {
78
121
  /**
79
122
  * TRTC的SDKAppId。
80
123
  */
81
124
  SdkAppId: number;
82
125
  /**
83
- * 字符串房间号。
84
- */
85
- StrRoomId: string;
86
- /**
87
- * 混流输出控制参数。
88
- */
89
- OutputParams: OutputParams;
90
- /**
91
- * 混流输出编码参数。
92
- */
93
- EncodeParams: EncodeParams;
94
- /**
95
- * 混流输出布局参数。
126
+ * 房间号。
96
127
  */
97
- LayoutParams: LayoutParams;
128
+ RoomId: number;
98
129
  /**
99
- * 第三方CDN转推参数。
130
+ * 要移出的用户列表,最多10个。
100
131
  */
101
- PublishCdnParams?: PublishCdnParams;
132
+ UserIds: Array<string>;
102
133
  }
103
134
  /**
104
- * MCU混流布局参数
135
+ * DescribeCloudRecording返回参数结构体
105
136
  */
106
- export interface LayoutParams {
137
+ export interface DescribeCloudRecordingResponse {
107
138
  /**
108
- * 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
139
+ * 录制任务的唯一Id。
109
140
  */
110
- Template?: number;
141
+ TaskId: string;
111
142
  /**
112
- * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
113
- */
114
- MainVideoUserId?: string;
143
+ * 云端录制任务的状态信息。
144
+ Idle:表示当前录制任务空闲中
145
+ InProgress:表示当前录制任务正在进行中。
146
+ Exited:表示当前录制任务正在退出的过程中。
147
+ */
148
+ Status: string;
115
149
  /**
116
- * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
117
- */
118
- MainVideoStreamType?: number;
150
+ * 录制文件信息。
151
+ 注意:此字段可能返回 null,表示取不到有效值。
152
+ */
153
+ StorageFileList: Array<StorageFile>;
119
154
  /**
120
- * 画中画模板中有效,代表小画面的布局参数。
155
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
121
156
  */
122
- SmallVideoLayoutParams?: SmallVideoLayoutParams;
157
+ RequestId?: string;
158
+ }
159
+ /**
160
+ * 返回的质量数据,时间:值
161
+ */
162
+ export interface TimeValue {
123
163
  /**
124
- * 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
164
+ * 时间,unix时间戳(1590065877s)
125
165
  */
126
- MainVideoRightAlign?: number;
166
+ Time: number;
127
167
  /**
128
- * 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。
168
+ * 当前时间返回参数取值,如(bigvCapFps在1590065877取值为0,则Value:0 )
129
169
  */
130
- MixVideoUids?: Array<string>;
170
+ Value: number;
171
+ }
172
+ /**
173
+ * StartMCUMixTranscodeByStrRoomId请求参数结构体
174
+ */
175
+ export interface StartMCUMixTranscodeByStrRoomIdRequest {
131
176
  /**
132
- * 自定义模板中有效,指定用户视频在混合画面中的位置。
177
+ * TRTC的SDKAppId。
133
178
  */
134
- PresetLayoutConfig?: Array<PresetLayoutConfig>;
179
+ SdkAppId: number;
135
180
  /**
136
- * 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
181
+ * 字符串房间号。
137
182
  */
138
- PlaceHolderMode?: number;
183
+ StrRoomId: string;
139
184
  /**
140
- * 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
185
+ * 混流输出控制参数。
141
186
  */
142
- PureAudioHoldPlaceMode?: number;
187
+ OutputParams: OutputParams;
143
188
  /**
144
- * 水印参数。
189
+ * 混流输出编码参数。
145
190
  */
146
- WaterMarkParams?: WaterMarkParams;
147
- }
148
- /**
149
- * 返回的质量数据,时间:值
150
- */
151
- export interface TimeValue {
191
+ EncodeParams: EncodeParams;
152
192
  /**
153
- * 时间,unix时间戳(1590065877s)
193
+ * 混流输出布局参数。
154
194
  */
155
- Time: number;
195
+ LayoutParams: LayoutParams;
156
196
  /**
157
- * 当前时间返回参数取值,如(bigvCapFps在1590065877取值为0,则Value:0 )
197
+ * 第三方CDN转推参数。
158
198
  */
159
- Value: number;
199
+ PublishCdnParams?: PublishCdnParams;
160
200
  }
161
201
  /**
162
202
  * CreatePicture请求参数结构体
@@ -235,6 +275,88 @@ export interface RemoveUserByStrRoomIdRequest {
235
275
  */
236
276
  UserIds: Array<string>;
237
277
  }
278
+ /**
279
+ * 指定订阅流白名单或者黑名单,音频的白名单和音频黑名单不能同时设置,视频亦然。同时实际并发订阅的媒体流路数最大支持25路流,混流场景下视频的多画面最大支持24画面。
280
+ */
281
+ export interface SubscribeStreamUserIds {
282
+ /**
283
+ * 订阅音频流白名单,指定订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的音频流,默认不填订阅房间内所有的音频流,订阅列表用户数不超过32。
284
+ */
285
+ SubscribeAudioUserIds?: Array<string>;
286
+ /**
287
+ * 订阅音频流黑名单,指定不订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的音频流,默认不填订阅房间内所有音频流,订阅列表用户数不超过32。
288
+ */
289
+ UnSubscribeAudioUserIds?: Array<string>;
290
+ /**
291
+ * 订阅视频流白名单,指定订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的视频流,默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
292
+ */
293
+ SubscribeVideoUserIds?: Array<string>;
294
+ /**
295
+ * 订阅视频流黑名单,指定不订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的视频流,默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
296
+ */
297
+ UnSubscribeVideoUserIds?: Array<string>;
298
+ }
299
+ /**
300
+ * 录制的混流布局参数。
301
+
302
+ */
303
+ export interface MixLayoutParams {
304
+ /**
305
+ * 布局模式:
306
+ 1:悬浮布局;
307
+ 2:屏幕分享布局;
308
+ 3:九宫格布局(默认);
309
+ 4:自定义布局;
310
+
311
+ 悬浮布局:默认第一个进入房间的主播(也可以指定一个主播)的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列,显示为小画面,小画面悬浮于大画面之上。当画面数量小于等于17个时,每行4个(4 x 4排列)。当画面数量大于17个时,重新布局小画面为每行5个(5 x 5)排列。最多支持25个画面,如果用户只发送音频,仍然会占用画面位置。
312
+
313
+ 屏幕分享布局:指定一个主播在屏幕左侧的大画面位置(如果不指定,那么大画面位置为背景色),其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候,右侧每列最多8人,最多占据两列。当画面数量多于17个的时候,超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面,如果主播只发送音频,仍然会占用画面位置。
314
+
315
+ 九宫格布局:根据主播的数量自动调整每个画面的大小,每个主播的画面大小一致,最多支持25个画面。
316
+
317
+ 自定义布局:根据需要在MixLayoutList内定制每个主播画面的布局。
318
+ */
319
+ MixLayoutMode: number;
320
+ /**
321
+ * 如果MixLayoutMode 选择为4自定义布局模式的话,设置此参数为每个主播所对应的布局画面的详细信息,最大不超过25个。
322
+ */
323
+ MixLayoutList?: Array<MixLayout>;
324
+ /**
325
+ * 录制背景颜色,RGB的颜色表的16进制表示,每个颜色通过8bit长度标识,默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500,格式规范:‘#‘开头,后面跟固定RGB的颜色值
326
+ */
327
+ BackGroundColor?: string;
328
+ /**
329
+ * 在布局模式为1:悬浮布局和 2:屏幕分享布局时,设定为显示大视频画面的UserId。不填的话:悬浮布局默认是第一个进房间的主播,屏幕分享布局默认是背景色
330
+ */
331
+ MaxResolutionUserId?: string;
332
+ /**
333
+ * 主辅路标识,
334
+ 0:主流(默认);
335
+ 1:辅流(屏幕分享);
336
+ 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路,MixLayoutList内代表的是自定义用户的主辅路。
337
+ */
338
+ MediaId?: number;
339
+ /**
340
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M。
341
+ */
342
+ BackgroundImageUrl?: string;
343
+ /**
344
+ * 设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
345
+ */
346
+ PlaceHolderMode?: number;
347
+ /**
348
+ * 背景画面宽高比不一致的时候处理方案,与MixLayoufList定义的RenderMode一致。
349
+ */
350
+ BackgroundImageRenderMode?: number;
351
+ /**
352
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。
353
+ */
354
+ DefaultSubBackgroundImage?: string;
355
+ /**
356
+ * 水印布局参数, 最多支持25个。
357
+ */
358
+ WaterMarkList?: Array<WaterMark>;
359
+ }
238
360
  /**
239
361
  * DismissRoom返回参数结构体
240
362
  */
@@ -399,22 +521,26 @@ export interface ScaleInfomation {
399
521
  RoomNumbers: number;
400
522
  }
401
523
  /**
402
- * DescribeUserInformation返回参数结构体
524
+ * 第三方存储参数。
403
525
  */
404
- export interface DescribeUserInformationResponse {
526
+ export interface StorageParams {
405
527
  /**
406
- * 返回的用户总条数
528
+ * 第三方云存储的账号信息。
407
529
  */
408
- Total: number;
530
+ CloudStorage?: CloudStorage;
409
531
  /**
410
- * 用户信息列表
411
- 注意:此字段可能返回 null,表示取不到有效值。
412
- */
413
- UserList: Array<UserInformation>;
532
+ * 第三方云点播的账号信息。
533
+ */
534
+ CloudVod?: CloudVod;
535
+ }
536
+ /**
537
+ * 点播相关参数。
538
+ */
539
+ export interface CloudVod {
414
540
  /**
415
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
541
+ * 腾讯云点播相关参数。
416
542
  */
417
- RequestId?: string;
543
+ TencentVod?: TencentVod;
418
544
  }
419
545
  /**
420
546
  * MCU混流输出流编码参数
@@ -477,13 +603,33 @@ export interface EncodeParams {
477
603
  BackgroundImageUrl?: string;
478
604
  }
479
605
  /**
480
- * RemoveUserByStrRoomId返回参数结构体
606
+ * ModifyPicture请求参数结构体
481
607
  */
482
- export interface RemoveUserByStrRoomIdResponse {
608
+ export interface ModifyPictureRequest {
483
609
  /**
484
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
610
+ * 图片id
485
611
  */
486
- RequestId?: string;
612
+ PictureId: number;
613
+ /**
614
+ * 应用id
615
+ */
616
+ SdkAppId: number;
617
+ /**
618
+ * 图片长度
619
+ */
620
+ Height?: number;
621
+ /**
622
+ * 图片宽度
623
+ */
624
+ Width?: number;
625
+ /**
626
+ * 显示位置x轴方向
627
+ */
628
+ XPosition?: number;
629
+ /**
630
+ * 显示位置y轴方向
631
+ */
632
+ YPosition?: number;
487
633
  }
488
634
  /**
489
635
  * StartMCUMixTranscode请求参数结构体
@@ -514,6 +660,83 @@ export interface StartMCUMixTranscodeRequest {
514
660
  */
515
661
  PublishCdnParams?: PublishCdnParams;
516
662
  }
663
+ /**
664
+ * DescribeCloudRecording请求参数结构体
665
+ */
666
+ export interface DescribeCloudRecordingRequest {
667
+ /**
668
+ * TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
669
+ */
670
+ SdkAppId: number;
671
+ /**
672
+ * 录制任务的唯一Id,在启动录制成功后会返回。
673
+ */
674
+ TaskId: string;
675
+ }
676
+ /**
677
+ * 腾讯云点播相关参数。
678
+ */
679
+ export interface TencentVod {
680
+ /**
681
+ * 媒体后续任务处理操作,即完成媒体上传后,可自动发起任务流操作。参数值为任务流模板名,云点播支持 创建任务流模板 并为模板命名。
682
+ */
683
+ Procedure?: string;
684
+ /**
685
+ * 媒体文件过期时间,为当前时间的绝对过期时间;保存一天,就填"86400",永久保存就填"0",默认永久保存。
686
+ */
687
+ ExpireTime?: number;
688
+ /**
689
+ * 指定上传园区,仅适用于对上传地域有特殊需求的用户。
690
+ */
691
+ StorageRegion?: string;
692
+ /**
693
+ * 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
694
+ 默认值:0,表示其他分类。
695
+ */
696
+ ClassId?: number;
697
+ /**
698
+ * 点播 子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
699
+ */
700
+ SubAppId?: number;
701
+ /**
702
+ * 任务流上下文,任务完成回调时透传。
703
+ */
704
+ SessionContext?: string;
705
+ /**
706
+ * 上传上下文,上传完成回调时透传。
707
+ */
708
+ SourceContext?: string;
709
+ }
710
+ /**
711
+ * 云端录制控制参数。
712
+ */
713
+ export interface RecordParams {
714
+ /**
715
+ * 录制模式:
716
+ 1:单流录制,分别录制房间的订阅UserId的音频和视频,将录制文件(M3U8/TS)上传至云存储;
717
+ 2:混流录制,将房间内订阅UserId的音视频混录成一个音视频文件,将录制文件[M3U8/TS]上传至云存储;
718
+ */
719
+ RecordMode: number;
720
+ /**
721
+ * 房间内持续没有主播的状态超过MaxIdleTime的时长,自动停止录制,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。
722
+ */
723
+ MaxIdleTime?: number;
724
+ /**
725
+ * 录制的媒体流类型:
726
+ 0:录制音频+视频流(默认);
727
+ 1:仅录制音频流;
728
+ 2:仅录制视频流,
729
+ */
730
+ StreamType?: number;
731
+ /**
732
+ * 指定订阅流白名单或者黑名单。
733
+ */
734
+ SubscribeStreamUserIds?: SubscribeStreamUserIds;
735
+ /**
736
+ * 输出文件的格式。0:(默认)输出文件为hls格式。1:输出文件格式为hls+mp4(hls录制完成后转mp4文件)
737
+ */
738
+ OutputFormat?: number;
739
+ }
517
740
  /**
518
741
  * StopMCUMixTranscode请求参数结构体
519
742
  */
@@ -564,6 +787,59 @@ export interface UserInformation {
564
787
  */
565
788
  Finished: boolean;
566
789
  }
790
+ /**
791
+ * 用户自定义混流布局参数列表。
792
+ */
793
+ export interface MixLayout {
794
+ /**
795
+ * 画布上该画面左上角的 y 轴坐标,取值范围 [0, 1920],不能超过画布的高。
796
+ */
797
+ Top: number;
798
+ /**
799
+ * 画布上该画面左上角的 x 轴坐标,取值范围 [0, 1920],不能超过画布的宽。
800
+ */
801
+ Left: number;
802
+ /**
803
+ * 画布上该画面宽度的相对值,取值范围 [0, 1920],与Left相加不应超过画布的宽。
804
+ */
805
+ Width: number;
806
+ /**
807
+ * 画布上该画面高度的相对值,取值范围 [0, 1920],与Top相加不应超过画布的高。
808
+ */
809
+ Height: number;
810
+ /**
811
+ * 字符串内容为待显示在该画面的主播对应的UserId,如果不指定,会按照主播加入房间的顺序匹配。
812
+ */
813
+ UserId?: string;
814
+ /**
815
+ * 画布的透明度值,取值范围[0, 255]。0表示不透明,255表示全透明。默认值为0。
816
+ */
817
+ Alpha?: number;
818
+ /**
819
+ * 0 :拉伸模式,这个模式下整个视频内容会全部显示,并填满子画面,在源视频和目的视频宽高比不一致的时候,画面不会缺少内容,但是画面可能产生形变;
820
+
821
+ 1 :剪裁模式(默认),这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸,并填满子画面画布,在源视频和目的视频宽高比不一致的时候,画面保持不变形,但是会被剪裁;
822
+
823
+ 2 :填黑模式,这个模式下会严格保持源视频的宽高比进行等比缩放,在源视频和目的视频宽高比不一致的时候,画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景;
824
+
825
+ 3 :智能拉伸模式,这个模式类似剪裁模式,区别是在源视频和目的视频宽高比不一致的时候,限制了最大剪裁比例为画面的宽度或者高度的20%;
826
+ */
827
+ RenderMode?: number;
828
+ /**
829
+ * 对应订阅流的主辅路标识:
830
+ 0:主流(默认);
831
+ 1:辅流;
832
+ */
833
+ MediaId?: number;
834
+ /**
835
+ * 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。
836
+ */
837
+ ImageLayer?: number;
838
+ /**
839
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。
840
+ */
841
+ SubBackgroundImage?: string;
842
+ }
567
843
  /**
568
844
  * DescribeHistoryScale请求参数结构体
569
845
  */
@@ -586,13 +862,58 @@ export interface DescribeHistoryScaleRequest {
586
862
  */
587
863
  export interface DeletePictureRequest {
588
864
  /**
589
- * 图片id
865
+ * 图片id
866
+ */
867
+ PictureId: number;
868
+ /**
869
+ * 应用id
870
+ */
871
+ SdkAppId: number;
872
+ }
873
+ /**
874
+ * MCU混流布局参数
875
+ */
876
+ export interface LayoutParams {
877
+ /**
878
+ * 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
879
+ */
880
+ Template?: number;
881
+ /**
882
+ * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
883
+ */
884
+ MainVideoUserId?: string;
885
+ /**
886
+ * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
887
+ */
888
+ MainVideoStreamType?: number;
889
+ /**
890
+ * 画中画模板中有效,代表小画面的布局参数。
891
+ */
892
+ SmallVideoLayoutParams?: SmallVideoLayoutParams;
893
+ /**
894
+ * 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
895
+ */
896
+ MainVideoRightAlign?: number;
897
+ /**
898
+ * 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。
899
+ */
900
+ MixVideoUids?: Array<string>;
901
+ /**
902
+ * 自定义模板中有效,指定用户视频在混合画面中的位置。
903
+ */
904
+ PresetLayoutConfig?: Array<PresetLayoutConfig>;
905
+ /**
906
+ * 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
907
+ */
908
+ PlaceHolderMode?: number;
909
+ /**
910
+ * 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
590
911
  */
591
- PictureId: number;
912
+ PureAudioHoldPlaceMode?: number;
592
913
  /**
593
- * 应用id
914
+ * 水印参数。
594
915
  */
595
- SdkAppId: number;
916
+ WaterMarkParams?: WaterMarkParams;
596
917
  }
597
918
  /**
598
919
  * DescribeRoomInformation返回参数结构体
@@ -637,21 +958,55 @@ export interface RecordUsage {
637
958
  AudioTime: number;
638
959
  }
639
960
  /**
640
- * RemoveUser请求参数结构体
961
+ * CreateCloudRecording请求参数结构体
641
962
  */
642
- export interface RemoveUserRequest {
963
+ export interface CreateCloudRecordingRequest {
643
964
  /**
644
- * TRTC的SDKAppId。
965
+ * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。
645
966
  */
646
967
  SdkAppId: number;
647
968
  /**
648
- * 房间号。
969
+ * TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。
649
970
  */
650
- RoomId: number;
971
+ RoomId: string;
651
972
  /**
652
- * 要移出的用户列表,最多10个。
973
+ * 录制服务在TRTC房间使用的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者录制服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。
653
974
  */
654
- UserIds: Array<string>;
975
+ UserId: string;
976
+ /**
977
+ * 云端录制加入房间的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
978
+ */
979
+ UserSig: string;
980
+ /**
981
+ * 云端录制控制参数。
982
+ */
983
+ RecordParams: RecordParams;
984
+ /**
985
+ * 云端录制文件上传到云存储的参数。
986
+ */
987
+ StorageParams: StorageParams;
988
+ /**
989
+ * TRTC房间号的类型,必须和录制的房间所对应的RoomId类型相同:
990
+ 0: 字符串类型的RoomId
991
+ 1: 32位整型的RoomId(默认)
992
+ */
993
+ RoomIdType?: number;
994
+ /**
995
+ * 混流的转码参数,录制模式为混流的时候可以设置。
996
+ */
997
+ MixTranscodeParams?: MixTranscodeParams;
998
+ /**
999
+ * 混流的布局参数,录制模式为混流的时候可以设置。
1000
+ */
1001
+ MixLayoutParams?: MixLayoutParams;
1002
+ /**
1003
+ * 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。
1004
+ */
1005
+ ResourceExpiredHour?: number;
1006
+ /**
1007
+ * TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey](https://cloud.tencent.com/document/product/647/32240) 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。
1008
+ */
1009
+ PrivateMapKey?: string;
655
1010
  }
656
1011
  /**
657
1012
  * MCU混流的输出参数
@@ -675,33 +1030,43 @@ export interface OutputParams {
675
1030
  RecordAudioOnly?: number;
676
1031
  }
677
1032
  /**
678
- * ModifyPicture请求参数结构体
1033
+ * 水印布局参数
679
1034
  */
680
- export interface ModifyPictureRequest {
1035
+ export interface WaterMark {
681
1036
  /**
682
- * 图片id
1037
+ * 水印类型,0为图片(默认),1为文字(暂不支持)。
683
1038
  */
684
- PictureId: number;
1039
+ WaterMarkType?: number;
685
1040
  /**
686
- * 应用id
1041
+ * 水印为图片时的参数列表,水印为图片时校验必填。
687
1042
  */
688
- SdkAppId: number;
1043
+ WaterMarkImage?: WaterMarkImage;
1044
+ }
1045
+ /**
1046
+ * DeleteCloudRecording返回参数结构体
1047
+ */
1048
+ export interface DeleteCloudRecordingResponse {
689
1049
  /**
690
- * 图片长度
1050
+ * 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。
691
1051
  */
692
- Height?: number;
1052
+ TaskId: string;
693
1053
  /**
694
- * 图片宽度
1054
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
695
1055
  */
696
- Width?: number;
1056
+ RequestId?: string;
1057
+ }
1058
+ /**
1059
+ * 录制的音视频转码参数。
1060
+ */
1061
+ export interface MixTranscodeParams {
697
1062
  /**
698
- * 显示位置x轴方向
1063
+ * 录制视频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。
699
1064
  */
700
- XPosition?: number;
1065
+ VideoParams?: VideoParams;
701
1066
  /**
702
- * 显示位置y轴方向
1067
+ * 录制音频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。
703
1068
  */
704
- YPosition?: number;
1069
+ AudioParams?: AudioParams;
705
1070
  }
706
1071
  /**
707
1072
  * CreateTroubleInfo返回参数结构体
@@ -761,6 +1126,15 @@ export interface AbnormalEvent {
761
1126
  */
762
1127
  PeerId: string;
763
1128
  }
1129
+ /**
1130
+ * RemoveUserByStrRoomId返回参数结构体
1131
+ */
1132
+ export interface RemoveUserByStrRoomIdResponse {
1133
+ /**
1134
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1135
+ */
1136
+ RequestId?: string;
1137
+ }
764
1138
  /**
765
1139
  * StopMCUMixTranscodeByStrRoomId返回参数结构体
766
1140
  */
@@ -779,6 +1153,27 @@ export interface DeletePictureResponse {
779
1153
  */
780
1154
  RequestId?: string;
781
1155
  }
1156
+ /**
1157
+ * ModifyCloudRecording请求参数结构体
1158
+ */
1159
+ export interface ModifyCloudRecordingRequest {
1160
+ /**
1161
+ * TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
1162
+ */
1163
+ SdkAppId: number;
1164
+ /**
1165
+ * 录制任务的唯一Id,在启动录制成功后会返回。
1166
+ */
1167
+ TaskId: string;
1168
+ /**
1169
+ * 需要更新的混流的布局参数。
1170
+ */
1171
+ MixLayoutParams?: MixLayoutParams;
1172
+ /**
1173
+ * 指定订阅流白名单或者黑名单。
1174
+ */
1175
+ SubscribeStreamUserIds?: SubscribeStreamUserIds;
1176
+ }
782
1177
  /**
783
1178
  * CreateTroubleInfo请求参数结构体
784
1179
  */
@@ -838,17 +1233,77 @@ export interface EventList {
838
1233
  PeerId: string;
839
1234
  }
840
1235
  /**
841
- * DismissRoom请求参数结构体
1236
+ * 云端录制查询接口,录制文件的信息
842
1237
  */
843
- export interface DismissRoomRequest {
1238
+ export interface StorageFile {
844
1239
  /**
845
- * TRTC的SDKAppId。
1240
+ * 录制文件对应的UserId,如果是混流的话的这里返回的是空串。
1241
+ 注意:此字段可能返回 null,表示取不到有效值。
1242
+ */
1243
+ UserId: string;
1244
+ /**
1245
+ * 录制索引文件名。
1246
+ */
1247
+ FileName: string;
1248
+ /**
1249
+ * 录制文件流信息。
1250
+ video:视频录制文件
1251
+ audio:音频录制文件
1252
+ audio_video:音视频录制文件
1253
+ 注意:此字段可能返回 null,表示取不到有效值。
1254
+ */
1255
+ TrackType: string;
1256
+ /**
1257
+ * 录制文件开始Unix时间戳。
1258
+ */
1259
+ BeginTimeStamp: number;
1260
+ }
1261
+ /**
1262
+ * 图片列表信息
1263
+ */
1264
+ export interface PictureInfo {
1265
+ /**
1266
+ * 图片长度
1267
+ */
1268
+ Height: number;
1269
+ /**
1270
+ * 图片宽度
1271
+ */
1272
+ Width: number;
1273
+ /**
1274
+ * 显示位置x轴方向
1275
+ */
1276
+ XPosition: number;
1277
+ /**
1278
+ * 显示位置y轴方向
1279
+ */
1280
+ YPosition: number;
1281
+ /**
1282
+ * 应用id
846
1283
  */
847
1284
  SdkAppId: number;
848
1285
  /**
849
- * 房间号。
1286
+ * 图片id
850
1287
  */
851
- RoomId: number;
1288
+ PictureId: number;
1289
+ }
1290
+ /**
1291
+ * DescribeUserInformation返回参数结构体
1292
+ */
1293
+ export interface DescribeUserInformationResponse {
1294
+ /**
1295
+ * 返回的用户总条数
1296
+ */
1297
+ Total: number;
1298
+ /**
1299
+ * 用户信息列表
1300
+ 注意:此字段可能返回 null,表示取不到有效值。
1301
+ */
1302
+ UserList: Array<UserInformation>;
1303
+ /**
1304
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1305
+ */
1306
+ RequestId?: string;
852
1307
  }
853
1308
  /**
854
1309
  * DescribeDetailEvent返回参数结构体
@@ -864,22 +1319,36 @@ export interface DescribeDetailEventResponse {
864
1319
  RequestId?: string;
865
1320
  }
866
1321
  /**
867
- * DismissRoomByStrRoomId请求参数结构体
1322
+ * CreateCloudRecording返回参数结构体
868
1323
  */
869
- export interface DismissRoomByStrRoomIdRequest {
1324
+ export interface CreateCloudRecordingResponse {
870
1325
  /**
871
- * TRTC的SDKAppId。
1326
+ * 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。任务 ID需要业务保存下来,作为下次针对这个录制任务操作的参数。
872
1327
  */
873
- SdkAppId: number;
1328
+ TaskId: string;
874
1329
  /**
875
- * 房间号。
1330
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
876
1331
  */
877
- RoomId: string;
1332
+ RequestId?: string;
878
1333
  }
879
1334
  /**
880
- * StartMCUMixTranscode返回参数结构体
1335
+ * DescribeCallDetail返回参数结构体
881
1336
  */
882
- export interface StartMCUMixTranscodeResponse {
1337
+ export interface DescribeCallDetailResponse {
1338
+ /**
1339
+ * 返回的用户总条数
1340
+ */
1341
+ Total: number;
1342
+ /**
1343
+ * 用户信息列表
1344
+ 注意:此字段可能返回 null,表示取不到有效值。
1345
+ */
1346
+ UserList: Array<UserInformation>;
1347
+ /**
1348
+ * 质量数据
1349
+ 注意:此字段可能返回 null,表示取不到有效值。
1350
+ */
1351
+ Data: Array<QualityData>;
883
1352
  /**
884
1353
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
885
1354
  */
@@ -915,6 +1384,19 @@ export interface DescribeTrtcMcuTranscodeTimeResponse {
915
1384
  */
916
1385
  RequestId?: string;
917
1386
  }
1387
+ /**
1388
+ * DeleteCloudRecording请求参数结构体
1389
+ */
1390
+ export interface DeleteCloudRecordingRequest {
1391
+ /**
1392
+ * TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
1393
+ */
1394
+ SdkAppId: number;
1395
+ /**
1396
+ * 录制任务的唯一Id,在启动录制成功后会返回。
1397
+ */
1398
+ TaskId: string;
1399
+ }
918
1400
  /**
919
1401
  * DescribePicture请求参数结构体
920
1402
  */
@@ -1028,32 +1510,56 @@ export interface PresetLayoutConfig {
1028
1510
  */
1029
1511
  MixInputType?: number;
1030
1512
  /**
1031
- * 占位图ID。启用占位图功能时,在当前位置的用户没有上行视频时显示占位图。占位图在实时音视频控制台上传并生成,https://cloud.tencent.com/document/product/647/50769
1513
+ * 占位图ID。启用占位图功能时,在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M,在实时音视频控制台上传并生成,https://cloud.tencent.com/document/product/647/50769
1032
1514
  */
1033
1515
  PlaceImageId?: number;
1034
1516
  }
1035
1517
  /**
1036
- * DescribeCallDetail返回参数结构体
1518
+ * 录制视频转码参数。
1037
1519
  */
1038
- export interface DescribeCallDetailResponse {
1520
+ export interface VideoParams {
1039
1521
  /**
1040
- * 返回的用户总条数
1522
+ * 视频的宽度值,单位为像素,默认值360。不能超过1920,与height的乘积不能超过1920*1080。
1041
1523
  */
1042
- Total: number;
1524
+ Width: number;
1043
1525
  /**
1044
- * 用户信息列表
1045
- 注意:此字段可能返回 null,表示取不到有效值。
1526
+ * 视频的高度值,单位为像素,默认值640。不能超过1920,与width的乘积不能超过1920*1080。
1527
+ */
1528
+ Height: number;
1529
+ /**
1530
+ * 视频的帧率,范围[1, 60],默认15。
1531
+ */
1532
+ Fps: number;
1533
+ /**
1534
+ * 视频的码率,单位是bps,范围[64000, 8192000],默认550000bps。
1535
+ */
1536
+ BitRate: number;
1537
+ /**
1538
+ * 视频关键帧时间间隔,单位秒,默认值10秒。
1539
+ */
1540
+ Gop: number;
1541
+ }
1542
+ /**
1543
+ * 录制音频转码参数。
1544
+ */
1545
+ export interface AudioParams {
1546
+ /**
1547
+ * 音频采样率:
1548
+ 1:48000Hz(默认);
1549
+ 2:44100Hz
1550
+ 3:16000Hz。
1046
1551
  */
1047
- UserList: Array<UserInformation>;
1552
+ SampleRate: number;
1048
1553
  /**
1049
- * 质量数据
1050
- 注意:此字段可能返回 null,表示取不到有效值。
1554
+ * 声道数:
1555
+ 1:单身道;
1556
+ 2:双声道(默认)。
1051
1557
  */
1052
- Data: Array<QualityData>;
1558
+ Channel: number;
1053
1559
  /**
1054
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
1560
+ * 音频码率: 取值范围[32000, 128000] ,单位bps,默认64000bps
1055
1561
  */
1056
- RequestId?: string;
1562
+ BitRate: number;
1057
1563
  }
1058
1564
  /**
1059
1565
  * DescribePicture返回参数结构体
@@ -1072,6 +1578,44 @@ export interface DescribePictureResponse {
1072
1578
  */
1073
1579
  RequestId?: string;
1074
1580
  }
1581
+ /**
1582
+ * 水印类型为图片的参数列表
1583
+ */
1584
+ export interface WaterMarkImage {
1585
+ /**
1586
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M。
1587
+ */
1588
+ WaterMarkUrl: string;
1589
+ /**
1590
+ * 画布上该画面左上角的 y 轴坐标,取值范围 [0, 2560],不能超过画布的高。
1591
+ */
1592
+ Top: number;
1593
+ /**
1594
+ * 画布上该画面左上角的 x 轴坐标,取值范围 [0, 2560],不能超过画布的宽。
1595
+ */
1596
+ Left: number;
1597
+ /**
1598
+ * 画布上该画面宽度的相对值,取值范围 [0, 2560],与Left相加不应超过画布的宽。
1599
+ */
1600
+ Width: number;
1601
+ /**
1602
+ * 画布上该画面高度的相对值,取值范围 [0, 2560],与Top相加不应超过画布的高。
1603
+ */
1604
+ Height: number;
1605
+ }
1606
+ /**
1607
+ * DismissRoom请求参数结构体
1608
+ */
1609
+ export interface DismissRoomRequest {
1610
+ /**
1611
+ * TRTC的SDKAppId。
1612
+ */
1613
+ SdkAppId: number;
1614
+ /**
1615
+ * 房间号。
1616
+ */
1617
+ RoomId: number;
1618
+ }
1075
1619
  /**
1076
1620
  * 第三方CDN转推参数
1077
1621
  */
@@ -1164,6 +1708,15 @@ export interface AbnormalExperience {
1164
1708
  */
1165
1709
  EventTime: number;
1166
1710
  }
1711
+ /**
1712
+ * StartMCUMixTranscode返回参数结构体
1713
+ */
1714
+ export interface StartMCUMixTranscodeResponse {
1715
+ /**
1716
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1717
+ */
1718
+ RequestId?: string;
1719
+ }
1167
1720
  /**
1168
1721
  * 房间信息列表
1169
1722
  */
@@ -1215,19 +1768,19 @@ export interface WaterMarkParams {
1215
1768
  */
1216
1769
  WaterMarkId: number;
1217
1770
  /**
1218
- * 混流-水印宽。单位为像素值。
1771
+ * 混流-水印宽。单位为像素值。水印宽+X偏移不能超过整个画布宽。
1219
1772
  */
1220
1773
  WaterMarkWidth: number;
1221
1774
  /**
1222
- * 混流-水印高。单位为像素值。
1775
+ * 混流-水印高。单位为像素值。水印高+Y偏移不能超过整个画布高。
1223
1776
  */
1224
1777
  WaterMarkHeight: number;
1225
1778
  /**
1226
- * 水印在输出时的X偏移。单位为像素值。
1779
+ * 水印在输出时的X偏移。单位为像素值。水印宽+X偏移不能超过整个画布宽。
1227
1780
  */
1228
1781
  LocationX: number;
1229
1782
  /**
1230
- * 水印在输出时的Y偏移。单位为像素值。
1783
+ * 水印在输出时的Y偏移。单位为像素值。水印高+Y偏移不能超过整个画布高。
1231
1784
  */
1232
1785
  LocationY: number;
1233
1786
  /**
@@ -1285,31 +1838,15 @@ export interface StartMCUMixTranscodeByStrRoomIdResponse {
1285
1838
  RequestId?: string;
1286
1839
  }
1287
1840
  /**
1288
- * 图片列表信息
1841
+ * ModifyCloudRecording返回参数结构体
1289
1842
  */
1290
- export interface PictureInfo {
1291
- /**
1292
- * 图片长度
1293
- */
1294
- Height: number;
1295
- /**
1296
- * 图片宽度
1297
- */
1298
- Width: number;
1299
- /**
1300
- * 显示位置x轴方向
1301
- */
1302
- XPosition: number;
1303
- /**
1304
- * 显示位置y轴方向
1305
- */
1306
- YPosition: number;
1843
+ export interface ModifyCloudRecordingResponse {
1307
1844
  /**
1308
- * 应用id
1845
+ * 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。
1309
1846
  */
1310
- SdkAppId: number;
1847
+ TaskId: string;
1311
1848
  /**
1312
- * 图片id
1849
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1313
1850
  */
1314
- PictureId: number;
1851
+ RequestId?: string;
1315
1852
  }