tencentcloud-sdk-nodejs-trtc 4.0.340 → 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.
@@ -15,6 +15,21 @@
15
15
  * under the License.
16
16
  */
17
17
 
18
+ /**
19
+ * DismissRoomByStrRoomId请求参数结构体
20
+ */
21
+ export interface DismissRoomByStrRoomIdRequest {
22
+ /**
23
+ * TRTC的SDKAppId。
24
+ */
25
+ SdkAppId: number
26
+
27
+ /**
28
+ * 房间号。
29
+ */
30
+ RoomId: string
31
+ }
32
+
18
33
  /**
19
34
  * DescribeAbnormalEvent返回参数结构体
20
35
  */
@@ -35,6 +50,42 @@ export interface DescribeAbnormalEventResponse {
35
50
  RequestId?: string
36
51
  }
37
52
 
53
+ /**
54
+ * 第三方云存储的账号信息。
55
+ */
56
+ export interface CloudStorage {
57
+ /**
58
+ * 第三方云储存的供应商:
59
+ 0:腾讯云存储 COS,暂不支持其他家。
60
+ */
61
+ Vendor: number
62
+
63
+ /**
64
+ * 第三方云存储的地域信息。
65
+ */
66
+ Region: string
67
+
68
+ /**
69
+ * 第三方存储桶信息。
70
+ */
71
+ Bucket: string
72
+
73
+ /**
74
+ * 第三方存储的access_key账号信息。
75
+ */
76
+ AccessKey: string
77
+
78
+ /**
79
+ * 第三方存储的secret_key账号信息。
80
+ */
81
+ SecretKey: string
82
+
83
+ /**
84
+ * 第三方云存储bucket 的指定位置,由字符串数组组成。合法的字符串范围a~z,A~Z,0~9,举个例子,录制文件xxx.m3u8在 ["prefix1", "prefix2"]作用下,会变成prefix1/prefix2/TaskId/xxx.m3u8。
85
+ */
86
+ FileNamePrefix?: Array<string>
87
+ }
88
+
38
89
  /**
39
90
  * DescribeAbnormalEvent请求参数结构体
40
91
  */
@@ -102,108 +153,102 @@ export interface ModifyPictureResponse {
102
153
  }
103
154
 
104
155
  /**
105
- * StartMCUMixTranscodeByStrRoomId请求参数结构体
156
+ * RemoveUser请求参数结构体
106
157
  */
