tencentcloud-sdk-nodejs-trtc 4.0.459 → 4.0.461

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.
@@ -31,6 +31,24 @@ export interface CreatePictureRequest {
31
31
  */
32
32
  YPosition: number;
33
33
  }
34
+ /**
35
+ * DescribeRelayUsage请求参数结构体
36
+ */
37
+ export interface DescribeRelayUsageRequest {
38
+ /**
39
+ * 查询开始时间,格式为YYYY-MM-DD。
40
+ */
41
+ StartTime: string;
42
+ /**
43
+ * 查询结束时间,格式为YYYY-MM-DD。
44
+ 单次查询统计区间最多不能超过31天。
45
+ */
46
+ EndTime: string;
47
+ /**
48
+ * TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
49
+ */
50
+ SdkAppId?: number;
51
+ }
34
52
  /**
35
53
  * 用户自定义混流布局参数列表。
36
54
  */
@@ -85,42 +103,59 @@ export interface MixLayout {
85
103
  SubBackgroundImage?: string;
86
104
  }
87
105
  /**
88
- * RemoveUserByStrRoomId返回参数结构体
106
+ * 混流转推的视频相关参数。
89
107
  */
90
- export interface RemoveUserByStrRoomIdResponse {
108
+ export interface McuVideoParams {
91
109
  /**
92
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
110
+ * 输出流视频编码参数。
93
111
  */
94
- RequestId?: string;
95
- }
96
- /**
97
- * StartMCUMixTranscode请求参数结构体
98
- */
99
- export interface StartMCUMixTranscodeRequest {
112
+ VideoEncode?: VideoEncode;
100
113
  /**
101
- * TRTC的SDKAppId。
114
+ * 混流布局参数。
102
115
  */
103
- SdkAppId: number;
116
+ LayoutParams?: McuLayoutParams;
104
117
  /**
105
- * 房间号。
118
+ * 整个画布背景颜色,常用的颜色有:
119
+ 红色:0xcc0033。
120
+ 黄色:0xcc9900。
121
+ 绿色:0xcccc33。
122
+ 蓝色:0x99CCFF。
123
+ 黑色:0x000000。
124
+ 白色:0xFFFFFF。
125
+ 灰色:0x999999。
126
+ */
127
+ BackGroundColor?: string;
128
+ /**
129
+ * 整个画布的背景图url,优先级高于BackGroundColor。
106
130
  */
107
- RoomId: number;
131
+ BackgroundImageUrl?: string;
108
132
  /**
109
- * 混流输出控制参数。
133
+ * 混流布局的水印参数。
110
134
  */
111
- OutputParams: OutputParams;
135
+ WaterMarkList?: Array<McuWaterMarkParams>;
136
+ }
137
+ /**
138
+ * RemoveUserByStrRoomId返回参数结构体
139
+ */
140
+ export interface RemoveUserByStrRoomIdResponse {
112
141
  /**
113
- * 混流输出编码参数。
142
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
114
143
  */
115
- EncodeParams: EncodeParams;
144
+ RequestId?: string;
145
+ }
146
+ /**
147
+ * 音量布局SEI参数,可以自定义AppData和PayloadType类型。
148
+ 该参数内容可以为空,表示携带默认的音量布局SEI。
149
+ */
150
+ export interface McuLayoutVolume {
116
151
  /**
117
- * 混流输出布局参数。
152
+ * AppData的内容,会被写入自定义SEI中的app_data字段,长度需小于4096。
118
153
  */
119
- LayoutParams: LayoutParams;
154
+ AppData?: string;
120
155
  /**
121
- * 第三方CDN转推参数。
156
+ * SEI消息的payload_type,默认值100,取值范围100-254(244除外,244为我们内部自定义的时间戳SEI)
122
157
  */
123
- PublishCdnParams?: PublishCdnParams;
158
+ PayloadType?: number;
124
159
  }
125
160
  /**
126
161
  * DescribeUserEvent请求参数结构体
@@ -154,33 +189,31 @@ export interface DescribeUserEventRequest {
154
189
  SdkAppId: number;
155
190
  }
156
191
  /**
157
- * StartMCUMixTranscodeByStrRoomId请求参数结构体
192
+ * StopPublishCdnStream返回参数结构体
158
193
  */
159
- export interface StartMCUMixTranscodeByStrRoomIdRequest {
194
+ export interface StopPublishCdnStreamResponse {
160
195
  /**
161
- * TRTC的SDKAppId。
162
- */
163
- SdkAppId: number;
164
- /**
165
- * 字符串房间号。
196
+ * 转推任务唯一的String Id
166
197
  */
167
- StrRoomId: string;
168
- /**
169
- * 混流输出控制参数。
170
- */
171
- OutputParams: OutputParams;
198
+ TaskId: string;
172
199
  /**
173
- * 混流输出编码参数。
200
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
174
201
  */
175
- EncodeParams: EncodeParams;
202
+ RequestId?: string;
203
+ }
204
+ /**
205
+ * 造成异常体验可能的异常事件类型
206
+ */
207
+ export interface AbnormalEvent {
176
208
  /**
177
- * 混流输出布局参数。
209
+ * 异常事件ID,具体值查看附录:异常体验ID映射表:https://cloud.tencent.com/document/product/647/44916
178
210
  */
179
- LayoutParams: LayoutParams;
211
+ AbnormalEventId: number;
180
212
  /**
181
- * 第三方CDN转推参数。
182
- */
183
- PublishCdnParams?: PublishCdnParams;
213
+ * 远端用户ID,"":表示异常事件不是由远端用户产生
214
+ 注意:此字段可能返回 null,表示取不到有效值。
215
+ */
216
+ PeerId: string;
184
217
  }
185
218
  /**
186
219
  * 历史规模信息
@@ -206,6 +239,23 @@ export interface ScaleInfomation {
206
239
  */
207
240
  RoomNumbers: number;
208
241
  }
242
+ /**
243
+ * 转推服务加入TRTC房间的机器人参数。
244
+ */
245
+ export interface AgentParams {
246
+ /**
247
+ * 转推服务在TRTC房间使用的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。
248
+ */
249
+ UserId: string;
250
+ /**
251
+ * 转推服务加入TRTC房间的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
252
+ */
253
+ UserSig?: string;
254
+ /**
255
+ * 所有参与混流转推的主播持续离开TRTC房间超过MaxIdleTime的时长,自动停止转推,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。
256
+ */
257
+ MaxIdleTime?: number;
258
+ }
209
259
  /**
210
260
  * DescribeUserEvent返回参数结构体
211
261
  */
@@ -219,6 +269,31 @@ export interface DescribeUserEventResponse {
219
269
  */
220
270
  RequestId?: string;
221
271
  }
272
+ /**
273
+ * 视频编码参数。
274
+ */
275
+ export interface VideoEncode {
276
+ /**
277
+ * 输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。
278
+ */
279
+ Width: number;
280
+ /**
281
+ * 输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。
282
+ */
283
+ Height: number;
284
+ /**
285
+ * 输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。
286
+ */
287
+ Fps: number;
288
+ /**
289
+ * 输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。
290
+ */
291
+ BitRate: number;
292
+ /**
293
+ * 输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。
294
+ */
295
+ Gop: number;
296
+ }
222
297
  /**
223
298
  * StopMCUMixTranscodeByStrRoomId返回参数结构体
224
299
  */
@@ -445,6 +520,23 @@ export interface CloudStorage {
445
520
  */
446
521
  FileNamePrefix?: Array<string>;
447
522
  }
523
+ /**
524
+ * DescribeTrtcUsage返回参数结构体
525
+ */
526
+ export interface DescribeTrtcUsageResponse {
527
+ /**
528
+ * 用量类型,与UsageValue中各个位置的值对应。
529
+ */
530
+ UsageKey: Array<string>;
531
+ /**
532
+ * 各个时间点用量明细。
533
+ */
534
+ UsageList: Array<TrtcUsage>;
535
+ /**
536
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
537
+ */
538
+ RequestId?: string;
539
+ }
448
540
  /**
449
541
  * 返回的质量数据,时间:值
450
542
  */
@@ -573,6 +665,23 @@ export interface CloudVod {
573
665
  */
574
666
  TencentVod?: TencentVod;
575
667
  }
668
+ /**
669
+ * SdkAppId级别实时音视频的用量数据
670
+ */
671
+ export interface SdkAppIdNewTrtcTimeUsage {
672
+ /**
673
+ * SdkAppId的值。
674
+ */
675
+ SdkAppId: string;
676
+ /**
677
+ * 统计的时间点数据。
678
+ */
679
+ TrtcTimeUsages: Array<TrtcTimeNewUsage>;
680
+ /**
681
+ * 统计的麦下用量的时间点数据。
682
+ */
683
+ AudienceTrtcTimeUsages: Array<TrtcTimeNewUsage>;
684
+ }
576
685
  /**
577
686
  * MCU混流输出流编码参数
578
687
  */
@@ -656,6 +765,27 @@ export interface DescribeCallDetailInfoResponse {
656
765
  */
657
766
  RequestId?: string;
658
767
  }
768
+ /**
769
+ * 混流自定义裁剪参数
770
+ */
771
+ export interface McuCustomCrop {
772
+ /**
773
+ * 自定义裁剪起始位置的X偏移,单位为像素值,大于等于0。
774
+ */
775
+ LocationX: number;
776
+ /**
777
+ * 自定义裁剪起始位置的Y偏移,单位为像素值,大于等于0。
778
+ */
779
+ LocationY: number;
780
+ /**
781
+ * 自定义裁剪画面的宽度,单位为像素值,大于0,且LocationX+Width不超过10000
782
+ */
783
+ Width: number;
784
+ /**
785
+ * 自定义裁剪画面的高度,单位为像素值,大于0,且LocationY+Height不超过10000
786
+ */
787
+ Height: number;
788
+ }
659
789
  /**
660
790
  * 实时音视频用量的某一时间段的统计信息.
661
791
  */
@@ -701,6 +831,24 @@ export interface TrtcTimeNewUsage {
701
831
  */
702
832
  Video4KTime: number;
703
833
  }
834
+ /**
835
+ * DescribeMixTranscodingUsage请求参数结构体
836
+ */
837
+ export interface DescribeMixTranscodingUsageRequest {
838
+ /**
839
+ * 查询开始时间,格式为YYYY-MM-DD。
840
+ */
841
+ StartTime: string;
842
+ /**
843
+ * 查询结束时间,格式为YYYY-MM-DD。
844
+ 单次查询统计区间最多不能超过31天。
845
+ */
846
+ EndTime: string;
847
+ /**
848
+ * TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
849
+ */
850
+ SdkAppId?: number;
851
+ }
704
852
  /**
705
853
  * ModifyPicture请求参数结构体
706
854
  */
@@ -774,111 +922,400 @@ export interface SubscribeStreamUserIds {
774
922
  /**
775
923
  * 订阅视频流白名单,指定订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的视频流;["1.*$"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
776
924
  */
777
- SubscribeVideoUserIds?: Array<string>;
925
+ SubscribeVideoUserIds?: Array<string>;
926
+ /**
927
+ * 订阅视频流黑名单,指定不订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的视频流;["1.*$"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
928
+ */
929
+ UnSubscribeVideoUserIds?: Array<string>;
930
+ }
931
+ /**
932
+ * 水印类型为图片的参数列表
933
+ */
934
+ export interface WaterMarkImage {
935
+ /**
936
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M。
937
+ */
938
+ WaterMarkUrl: string;
939
+ /**
940
+ * 画布上该画面左上角的 y 轴坐标,取值范围 [0, 2560],不能超过画布的高。
941
+ */
942
+ Top: number;
943
+ /**
944
+ * 画布上该画面左上角的 x 轴坐标,取值范围 [0, 2560],不能超过画布的宽。
945
+ */
946
+ Left: number;
947
+ /**
948
+ * 画布上该画面宽度的相对值,取值范围 [0, 2560],与Left相加不应超过画布的宽。
949
+ */
950
+ Width: number;
951
+ /**
952
+ * 画布上该画面高度的相对值,取值范围 [0, 2560],与Top相加不应超过画布的高。
953
+ */
954
+ Height: number;
955
+ }
956
+ /**
957
+ * 混流用户参数
958
+ */
959
+ export interface McuUserInfoParams {
960
+ /**
961
+ * 用户参数。
962
+ */
963
+ UserInfo: MixUserInfo;
964
+ }
965
+ /**
966
+ * 用户媒体流参数。
967
+ */
968
+ export interface UserMediaStream {
969
+ /**
970
+ * TRTC用户参数。
971
+ */
972
+ UserInfo?: MixUserInfo;
973
+ /**
974
+ * 主辅路流类型,0为摄像头,1为屏幕分享,不填默认为0。
975
+ */
976
+ StreamType?: number;
977
+ }
978
+ /**
979
+ * sdk或webrtc的事件列表。
980
+ */
981
+ export interface EventList {
982
+ /**
983
+ * 数据内容
984
+ */
985
+ Content: Array<EventMessage>;
986
+ /**
987
+ * 发送端的userId
988
+ */
989
+ PeerId: string;
990
+ }
991
+ /**
992
+ * DescribeTrtcUsage请求参数结构体
993
+ */
994
+ export interface DescribeTrtcUsageRequest {
995
+ /**
996
+ * 查询开始时间,格式为YYYY-MM-DD。
997
+ */
998
+ StartTime: string;
999
+ /**
1000
+ * 查询结束时间,格式为YYYY-MM-DD。
1001
+ 单次查询统计区间最多不能超过31天。
1002
+ */
1003
+ EndTime: string;
1004
+ /**
1005
+ * TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
1006
+ */
1007
+ SdkAppId?: number;
1008
+ }
1009
+ /**
1010
+ * DescribeRoomInfo返回参数结构体
1011
+ */
1012
+ export interface DescribeRoomInfoResponse {
1013
+ /**
1014
+ * 返回当页数据总数
1015
+ */
1016
+ Total: number;
1017
+ /**
1018
+ * 房间信息列表
1019
+ */
1020
+ RoomList: Array<RoomState>;
1021
+ /**
1022
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1023
+ */
1024
+ RequestId?: string;
1025
+ }
1026
+ /**
1027
+ * 混流布局参数。
1028
+ */
1029
+ export interface McuLayoutParams {
1030
+ /**
1031
+ * 布局模式:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局),静态布局(4:自定义布局)。
1032
+ */
1033
+ MixLayoutMode?: number;
1034
+ /**
1035
+ * 纯音频上行是否占布局位置,只在动态布局中有效。0表示纯音频占布局位置,1表示纯音频不占布局位置,不填默认为0。
1036
+ */
1037
+ PureAudioHoldPlaceMode?: number;
1038
+ /**
1039
+ * 自定义模板中有效,指定用户视频在混合画面中的位置。
1040
+ */
1041
+ MixLayoutList?: Array<McuLayout>;
1042
+ /**
1043
+ * 指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。
1044
+ */
1045
+ MaxVideoUser?: MaxVideoUser;
1046
+ }
1047
+ /**
1048
+ * UpdatePublishCdnStream请求参数结构体
1049
+ */
1050
+ export interface UpdatePublishCdnStreamRequest {
1051
+ /**
1052
+ * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。
1053
+ */
1054
+ SdkAppId: number;
1055
+ /**
1056
+ * 唯一标识转推任务。
1057
+ */
1058
+ TaskId: string;
1059
+ /**
1060
+ * 客户保证同一个任务,每次更新请求中的SequenceNumber递增,防止请求乱序。
1061
+ */
1062
+ SequenceNumber: number;
1063
+ /**
1064
+ * 是否转码,0表示无需转码,1表示需要转码。
1065
+ */
1066
+ WithTranscoding: number;
1067
+ /**
1068
+ * 更新相关参数,只支持更新参与混音的主播列表参数。不填表示不更新此参数。
1069
+ */
1070
+ AudioParams?: McuAudioParams;
1071
+ /**
1072
+ * 更新视频相关参数,转码时支持更新除编码类型之外的编码参数,视频布局参数,背景图片和背景颜色参数,水印参数。不填表示不更新此参数。
1073
+ */
1074
+ VideoParams?: McuVideoParams;
1075
+ /**
1076
+ * 更新单流转推的用户上行参数,仅在非转码时有效。不填表示不更新此参数。
1077
+ */
1078
+ SingleSubscribeParams?: SingleSubscribeParams;
1079
+ /**
1080
+ * 更新转推的CDN参数。不填表示不更新此参数。
1081
+ */
1082
+ PublishCdnParams?: Array<McuPublishCdnParam>;
1083
+ /**
1084
+ * 混流SEI参数
1085
+ */
1086
+ SeiParams?: McuSeiParams;
1087
+ }
1088
+ /**
1089
+ * 查询旁路转码计费时长。
1090
+ 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
1091
+ */
1092
+ export interface SdkAppIdTrtcMcuTranscodeTimeUsage {
1093
+ /**
1094
+ * 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。
1095
+ */
1096
+ TimeKey: string;
1097
+ /**
1098
+ * 语音时长,单位:秒。
1099
+ */
1100
+ AudioTime: number;
1101
+ /**
1102
+ * 视频时长-标清SD,单位:秒。
1103
+ */
1104
+ VideoTimeSd: number;
1105
+ /**
1106
+ * 视频时长-高清HD,单位:秒。
1107
+ */
1108
+ VideoTimeHd: number;
1109
+ /**
1110
+ * 视频时长-全高清FHD,单位:秒。
1111
+ */
1112
+ VideoTimeFhd: number;
1113
+ /**
1114
+ * 带宽,单位:Mbps。
1115
+ */
1116
+ Flux: number;
1117
+ }
1118
+ /**
1119
+ * 混流布局参数。
1120
+ */
1121
+ export interface McuLayout {
1122
+ /**
1123
+ * 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
1124
+ */
1125
+ UserMediaStream?: UserMediaStream;
1126
+ /**
1127
+ * 子画面在输出时的宽度,单位为像素值,不填默认为0。
1128
+ */
1129
+ ImageWidth?: number;
1130
+ /**
1131
+ * 子画面在输出时的高度,单位为像素值,不填默认为0。
1132
+ */
1133
+ ImageHeight?: number;
1134
+ /**
1135
+ * 子画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
1136
+ */
1137
+ LocationX?: number;
1138
+ /**
1139
+ * 子画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
1140
+ */
1141
+ LocationY?: number;
1142
+ /**
1143
+ * 子画面在输出时的层级,不填默认为0。
1144
+ */
1145
+ ZOrder?: number;
1146
+ /**
1147
+ * 子画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底。不填默认为0。
1148
+ */
1149
+ RenderMode?: number;
1150
+ /**
1151
+ * 子画面的背景颜色,常用的颜色有:
1152
+ 红色:0xcc0033。
1153
+ 黄色:0xcc9900。
1154
+ 绿色:0xcccc33。
1155
+ 蓝色:0x99CCFF。
1156
+ 黑色:0x000000。
1157
+ 白色:0xFFFFFF。
1158
+ 灰色:0x999999。
1159
+ */
1160
+ BackGroundColor?: string;
1161
+ /**
1162
+ * 子画面的背景图url,填写该参数,当用户关闭摄像头或未进入TRTC房间时,会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致,则会对图片进行拉伸处理,优先级高于BackGroundColor。
1163
+ */
1164
+ BackgroundImageUrl?: string;
1165
+ /**
1166
+ * 客户自定义裁剪,针对原始输入流裁剪
1167
+ */
1168
+ CustomCrop?: McuCustomCrop;
1169
+ }
1170
+ /**
1171
+ * DescribeUserInfo返回参数结构体
1172
+ */
1173
+ export interface DescribeUserInfoResponse {
1174
+ /**
1175
+ * 返回的用户总条数
1176
+ */
1177
+ Total: number;
1178
+ /**
1179
+ * 用户信息列表
1180
+ 注意:此字段可能返回 null,表示取不到有效值。
1181
+ */
1182
+ UserList: Array<UserInformation>;
1183
+ /**
1184
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1185
+ */
1186
+ RequestId?: string;
1187
+ }
1188
+ /**
1189
+ * StartMCUMixTranscode请求参数结构体
1190
+ */
1191
+ export interface StartMCUMixTranscodeRequest {
1192
+ /**
1193
+ * TRTC的SDKAppId。
1194
+ */
1195
+ SdkAppId: number;
1196
+ /**
1197
+ * 房间号。
1198
+ */
1199
+ RoomId: number;
1200
+ /**
1201
+ * 混流输出控制参数。
1202
+ */
1203
+ OutputParams: OutputParams;
1204
+ /**
1205
+ * 混流输出编码参数。
1206
+ */
1207
+ EncodeParams: EncodeParams;
1208
+ /**
1209
+ * 混流输出布局参数。
1210
+ */
1211
+ LayoutParams: LayoutParams;
778
1212
  /**
779
- * 订阅视频流黑名单,指定不订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的视频流;["1.*$"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
1213
+ * 第三方CDN转推参数。
780
1214
  */
781
- UnSubscribeVideoUserIds?: Array<string>;
1215
+ PublishCdnParams?: PublishCdnParams;
782
1216
  }
783
1217
  /**
784
- * 水印类型为图片的参数列表
1218
+ * 图片水印参数。
785
1219
  */
786
- export interface WaterMarkImage {
1220
+ export interface McuWaterMarkImage {
787
1221
  /**
788
- * 下载的url地址, 只支持jpg, png,大小限制不超过5M
1222
+ * 水印图片URL地址,支持png、jpg、jpeg格式。图片大小限制不超过5MB
789
1223
  */
790
1224
  WaterMarkUrl: string;
791
1225
  /**
792
- * 画布上该画面左上角的 y 轴坐标,取值范围 [0, 2560],不能超过画布的高。
793
- */
794
- Top: number;
795
- /**
796
- * 画布上该画面左上角的 x 轴坐标,取值范围 [0, 2560],不能超过画布的宽。
1226
+ * 水印在输出时的宽。单位为像素值。
797
1227
  */
798
- Left: number;
1228
+ WaterMarkWidth: number;
799
1229
  /**
800
- * 画布上该画面宽度的相对值,取值范围 [0, 2560],与Left相加不应超过画布的宽。
1230
+ * 水印在输出时的高。单位为像素值。
801
1231
  */
802
- Width: number;
1232
+ WaterMarkHeight: number;
803
1233
  /**
804
- * 画布上该画面高度的相对值,取值范围 [0, 2560],与Top相加不应超过画布的高。
1234
+ * 水印在输出时的X偏移。单位为像素值。
805
1235
  */
806
- Height: number;
807
- }
808
- /**
809
- * sdk或webrtc的事件列表。
810
- */
811
- export interface EventList {
1236
+ LocationX: number;
812
1237
  /**
813
- * 数据内容
1238
+ * 水印在输出时的Y偏移。单位为像素值。
814
1239
  */
815
- Content: Array<EventMessage>;
1240
+ LocationY: number;
816
1241
  /**
817
- * 发送端的userId
1242
+ * 水印在输出时的层级,不填默认为0。
818
1243
  */
819
- PeerId: string;
1244
+ ZOrder?: number;
820
1245
  }
821
1246
  /**
822
- * DescribeRoomInfo返回参数结构体
1247
+ * StartPublishCdnStream返回参数结构体
823
1248
  */
824
- export interface DescribeRoomInfoResponse {
825
- /**
826
- * 返回当页数据总数
827
- */
828
- Total: number;
1249
+ export interface StartPublishCdnStreamResponse {
829
1250
  /**
830
- * 房间信息列表
1251
+ * 用于唯一标识转推任务,由腾讯云服务端生成,后续更新和停止请求都需要携带TaskiD参数。
831
1252
  */
832
- RoomList: Array<RoomState>;
1253
+ TaskId: string;
833
1254
  /**
834
1255
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
835
1256
  */
836
1257
  RequestId?: string;
837
1258
  }
838
1259
  /**
839
- * 查询旁路转码计费时长。
840
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
1260
+ * 实时音视频用量在某一时间段的统计信息。
841
1261
  */
842
- export interface SdkAppIdTrtcMcuTranscodeTimeUsage {
1262
+ export interface TrtcUsage {
843
1263
  /**
844
- * 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05
1264
+ * 时间点,格式为YYYY-MM-DD HH:mm:ss。多天查询时,HH:mm:ss为00:00:00
845
1265
  */
846
1266
  TimeKey: string;
847
1267
  /**
848
- * 语音时长,单位:秒。
1268
+ * 用量数组。每个数值含义与UsageKey对应。单位:分钟。
849
1269
  */
850
- AudioTime: number;
1270
+ UsageValue: Array<number>;
1271
+ }
1272
+ /**
1273
+ * DescribeRelayUsage返回参数结构体
1274
+ */
1275
+ export interface DescribeRelayUsageResponse {
851
1276
  /**
852
- * 视频时长-标清SD,单位:秒。
1277
+ * 用量类型,与UsageValue中各个位置的值对应。
853
1278
  */
854
- VideoTimeSd: number;
1279
+ UsageKey: Array<string>;
855
1280
  /**
856
- * 视频时长-高清HD,单位:秒。
1281
+ * 各个时间点用量明细。
857
1282
  */
858
- VideoTimeHd: number;
1283
+ UsageList: Array<TrtcUsage>;
859
1284
  /**
860
- * 视频时长-全高清FHD,单位:秒。
1285
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
861
1286
  */
862
- VideoTimeFhd: number;
1287
+ RequestId?: string;
863
1288
  }
864
1289
  /**
865
- * DescribeUserInfo返回参数结构体
1290
+ * DescribeRecordingUsage返回参数结构体
866
1291
  */
867
- export interface DescribeUserInfoResponse {
1292
+ export interface DescribeRecordingUsageResponse {
868
1293
  /**
869
- * 返回的用户总条数
1294
+ * 用量类型,与UsageValue中各个位置的值对应。
870
1295
  */
871
- Total: number;
1296
+ UsageKey: Array<string>;
872
1297
  /**
873
- * 用户信息列表
874
- 注意:此字段可能返回 null,表示取不到有效值。
875
- */
876
- UserList: Array<UserInformation>;
1298
+ * 各个时间点用量明细。
1299
+ */
1300
+ UsageList: Array<TrtcUsage>;
877
1301
  /**
878
1302
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
879
1303
  */
880
1304
  RequestId?: string;
881
1305
  }
1306
+ /**
1307
+ * StopMCUMixTranscode请求参数结构体
1308
+ */
1309
+ export interface StopMCUMixTranscodeRequest {
1310
+ /**
1311
+ * TRTC的SDKAppId。
1312
+ */
1313
+ SdkAppId: number;
1314
+ /**
1315
+ * 房间号。
1316
+ */
1317
+ RoomId: number;
1318
+ }
882
1319
  /**
883
1320
  * ModifyPicture返回参数结构体
884
1321
  */
@@ -888,6 +1325,28 @@ export interface ModifyPictureResponse {
888
1325
  */
889
1326
  RequestId?: string;
890
1327
  }
1328
+ /**
1329
+ * DescribeRecordingUsage请求参数结构体
1330
+ */
1331
+ export interface DescribeRecordingUsageRequest {
1332
+ /**
1333
+ * 查询开始时间,格式为YYYY-MM-DD。
1334
+ */
1335
+ StartTime: string;
1336
+ /**
1337
+ * 查询结束时间,格式为YYYY-MM-DD。
1338
+ 单次查询统计区间最多不能超过31天。
1339
+ */
1340
+ EndTime: string;
1341
+ /**
1342
+ * 查询单流录制或合流录制,值为"single"或"multi"。
1343
+ */
1344
+ MixType: string;
1345
+ /**
1346
+ * TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
1347
+ */
1348
+ SdkAppId?: number;
1349
+ }
891
1350
  /**
892
1351
  * 云端录制查询接口,录制文件的信息
893
1352
  */
@@ -1016,21 +1475,42 @@ export interface StopMCUMixTranscodeResponse {
1016
1475
  RequestId?: string;
1017
1476
  }
1018
1477
  /**
1019
- * SdkAppId级别实时音视频的用量数据
1478
+ * DescribeMixTranscodingUsage返回参数结构体
1020
1479
  */
1021
- export interface SdkAppIdNewTrtcTimeUsage {
1480
+ export interface DescribeMixTranscodingUsageResponse {
1022
1481
  /**
1023
- * SdkAppId的值。
1482
+ * 用量类型,与UsageValue中各个位置的值对应。
1024
1483
  */
1025
- SdkAppId: string;
1484
+ UsageKey: Array<string>;
1026
1485
  /**
1027
- * 统计的时间点数据。
1486
+ * 各个时间点用量明细。
1028
1487
  */
1029
- TrtcTimeUsages: Array<TrtcTimeNewUsage>;
1488
+ UsageList: Array<TrtcUsage>;
1030
1489
  /**
1031
- * 统计的麦下用量的时间点数据。
1490
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1032
1491
  */
1033
- AudienceTrtcTimeUsages: Array<TrtcTimeNewUsage>;
1492
+ RequestId?: string;
1493
+ }
1494
+ /**
1495
+ * 音频编码参数。
1496
+ */
1497
+ export interface AudioEncode {
1498
+ /**
1499
+ * 输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000],单位是Hz。
1500
+ */
1501
+ SampleRate: number;
1502
+ /**
1503
+ * 输出流音频声道数,取值范围[1,2],1表示混流输出音频为单声道,2表示混流输出音频为双声道。
1504
+ */
1505
+ Channel: number;
1506
+ /**
1507
+ * 输出流音频码率。取值范围[8,500],单位为kbps。
1508
+ */
1509
+ BitRate: number;
1510
+ /**
1511
+ * 输出流音频编码类型,取值范围[0, 1, 2],0为LC-AAC,1为HE-AAC,2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时,只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。
1512
+ */
1513
+ Codec?: number;
1034
1514
  }
1035
1515
  /**
1036
1516
  * RemoveUser请求参数结构体
@@ -1136,17 +1616,21 @@ export interface TencentVod {
1136
1616
  MediaType?: number;
1137
1617
  }
1138
1618
  /**
1139
- * StopMCUMixTranscode请求参数结构体
1619
+ * 自定义透传SEI
1140
1620
  */
1141
- export interface StopMCUMixTranscodeRequest {
1621
+ export interface McuPassThrough {
1142
1622
  /**
1143
- * TRTCSDKAppId。
1623
+ * 透传SEIpayload内容。
1144
1624
  */
1145
- SdkAppId: number;
1625
+ PayloadContent: string;
1146
1626
  /**
1147
- * 房间号。
1627
+ * SEI消息的payload_type,取值范围5、100-254(244除外,244为我们内部自定义的时间戳SEI)。
1148
1628
  */
1149
- RoomId: number;
1629
+ PayloadType: number;
1630
+ /**
1631
+ * PayloadType为5,PayloadUuid必须填写。PayloadType不是5时,不需要填写,填写会被后台忽略。该值必须是32长度的十六进制。
1632
+ */
1633
+ PayloadUuid?: string;
1150
1634
  }
1151
1635
  /**
1152
1636
  * MCU混流布局参数
@@ -1339,6 +1823,19 @@ export interface QualityData {
1339
1823
  */
1340
1824
  DataType: string;
1341
1825
  }
1826
+ /**
1827
+ * StopPublishCdnStream请求参数结构体
1828
+ */
1829
+ export interface StopPublishCdnStreamRequest {
1830
+ /**
1831
+ * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。
1832
+ */
1833
+ SdkAppId: number;
1834
+ /**
1835
+ * 唯一标识转推任务。
1836
+ */
1837
+ TaskId: string;
1838
+ }
1342
1839
  /**
1343
1840
  * DeletePicture返回参数结构体
1344
1841
  */
@@ -1394,6 +1891,51 @@ export interface VideoParams {
1394
1891
  */
1395
1892
  Gop: number;
1396
1893
  }
1894
+ /**
1895
+ * StartPublishCdnStream请求参数结构体
1896
+ */
1897
+ export interface StartPublishCdnStreamRequest {
1898
+ /**
1899
+ * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。
1900
+ */
1901
+ SdkAppId: number;
1902
+ /**
1903
+ * 主房间信息RoomId,转推的TRTC房间所对应的RoomId。
1904
+ */
1905
+ RoomId: string;
1906
+ /**
1907
+ * 主房间信息RoomType,必须和转推的房间所对应的RoomId类型相同,0为整形房间号,1为字符串房间号。
1908
+ */
1909
+ RoomIdType: number;
1910
+ /**
1911
+ * 转推服务加入TRTC房间的机器人参数。
1912
+ */
1913
+ AgentParams: AgentParams;
1914
+ /**
1915
+ * 是否转码,0表示无需转码,1表示需要转码。
1916
+ */
1917
+ WithTranscoding: number;
1918
+ /**
1919
+ * 转推流的音频编码参数。
1920
+ */
1921
+ AudioParams?: McuAudioParams;
1922
+ /**
1923
+ * 转推流的视频编码参数,不填表示纯音频转推。
1924
+ */
1925
+ VideoParams?: McuVideoParams;
1926
+ /**
1927
+ * 需要单流旁路转推的用户上行参数,单流旁路转推时,WithTranscoding需要设置为0。
1928
+ */
1929
+ SingleSubscribeParams?: SingleSubscribeParams;
1930
+ /**
1931
+ * 转推的CDN参数。
1932
+ */
1933
+ PublishCdnParams?: Array<McuPublishCdnParam>;
1934
+ /**
1935
+ * 混流SEI参数
1936
+ */
1937
+ SeiParams?: McuSeiParams;
1938
+ }
1397
1939
  /**
1398
1940
  * 旁路转码时长的查询结果
1399
1941
  */
@@ -1633,18 +2175,33 @@ export interface ModifyCloudRecordingResponse {
1633
2175
  RequestId?: string;
1634
2176
  }
1635
2177
  /**
1636
- * 造成异常体验可能的异常事件类型
2178
+ * StartMCUMixTranscodeByStrRoomId请求参数结构体
1637
2179
  */
1638
- export interface AbnormalEvent {
2180
+ export interface StartMCUMixTranscodeByStrRoomIdRequest {
1639
2181
  /**
1640
- * 异常事件ID,具体值查看附录:异常体验ID映射表:https://cloud.tencent.com/document/product/647/44916
2182
+ * TRTC的SDKAppId。
1641
2183
  */
1642
- AbnormalEventId: number;
2184
+ SdkAppId: number;
1643
2185
  /**
1644
- * 远端用户ID,"":表示异常事件不是由远端用户产生
1645
- 注意:此字段可能返回 null,表示取不到有效值。
1646
- */
1647
- PeerId: string;
2186
+ * 字符串房间号。
2187
+ */
2188
+ StrRoomId: string;
2189
+ /**
2190
+ * 混流输出控制参数。
2191
+ */
2192
+ OutputParams: OutputParams;
2193
+ /**
2194
+ * 混流输出编码参数。
2195
+ */
2196
+ EncodeParams: EncodeParams;
2197
+ /**
2198
+ * 混流输出布局参数。
2199
+ */
2200
+ LayoutParams: LayoutParams;
2201
+ /**
2202
+ * 第三方CDN转推参数。
2203
+ */
2204
+ PublishCdnParams?: PublishCdnParams;
1648
2205
  }
1649
2206
  /**
1650
2207
  * DescribeCloudRecording返回参数结构体
@@ -1671,6 +2228,23 @@ export interface DescribeCloudRecordingResponse {
1671
2228
  */
1672
2229
  RequestId?: string;
1673
2230
  }
2231
+ /**
2232
+ * TRTC用户参数。
2233
+ */
2234
+ export interface MixUserInfo {
2235
+ /**
2236
+ * 用户ID。
2237
+ */
2238
+ UserId: string;
2239
+ /**
2240
+ * 动态布局时房间信息必须和主房间信息保持一致,自定义布局时房间信息必须和MixLayoutList中对应用户的房间信息保持一致,不填时默认与主房间信息一致。
2241
+ */
2242
+ RoomId?: string;
2243
+ /**
2244
+ * 房间号类型,0为整形房间号,1为字符串房间号。
2245
+ */
2246
+ RoomIdType?: number;
2247
+ }
1674
2248
  /**
1675
2249
  * DismissRoom返回参数结构体
1676
2250
  */
@@ -1680,6 +2254,15 @@ export interface DismissRoomResponse {
1680
2254
  */
1681
2255
  RequestId?: string;
1682
2256
  }
2257
+ /**
2258
+ * 指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。
2259
+ */
2260
+ export interface MaxVideoUser {
2261
+ /**
2262
+ * 用户媒体流参数。
2263
+ */
2264
+ UserMediaStream: UserMediaStream;
2265
+ }
1683
2266
  /**
1684
2267
  * DeletePicture请求参数结构体
1685
2268
  */
@@ -1693,6 +2276,19 @@ export interface DeletePictureRequest {
1693
2276
  */
1694
2277
  SdkAppId: number;
1695
2278
  }
2279
+ /**
2280
+ * 混流SEI参数
2281
+ */
2282
+ export interface McuSeiParams {
2283
+ /**
2284
+ * 音量布局SEI
2285
+ */
2286
+ LayoutVolume?: McuLayoutVolume;
2287
+ /**
2288
+ * 透传SEI
2289
+ */
2290
+ PassThrough?: McuPassThrough;
2291
+ }
1696
2292
  /**
1697
2293
  * DescribeExternalTrtcMeasure请求参数结构体
1698
2294
  */
@@ -1710,6 +2306,19 @@ export interface DescribeExternalTrtcMeasureRequest {
1710
2306
  */
1711
2307
  SdkAppId?: number;
1712
2308
  }
2309
+ /**
2310
+ * UpdatePublishCdnStream返回参数结构体
2311
+ */
2312
+ export interface UpdatePublishCdnStreamResponse {
2313
+ /**
2314
+ * 转推任务唯一的String Id
2315
+ */
2316
+ TaskId: string;
2317
+ /**
2318
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2319
+ */
2320
+ RequestId?: string;
2321
+ }
1713
2322
  /**
1714
2323
  * RemoveUserByStrRoomId请求参数结构体
1715
2324
  */
@@ -1774,6 +2383,19 @@ export interface SdkAppIdRecordUsage {
1774
2383
  */
1775
2384
  Usages: Array<RecordUsage>;
1776
2385
  }
2386
+ /**
2387
+ * 混流转推的音频相关参数。
2388
+ */
2389
+ export interface McuAudioParams {
2390
+ /**
2391
+ * 音频编码参数。
2392
+ */
2393
+ AudioEncode?: AudioEncode;
2394
+ /**
2395
+ * 音频用户白名单,start时,为空或不填表示混所有主播音频,填具体值表示混指定主播音频;update时,不填表示不更新,为空表示更新为混所有主播音频,填具体值表示更新为混指定主播音频。
2396
+ */
2397
+ SubscribeAudioList?: Array<McuUserInfoParams>;
2398
+ }
1777
2399
  /**
1778
2400
  * 自定义模板中有效,指定用户视频在混合画面中的位置。
1779
2401
  */
@@ -1819,6 +2441,19 @@ export interface PresetLayoutConfig {
1819
2441
  */
1820
2442
  PlaceImageId?: number;
1821
2443
  }
2444
+ /**
2445
+ * 转推参数。
2446
+ */
2447
+ export interface McuPublishCdnParam {
2448
+ /**
2449
+ * CDN转推URL。
2450
+ */
2451
+ PublishCdnUrl: string;
2452
+ /**
2453
+ * 是否是腾讯云CDN,0为转推非腾讯云CDN,1为转推腾讯CDN。注意:为避免默认值误产生转推费用,该参数建议明确填写。转推非腾讯云CDN时会产生转推费用,详情参见接口文档说明。
2454
+ */
2455
+ IsTencentCdn?: number;
2456
+ }
1822
2457
  /**
1823
2458
  * 录制音频转码参数。
1824
2459
  */
@@ -1841,6 +2476,15 @@ export interface AudioParams {
1841
2476
  */
1842
2477
  BitRate: number;
1843
2478
  }
2479
+ /**
2480
+ * 单流旁路转推的用户上行信息。
2481
+ */
2482
+ export interface SingleSubscribeParams {
2483
+ /**
2484
+ * 用户媒体流参数。
2485
+ */
2486
+ UserMediaStream: UserMediaStream;
2487
+ }
1844
2488
  /**
1845
2489
  * 第三方CDN转推参数
1846
2490
  */
@@ -1854,6 +2498,19 @@ export interface PublishCdnParams {
1854
2498
  */
1855
2499
  PublishCdnUrls: Array<string>;
1856
2500
  }
2501
+ /**
2502
+ * 水印参数。
2503
+ */
2504
+ export interface McuWaterMarkParams {
2505
+ /**
2506
+ * 水印类型,0为图片(默认)。
2507
+ */
2508
+ WaterMarkType?: number;
2509
+ /**
2510
+ * 图片水印参数。WaterMarkType为0指定。
2511
+ */
2512
+ WaterMarkImage?: McuWaterMarkImage;
2513
+ }
1857
2514
  /**
1858
2515
  * 用户的异常体验及可能的原因
1859
2516
  */