107
- export interface StartMCUMixTranscodeByStrRoomIdRequest {
158
+ export interface RemoveUserRequest {
108
159
  /**
109
160
  * TRTC的SDKAppId。
110
161
  */
111
162
  SdkAppId: number
112
163
 
113
164
  /**
114
- * 字符串房间号。
115
- */
116
- StrRoomId: string
117
-
118
- /**
119
- * 混流输出控制参数。
120
- */
121
- OutputParams: OutputParams
122
-
123
- /**
124
- * 混流输出编码参数。
125
- */
126
- EncodeParams: EncodeParams
127
-
128
- /**
129
- * 混流输出布局参数。
165
+ * 房间号。
130
166
  */
131
- LayoutParams: LayoutParams
167
+ RoomId: number
132
168
 
133
169
  /**
134
- * 第三方CDN转推参数。
170
+ * 要移出的用户列表,最多10个。
135
171
  */
136
- PublishCdnParams?: PublishCdnParams
172
+ UserIds: Array<string>
137
173
  }
138
174
 
139
175
  /**
140
- * MCU混流布局参数
176
+ * DescribeCloudRecording返回参数结构体
141
177
  */
142
- export interface LayoutParams {
178
+ export interface DescribeCloudRecordingResponse {
143
179
  /**
144
- * 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
180
+ * 录制任务的唯一Id。
145
181
  */
146
- Template?: number
182
+ TaskId: string
147
183
 
148
184
  /**
149
- * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
150
- */
151
- MainVideoUserId?: string
185
+ * 云端录制任务的状态信息。
186
+ Idle:表示当前录制任务空闲中
187
+ InProgress:表示当前录制任务正在进行中。
188
+ Exited:表示当前录制任务正在退出的过程中。
189
+ */
190
+ Status: string
152
191
 
153
192
  /**
154
- * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
155
- */
156
- MainVideoStreamType?: number
193
+ * 录制文件信息。
194
+ 注意:此字段可能返回 null,表示取不到有效值。
195
+ */
196
+ StorageFileList: Array<StorageFile>
157
197
 
158
198
  /**
159
- * 画中画模板中有效,代表小画面的布局参数。
199
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
160
200
  */
161
- SmallVideoLayoutParams?: SmallVideoLayoutParams
201
+ RequestId?: string
202
+ }
162
203
 
204
+ /**
205
+ * 返回的质量数据,时间:值
206
+ */
207
+ export interface TimeValue {
163
208
  /**
164
- * 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
209
+ * 时间,unix时间戳(1590065877s)
165
210
  */
166
- MainVideoRightAlign?: number
211
+ Time: number
167
212
 
168
213
  /**
169
- * 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。
214
+ * 当前时间返回参数取值,如(bigvCapFps在1590065877取值为0,则Value:0 )
170
215
  */
171
- MixVideoUids?: Array<string>
216
+ Value: number
217
+ }
172
218
 
219
+ /**
220
+ * StartMCUMixTranscodeByStrRoomId请求参数结构体
221
+ */
222
+ export interface StartMCUMixTranscodeByStrRoomIdRequest {
173
223
  /**
174
- * 自定义模板中有效,指定用户视频在混合画面中的位置。
224
+ * TRTC的SDKAppId。
175
225
  */
176
- PresetLayoutConfig?: Array<PresetLayoutConfig>
226
+ SdkAppId: number
177
227
 
178
228
  /**
179
- * 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
229
+ * 字符串房间号。
180
230
  */
181
- PlaceHolderMode?: number
231
+ StrRoomId: string
182
232
 
183
233
  /**
184
- * 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
234
+ * 混流输出控制参数。
185
235
  */
186
- PureAudioHoldPlaceMode?: number
236
+ OutputParams: OutputParams
187
237
 
188
238
  /**
189
- * 水印参数。
239
+ * 混流输出编码参数。
190
240
  */
191
- WaterMarkParams?: WaterMarkParams
192
- }
241
+ EncodeParams: EncodeParams
193
242
 
194
- /**
195
- * 返回的质量数据,时间:值
196
- */
197
- export interface TimeValue {
198
243
  /**
199
- * 时间,unix时间戳(1590065877s)
244
+ * 混流输出布局参数。
200
245
  */
201
- Time: number
246
+ LayoutParams: LayoutParams
202
247
 
203
248
  /**
204
- * 当前时间返回参数取值,如(bigvCapFps在1590065877取值为0,则Value:0 )
249
+ * 第三方CDN转推参数。
205
250
  */
206
- Value: number
251
+ PublishCdnParams?: PublishCdnParams
207
252
  }
208
253
 
209
254
  /**
@@ -297,6 +342,102 @@ export interface RemoveUserByStrRoomIdRequest {
297
342
  UserIds: Array<string>
298
343
  }
299
344
 
345
+ /**
346
+ * 指定订阅流白名单或者黑名单,音频的白名单和音频黑名单不能同时设置,视频亦然。同时实际并发订阅的媒体流路数最大支持25路流,混流场景下视频的多画面最大支持24画面。
347
+ */
348
+ export interface SubscribeStreamUserIds {
349
+ /**
350
+ * 订阅音频流白名单,指定订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的音频流,默认不填订阅房间内所有的音频流,订阅列表用户数不超过32。
351
+ */
352
+ SubscribeAudioUserIds?: Array<string>
353
+
354
+ /**
355
+ * 订阅音频流黑名单,指定不订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的音频流,默认不填订阅房间内所有音频流,订阅列表用户数不超过32。
356
+ */
357
+ UnSubscribeAudioUserIds?: Array<string>
358
+
359
+ /**
360
+ * 订阅视频流白名单,指定订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的视频流,默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
361
+ */
362
+ SubscribeVideoUserIds?: Array<string>
363
+
364
+ /**
365
+ * 订阅视频流黑名单,指定不订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的视频流,默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
366
+ */
367
+ UnSubscribeVideoUserIds?: Array<string>
368
+ }
369
+
370
+ /**
371
+ * 录制的混流布局参数。
372
+
373
+ */
374
+ export interface MixLayoutParams {
375
+ /**
376
+ * 布局模式:
377
+ 1:悬浮布局;
378
+ 2:屏幕分享布局;
379
+ 3:九宫格布局(默认);
380
+ 4:自定义布局;
381
+
382
+ 悬浮布局:默认第一个进入房间的主播(也可以指定一个主播)的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列,显示为小画面,小画面悬浮于大画面之上。当画面数量小于等于17个时,每行4个(4 x 4排列)。当画面数量大于17个时,重新布局小画面为每行5个(5 x 5)排列。最多支持25个画面,如果用户只发送音频,仍然会占用画面位置。
383
+
384
+ 屏幕分享布局:指定一个主播在屏幕左侧的大画面位置(如果不指定,那么大画面位置为背景色),其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候,右侧每列最多8人,最多占据两列。当画面数量多于17个的时候,超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面,如果主播只发送音频,仍然会占用画面位置。
385
+
386
+ 九宫格布局:根据主播的数量自动调整每个画面的大小,每个主播的画面大小一致,最多支持25个画面。
387
+
388
+ 自定义布局:根据需要在MixLayoutList内定制每个主播画面的布局。
389
+ */
390
+ MixLayoutMode: number
391
+
392
+ /**
393
+ * 如果MixLayoutMode 选择为4自定义布局模式的话,设置此参数为每个主播所对应的布局画面的详细信息,最大不超过25个。
394
+ */
395
+ MixLayoutList?: Array<MixLayout>
396
+
397
+ /**
398
+ * 录制背景颜色,RGB的颜色表的16进制表示,每个颜色通过8bit长度标识,默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500,格式规范:‘#‘开头,后面跟固定RGB的颜色值
399
+ */
400
+ BackGroundColor?: string
401
+
402
+ /**
403
+ * 在布局模式为1:悬浮布局和 2:屏幕分享布局时,设定为显示大视频画面的UserId。不填的话:悬浮布局默认是第一个进房间的主播,屏幕分享布局默认是背景色
404
+ */
405
+ MaxResolutionUserId?: string
406
+
407
+ /**
408
+ * 主辅路标识,
409
+ 0:主流(默认);
410
+ 1:辅流(屏幕分享);
411
+ 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路,MixLayoutList内代表的是自定义用户的主辅路。
412
+ */
413
+ MediaId?: number
414
+
415
+ /**
416
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M。
417
+ */
418
+ BackgroundImageUrl?: string
419
+
420
+ /**
421
+ * 设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
422
+ */
423
+ PlaceHolderMode?: number
424
+
425
+ /**
426
+ * 背景画面宽高比不一致的时候处理方案,与MixLayoufList定义的RenderMode一致。
427
+ */
428
+ BackgroundImageRenderMode?: number
429
+
430
+ /**
431
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。
432
+ */
433
+ DefaultSubBackgroundImage?: string
434
+
435
+ /**
436
+ * 水印布局参数, 最多支持25个。
437
+ */
438
+ WaterMarkList?: Array<WaterMark>
439
+ }
440
+
300
441
  /**
301
442
  * DismissRoom返回参数结构体
302
443
  */
@@ -489,24 +630,28 @@ export interface ScaleInfomation {
489
630
  }
490
631
 
491
632
  /**
492
- * DescribeUserInformation返回参数结构体
633
+ * 第三方存储参数。
493
634
  */
494
- export interface DescribeUserInformationResponse {
635
+ export interface StorageParams {
495
636
  /**
496
- * 返回的用户总条数
637
+ * 第三方云存储的账号信息。
497
638
  */
498
- Total: number
639
+ CloudStorage?: CloudStorage
499
640
 
500
641
  /**
501
- * 用户信息列表
502
- 注意:此字段可能返回 null,表示取不到有效值。
503
- */
504
- UserList: Array<UserInformation>
642
+ * 第三方云点播的账号信息。
643
+ */
644
+ CloudVod?: CloudVod
645
+ }
505
646
 
647
+ /**
648
+ * 点播相关参数。
649
+ */
650
+ export interface CloudVod {
506
651
  /**
507
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
652
+ * 腾讯云点播相关参数。
508
653
  */
509
- RequestId?: string
654
+ TencentVod?: TencentVod
510
655
  }
511
656
 
512
657
  /**
@@ -582,13 +727,38 @@ export interface EncodeParams {
582
727
  }
583
728
 
584
729
  /**
585
- * RemoveUserByStrRoomId返回参数结构体
730
+ * ModifyPicture请求参数结构体
586
731
  */
587
- export interface RemoveUserByStrRoomIdResponse {
732
+ export interface ModifyPictureRequest {
588
733
  /**
589
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
734
+ * 图片id
590
735
  */
591
- RequestId?: string
736
+ PictureId: number
737
+
738
+ /**
739
+ * 应用id
740
+ */
741
+ SdkAppId: number
742
+
743
+ /**
744
+ * 图片长度
745
+ */
746
+ Height?: number
747
+
748
+ /**
749
+ * 图片宽度
750
+ */
751
+ Width?: number
752
+
753
+ /**
754
+ * 显示位置x轴方向
755
+ */
756
+ XPosition?: number
757
+
758
+ /**
759
+ * 显示位置y轴方向
760
+ */
761
+ YPosition?: number
592
762
  }
593
763
 
594
764
  /**
@@ -626,6 +796,97 @@ export interface StartMCUMixTranscodeRequest {
626
796
  PublishCdnParams?: PublishCdnParams
627
797
  }
628
798
 
799
+ /**
800
+ * DescribeCloudRecording请求参数结构体
801
+ */
802
+ export interface DescribeCloudRecordingRequest {
803
+ /**
804
+ * TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
805
+ */
806
+ SdkAppId: number
807
+
808
+ /**
809
+ * 录制任务的唯一Id,在启动录制成功后会返回。
810
+ */
811
+ TaskId: string
812
+ }
813
+
814
+ /**
815
+ * 腾讯云点播相关参数。
816
+ */
817
+ export interface TencentVod {
818
+ /**
819
+ * 媒体后续任务处理操作,即完成媒体上传后,可自动发起任务流操作。参数值为任务流模板名,云点播支持 创建任务流模板 并为模板命名。
820
+ */
821
+ Procedure?: string
822
+
823
+ /**
824
+ * 媒体文件过期时间,为当前时间的绝对过期时间;保存一天,就填"86400",永久保存就填"0",默认永久保存。
825
+ */
826
+ ExpireTime?: number
827
+
828
+ /**
829
+ * 指定上传园区,仅适用于对上传地域有特殊需求的用户。
830
+ */
831
+ StorageRegion?: string
832
+
833
+ /**
834
+ * 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
835
+ 默认值:0,表示其他分类。
836
+ */
837
+ ClassId?: number
838
+
839
+ /**
840
+ * 点播 子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
841
+ */
842
+ SubAppId?: number
843
+
844
+ /**
845
+ * 任务流上下文,任务完成回调时透传。
846
+ */
847
+ SessionContext?: string
848
+
849
+ /**
850
+ * 上传上下文,上传完成回调时透传。
851
+ */
852
+ SourceContext?: string
853
+ }
854
+
855
+ /**
856
+ * 云端录制控制参数。
857
+ */
858
+ export interface RecordParams {
859
+ /**
860
+ * 录制模式:
861
+ 1:单流录制,分别录制房间的订阅UserId的音频和视频,将录制文件(M3U8/TS)上传至云存储;
862
+ 2:混流录制,将房间内订阅UserId的音视频混录成一个音视频文件,将录制文件[M3U8/TS]上传至云存储;
863
+ */
864
+ RecordMode: number
865
+
866
+ /**
867
+ * 房间内持续没有主播的状态超过MaxIdleTime的时长,自动停止录制,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。
868
+ */
869
+ MaxIdleTime?: number
870
+
871
+ /**
872
+ * 录制的媒体流类型:
873
+ 0:录制音频+视频流(默认);
874
+ 1:仅录制音频流;
875
+ 2:仅录制视频流,
876
+ */
877
+ StreamType?: number
878
+
879
+ /**
880
+ * 指定订阅流白名单或者黑名单。
881
+ */
882
+ SubscribeStreamUserIds?: SubscribeStreamUserIds
883
+
884
+ /**
885
+ * 输出文件的格式。0:(默认)输出文件为hls格式。1:输出文件格式为hls+mp4(hls录制完成后转mp4文件)
886
+ */
887
+ OutputFormat?: number
888
+ }
889
+
629
890
  /**
630
891
  * StopMCUMixTranscode请求参数结构体
631
892
  */
@@ -686,6 +947,69 @@ export interface UserInformation {
686
947
  Finished: boolean
687
948
  }
688
949
 
950
+ /**
951
+ * 用户自定义混流布局参数列表。
952
+ */
953
+ export interface MixLayout {
954
+ /**
955
+ * 画布上该画面左上角的 y 轴坐标,取值范围 [0, 1920],不能超过画布的高。
956
+ */
957
+ Top: number
958
+
959
+ /**
960
+ * 画布上该画面左上角的 x 轴坐标,取值范围 [0, 1920],不能超过画布的宽。
961
+ */
962
+ Left: number
963
+
964
+ /**
965
+ * 画布上该画面宽度的相对值,取值范围 [0, 1920],与Left相加不应超过画布的宽。
966
+ */
967
+ Width: number
968
+
969
+ /**
970
+ * 画布上该画面高度的相对值,取值范围 [0, 1920],与Top相加不应超过画布的高。
971
+ */
972
+ Height: number
973
+
974
+ /**
975
+ * 字符串内容为待显示在该画面的主播对应的UserId,如果不指定,会按照主播加入房间的顺序匹配。
976
+ */
977
+ UserId?: string
978
+
979
+ /**
980
+ * 画布的透明度值,取值范围[0, 255]。0表示不透明,255表示全透明。默认值为0。
981
+ */
982
+ Alpha?: number
983
+
984
+ /**
985
+ * 0 :拉伸模式,这个模式下整个视频内容会全部显示,并填满子画面,在源视频和目的视频宽高比不一致的时候,画面不会缺少内容,但是画面可能产生形变;
986
+
987
+ 1 :剪裁模式(默认),这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸,并填满子画面画布,在源视频和目的视频宽高比不一致的时候,画面保持不变形,但是会被剪裁;
988
+
989
+ 2 :填黑模式,这个模式下会严格保持源视频的宽高比进行等比缩放,在源视频和目的视频宽高比不一致的时候,画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景;
990
+
991
+ 3 :智能拉伸模式,这个模式类似剪裁模式,区别是在源视频和目的视频宽高比不一致的时候,限制了最大剪裁比例为画面的宽度或者高度的20%;
992
+ */
993
+ RenderMode?: number
994
+
995
+ /**
996
+ * 对应订阅流的主辅路标识:
997
+ 0:主流(默认);
998
+ 1:辅流;
999
+ */
1000
+ MediaId?: number
1001
+
1002
+ /**
1003
+ * 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。
1004
+ */
1005
+ ImageLayer?: number
1006
+
1007
+ /**
1008
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。
1009
+ */
1010
+ SubBackgroundImage?: string
1011
+ }
1012
+
689
1013
  /**
690
1014
  * DescribeHistoryScale请求参数结构体
691
1015
  */
@@ -721,6 +1045,61 @@ export interface DeletePictureRequest {
721
1045
  SdkAppId: number
722
1046
  }
723
1047
 
1048
+ /**
1049
+ * MCU混流布局参数
1050
+ */
1051
+ export interface LayoutParams {
1052
+ /**
1053
+ * 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
1054
+ */
1055
+ Template?: number
1056
+
1057
+ /**
1058
+ * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
1059
+ */
1060
+ MainVideoUserId?: string
1061
+
1062
+ /**
1063
+ * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
1064
+ */
1065
+ MainVideoStreamType?: number
1066
+
1067
+ /**
1068
+ * 画中画模板中有效,代表小画面的布局参数。
1069
+ */
1070
+ SmallVideoLayoutParams?: SmallVideoLayoutParams
1071
+
1072
+ /**
1073
+ * 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
1074
+ */
1075
+ MainVideoRightAlign?: number
1076
+
1077
+ /**
1078
+ * 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。
1079
+ */
1080
+ MixVideoUids?: Array<string>
1081
+
1082
+ /**
1083
+ * 自定义模板中有效,指定用户视频在混合画面中的位置。
1084
+ */
1085
+ PresetLayoutConfig?: Array<PresetLayoutConfig>
1086
+
1087
+ /**
1088
+ * 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
1089
+ */
1090
+ PlaceHolderMode?: number
1091
+
1092
+ /**
1093
+ * 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
1094
+ */
1095
+ PureAudioHoldPlaceMode?: number
1096
+
1097
+ /**
1098
+ * 水印参数。
1099
+ */
1100
+ WaterMarkParams?: WaterMarkParams
1101
+ }
1102
+
724
1103
  /**
725
1104
  * DescribeRoomInformation返回参数结构体
726
1105
  */
@@ -772,23 +1151,65 @@ export interface RecordUsage {
772
1151
  }
773
1152
 
774
1153
  /**
775
- * RemoveUser请求参数结构体
1154
+ * CreateCloudRecording请求参数结构体
776
1155
  */
777
- export interface RemoveUserRequest {
1156
+ export interface CreateCloudRecordingRequest {
778
1157
  /**
779
- * TRTC的SDKAppId。
1158
+ * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。
780
1159
  */
781
1160
  SdkAppId: number
782
1161
 
783
1162
  /**
784
- * 房间号。
1163
+ * TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。
785
1164
  */
786
- RoomId: number
1165
+ RoomId: string
787
1166
 
788
1167
  /**
789
- * 要移出的用户列表,最多10个。
1168
+ * 录制服务在TRTC房间使用的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者录制服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。
790
1169
  */
791
- UserIds: Array<string>
1170
+ UserId: string
1171
+
1172
+ /**
1173
+ * 云端录制加入房间的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
1174
+ */
1175
+ UserSig: string
1176
+
1177
+ /**
1178
+ * 云端录制控制参数。
1179
+ */
1180
+ RecordParams: RecordParams
1181
+
1182
+ /**
1183
+ * 云端录制文件上传到云存储的参数。
1184
+ */
1185
+ StorageParams: StorageParams
1186
+
1187
+ /**
1188
+ * TRTC房间号的类型,必须和录制的房间所对应的RoomId类型相同:
1189
+ 0: 字符串类型的RoomId
1190
+ 1: 32位整型的RoomId(默认)
1191
+ */
1192
+ RoomIdType?: number
1193
+
1194
+ /**
1195
+ * 混流的转码参数,录制模式为混流的时候可以设置。
1196
+ */
1197
+ MixTranscodeParams?: MixTranscodeParams
1198
+
1199
+ /**
1200
+ * 混流的布局参数,录制模式为混流的时候可以设置。
1201
+ */
1202
+ MixLayoutParams?: MixLayoutParams
1203
+
1204
+ /**
1205
+ * 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。
1206
+ */
1207
+ ResourceExpiredHour?: number
1208
+
1209
+ /**
1210
+ * TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey](https://cloud.tencent.com/document/product/647/32240) 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。
1211
+ */
1212
+ PrivateMapKey?: string
792
1213
  }
793
1214
 
794
1215
  /**
@@ -817,38 +1238,48 @@ export interface OutputParams {
817
1238
  }
818
1239
 
819
1240
  /**
820
- * ModifyPicture请求参数结构体
1241
+ * 水印布局参数
821
1242
  */
822
- export interface ModifyPictureRequest {
1243
+ export interface WaterMark {
823
1244
  /**
824
- * 图片id
1245
+ * 水印类型,0为图片(默认),1为文字(暂不支持)。
825
1246
  */
826
- PictureId: number
1247
+ WaterMarkType?: number
827
1248
 
828
1249
  /**
829
- * 应用id
1250
+ * 水印为图片时的参数列表,水印为图片时校验必填。
830
1251
  */
831
- SdkAppId: number
1252
+ WaterMarkImage?: WaterMarkImage
1253
+ }
832
1254
 
1255
+ /**
1256
+ * DeleteCloudRecording返回参数结构体
1257
+ */
1258
+ export interface DeleteCloudRecordingResponse {
833
1259
  /**
834
- * 图片长度
1260
+ * 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。
835
1261
  */
836
- Height?: number
1262
+ TaskId: string
837
1263
 
838
1264
  /**
839
- * 图片宽度
1265
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
840
1266
  */
841
- Width?: number
1267
+ RequestId?: string
1268
+ }
842
1269
 
1270
+ /**
1271
+ * 录制的音视频转码参数。
1272
+ */
1273
+ export interface MixTranscodeParams {
843
1274
  /**
844
- * 显示位置x轴方向
1275
+ * 录制视频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。
845
1276
  */
846
- XPosition?: number
1277
+ VideoParams?: VideoParams
847
1278
 
848
1279
  /**
849
- * 显示位置y轴方向
1280
+ * 录制音频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。
850
1281
  */
851
- YPosition?: number
1282
+ AudioParams?: AudioParams
852
1283
  }
853
1284
 
854
1285
  /**
@@ -918,6 +1349,16 @@ export interface AbnormalEvent {
918
1349
  PeerId: string
919
1350
  }
920
1351
 
1352
+ /**
1353
+ * RemoveUserByStrRoomId返回参数结构体
1354
+ */
1355
+ export interface RemoveUserByStrRoomIdResponse {
1356
+ /**
1357
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1358
+ */
1359
+ RequestId?: string
1360
+ }
1361
+
921
1362
  /**
922
1363
  * StopMCUMixTranscodeByStrRoomId返回参数结构体
923
1364
  */
@@ -938,6 +1379,31 @@ export interface DeletePictureResponse {
938
1379
  RequestId?: string
939
1380
  }
940
1381
 
1382
+ /**
1383
+ * ModifyCloudRecording请求参数结构体
1384
+ */
1385
+ export interface ModifyCloudRecordingRequest {
1386
+ /**
1387
+ * TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
1388
+ */
1389
+ SdkAppId: number
1390
+
1391
+ /**
1392
+ * 录制任务的唯一Id,在启动录制成功后会返回。
1393
+ */
1394
+ TaskId: string
1395
+
1396
+ /**
1397
+ * 需要更新的混流的布局参数。
1398
+ */
1399
+ MixLayoutParams?: MixLayoutParams
1400
+
1401
+ /**
1402
+ * 指定订阅流白名单或者黑名单。
1403
+ */
1404
+ SubscribeStreamUserIds?: SubscribeStreamUserIds
1405
+ }
1406
+
941
1407
  /**
942
1408
  * CreateTroubleInfo请求参数结构体
943
1409
  */
@@ -1007,18 +1473,89 @@ export interface EventList {
1007
1473
  }
1008
1474
 
1009
1475
  /**
1010
- * DismissRoom请求参数结构体
1476
+ * 云端录制查询接口,录制文件的信息
1011
1477
  */
1012
- export interface DismissRoomRequest {
1478
+ export interface StorageFile {
1013
1479
  /**
1014
- * TRTC的SDKAppId。
1480
+ * 录制文件对应的UserId,如果是混流的话的这里返回的是空串。
1481
+ 注意:此字段可能返回 null,表示取不到有效值。
1482
+ */
1483
+ UserId: string
1484
+
1485
+ /**
1486
+ * 录制索引文件名。
1487
+ */
1488
+ FileName: string
1489
+
1490
+ /**
1491
+ * 录制文件流信息。
1492
+ video:视频录制文件
1493
+ audio:音频录制文件
1494
+ audio_video:音视频录制文件
1495
+ 注意:此字段可能返回 null,表示取不到有效值。
1496
+ */
1497
+ TrackType: string
1498
+
1499
+ /**
1500
+ * 录制文件开始Unix时间戳。
1501
+ */
1502
+ BeginTimeStamp: number
1503
+ }
1504
+
1505
+ /**
1506
+ * 图片列表信息
1507
+ */
1508
+ export interface PictureInfo {
1509
+ /**
1510
+ * 图片长度
1511
+ */
1512
+ Height: number
1513
+
1514
+ /**
1515
+ * 图片宽度
1516
+ */
1517
+ Width: number
1518
+
1519
+ /**
1520
+ * 显示位置x轴方向
1521
+ */
1522
+ XPosition: number
1523
+
1524
+ /**
1525
+ * 显示位置y轴方向
1526
+ */
1527
+ YPosition: number
1528
+
1529
+ /**
1530
+ * 应用id
1015
1531
  */
1016
1532
  SdkAppId: number
1017
1533
 
1018
1534
  /**
1019
- * 房间号。
1535
+ * 图片id
1020
1536
  */
1021
- RoomId: number
1537
+ PictureId: number
1538
+ }
1539
+
1540
+ /**
1541
+ * DescribeUserInformation返回参数结构体
1542
+ */
1543
+ export interface DescribeUserInformationResponse {
1544
+ /**
1545
+ * 返回的用户总条数
1546
+ */
1547
+ Total: number
1548
+
1549
+ /**
1550
+ * 用户信息列表
1551
+ 注意:此字段可能返回 null,表示取不到有效值。
1552
+ */
1553
+ UserList: Array<UserInformation>
1554
+
1555
+ /**
1556
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1557
+ */
1558
+ RequestId?: string
1022
1559
  }
1023
1560
 
1024
1561
  /**
@@ -1037,24 +1574,41 @@ export interface DescribeDetailEventResponse {
1037
1574
  }
1038
1575
 
1039
1576
  /**
1040
- * DismissRoomByStrRoomId请求参数结构体
1577
+ * CreateCloudRecording返回参数结构体
1041
1578
  */
1042
- export interface DismissRoomByStrRoomIdRequest {
1579
+ export interface CreateCloudRecordingResponse {
1043
1580
  /**
1044
- * TRTC的SDKAppId。
1581
+ * 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。任务 ID需要业务保存下来,作为下次针对这个录制任务操作的参数。
1045
1582
  */
1046
- SdkAppId: number
1583
+ TaskId: string
1047
1584
 
1048
1585
  /**
1049
- * 房间号。
1586
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1050
1587
  */
1051
- RoomId: string
1588
+ RequestId?: string
1052
1589
  }
1053
1590
 
1054
1591
  /**
1055
- * StartMCUMixTranscode返回参数结构体
1592
+ * DescribeCallDetail返回参数结构体
1056
1593
  */
1057
- export interface StartMCUMixTranscodeResponse {
1594
+ export interface DescribeCallDetailResponse {
1595
+ /**
1596
+ * 返回的用户总条数
1597
+ */
1598
+ Total: number
1599
+
1600
+ /**
1601
+ * 用户信息列表
1602
+ 注意:此字段可能返回 null,表示取不到有效值。
1603
+ */
1604
+ UserList: Array<UserInformation>
1605
+
1606
+ /**
1607
+ * 质量数据
1608
+ 注意:此字段可能返回 null,表示取不到有效值。
1609
+ */
1610
+ Data: Array<QualityData>
1611
+
1058
1612
  /**
1059
1613
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1060
1614
  */
@@ -1096,6 +1650,21 @@ export interface DescribeTrtcMcuTranscodeTimeResponse {
1096
1650
  RequestId?: string
1097
1651
  }
1098
1652
 
1653
+ /**
1654
+ * DeleteCloudRecording请求参数结构体
1655
+ */
1656
+ export interface DeleteCloudRecordingRequest {
1657
+ /**
1658
+ * TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
1659
+ */
1660
+ SdkAppId: number
1661
+
1662
+ /**
1663
+ * 录制任务的唯一Id,在启动录制成功后会返回。
1664
+ */
1665
+ TaskId: string
1666
+ }
1667
+
1099
1668
  /**
1100
1669
  * DescribePicture请求参数结构体
1101
1670
  */
@@ -1237,30 +1806,58 @@ export interface PresetLayoutConfig {
1237
1806
  }
1238
1807
 
1239
1808
  /**
1240
- * DescribeCallDetail返回参数结构体
1809
+ * 录制视频转码参数。
1241
1810
  */
1242
- export interface DescribeCallDetailResponse {
1811
+ export interface VideoParams {
1243
1812
  /**
1244
- * 返回的用户总条数
1813
+ * 视频的宽度值,单位为像素,默认值360。不能超过1920,与height的乘积不能超过1920*1080。
1245
1814
  */
1246
- Total: number
1815
+ Width: number
1247
1816
 
1248
1817
  /**
1249
- * 用户信息列表
1250
- 注意:此字段可能返回 null,表示取不到有效值。
1818
+ * 视频的高度值,单位为像素,默认值640。不能超过1920,与width的乘积不能超过1920*1080。
1819
+ */
1820
+ Height: number
1821
+
1822
+ /**
1823
+ * 视频的帧率,范围[1, 60],默认15。
1824
+ */
1825
+ Fps: number
1826
+
1827
+ /**
1828
+ * 视频的码率,单位是bps,范围[64000, 8192000],默认550000bps。
1829
+ */
1830
+ BitRate: number
1831
+
1832
+ /**
1833
+ * 视频关键帧时间间隔,单位秒,默认值10秒。
1834
+ */
1835
+ Gop: number
1836
+ }
1837
+
1838
+ /**
1839
+ * 录制音频转码参数。
1840
+ */
1841
+ export interface AudioParams {
1842
+ /**
1843
+ * 音频采样率:
1844
+ 1:48000Hz(默认);
1845
+ 2:44100Hz
1846
+ 3:16000Hz。
1251
1847
  */
1252
- UserList: Array<UserInformation>
1848
+ SampleRate: number
1253
1849
 
1254
1850
  /**
1255
- * 质量数据
1256
- 注意:此字段可能返回 null,表示取不到有效值。
1851
+ * 声道数:
1852
+ 1:单身道;
1853
+ 2:双声道(默认)。
1257
1854
  */
1258
- Data: Array<QualityData>
1855
+ Channel: number
1259
1856
 
1260
1857
  /**
1261
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
1858
+ * 音频码率: 取值范围[32000, 128000] ,单位bps,默认64000bps
1262
1859
  */
1263
- RequestId?: string
1860
+ BitRate: number
1264
1861
  }
1265
1862
 
1266
1863
  /**
@@ -1283,6 +1880,51 @@ export interface DescribePictureResponse {
1283
1880
  RequestId?: string
1284
1881
  }
1285
1882
 
1883
+ /**
1884
+ * 水印类型为图片的参数列表
1885
+ */
1886
+ export interface WaterMarkImage {
1887
+ /**
1888
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M。
1889
+ */
1890
+ WaterMarkUrl: string
1891
+
1892
+ /**
1893
+ * 画布上该画面左上角的 y 轴坐标,取值范围 [0, 2560],不能超过画布的高。
1894
+ */
1895
+ Top: number
1896
+
1897
+ /**
1898
+ * 画布上该画面左上角的 x 轴坐标,取值范围 [0, 2560],不能超过画布的宽。
1899
+ */
1900
+ Left: number
1901
+
1902
+ /**
1903
+ * 画布上该画面宽度的相对值,取值范围 [0, 2560],与Left相加不应超过画布的宽。
1904
+ */
1905
+ Width: number
1906
+
1907
+ /**
1908
+ * 画布上该画面高度的相对值,取值范围 [0, 2560],与Top相加不应超过画布的高。
1909
+ */
1910
+ Height: number
1911
+ }
1912
+
1913
+ /**
1914
+ * DismissRoom请求参数结构体
1915
+ */
1916
+ export interface DismissRoomRequest {
1917
+ /**
1918
+ * TRTC的SDKAppId。
1919
+ */
1920
+ SdkAppId: number
1921
+
1922
+ /**
1923
+ * 房间号。
1924
+ */
1925
+ RoomId: number
1926
+ }
1927
+
1286
1928
  /**
1287
1929
  * 第三方CDN转推参数
1288
1930
  */
@@ -1393,6 +2035,16 @@ export interface AbnormalExperience {
1393
2035
  EventTime: number
1394
2036
  }
1395
2037
 
2038
+ /**
2039
+ * StartMCUMixTranscode返回参数结构体
2040
+ */
2041
+ export interface StartMCUMixTranscodeResponse {
2042
+ /**
2043
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2044
+ */
2045
+ RequestId?: string
2046
+ }
2047
+
1396
2048
  /**
1397
2049
  * 房间信息列表
1398
2050
  */
@@ -1535,36 +2187,16 @@ export interface StartMCUMixTranscodeByStrRoomIdResponse {
1535
2187
  }
1536
2188
 
1537
2189
  /**
1538
- * 图片列表信息
2190
+ * ModifyCloudRecording返回参数结构体
1539
2191
  */
1540
- export interface PictureInfo {
1541
- /**
1542
- * 图片长度
1543
- */
1544
- Height: number
1545
-
1546
- /**
1547
- * 图片宽度
1548
- */
1549
- Width: number
1550
-
2192
+ export interface ModifyCloudRecordingResponse {
1551
2193
  /**
1552
- * 显示位置x轴方向
1553
- */
1554
- XPosition: number
1555
-
1556
- /**
1557
- * 显示位置y轴方向
1558
- */
1559
- YPosition: number
1560
-
1561
- /**
1562
- * 应用id
2194
+ * 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。
1563
2195
  */
1564
- SdkAppId: number
2196
+ TaskId: string
1565
2197
 
1566
2198
  /**
1567
- * 图片id
2199
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1568
2200
  */
1569
- PictureId: number
2201
+ RequestId?: string
1570
2202
  }