tencentcloud-sdk-nodejs-live 4.0.294 → 4.0.295
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +99 -0
- package/SERVICE_CHANGELOG.md +125 -75
- package/package.json +1 -1
- package/products.md +9 -9
- package/src/services/live/v20180801/live_client.ts +81 -23
- package/src/services/live/v20180801/live_models.ts +453 -251
- package/tencentcloud/services/live/v20180801/live_client.d.ts +34 -9
- package/tencentcloud/services/live/v20180801/live_client.js +43 -10
- package/tencentcloud/services/live/v20180801/live_models.d.ts +394 -223
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { CreateLiveSnapshotRuleRequest, EnableLiveDomainResponse, CreateLiveCertRequest, StopRecordTaskResponse, DescribeDeliverBandwidthListResponse, DeleteLiveRecordRuleRequest, ResumeLiveStreamRequest, DeleteLiveTranscodeTemplateResponse, DescribeBillBandwidthAndFluxListResponse, DeleteLiveCallbackRuleResponse, ResumeDelayLiveStreamRequest, DescribeLiveWatermarkRulesResponse, DescribeLiveCallbackTemplateResponse, CreateLivePullStreamTaskRequest, DeleteLiveSnapshotTemplateRequest, DescribeGroupProIspPlayInfoListResponse, DescribeUploadStreamNumsResponse, DeleteLiveRecordTemplateRequest, DeleteLiveCallbackTemplateResponse,
|
|
2
|
+
import { CreateLiveSnapshotRuleRequest, EnableLiveDomainResponse, CreateLiveCertRequest, StopRecordTaskResponse, DescribeDeliverBandwidthListResponse, DeleteLiveRecordRuleRequest, ResumeLiveStreamRequest, DeleteLiveTranscodeTemplateResponse, StopScreenshotTaskRequest, DescribeBillBandwidthAndFluxListResponse, CreateScreenshotTaskResponse, DeleteLiveCallbackRuleResponse, ResumeDelayLiveStreamRequest, DescribeLiveWatermarkRulesResponse, DescribeLiveCallbackTemplateResponse, CreateLivePullStreamTaskRequest, DeleteLiveSnapshotTemplateRequest, DescribeGroupProIspPlayInfoListResponse, DescribeUploadStreamNumsResponse, DeleteLiveRecordTemplateRequest, DeleteLiveCallbackTemplateResponse, CreateScreenshotTaskRequest, UnBindLiveDomainCertResponse, ModifyLivePlayAuthKeyRequest, DescribeLiveDelayInfoListRequest, DeleteLiveTranscodeRuleResponse, DescribeStreamPlayInfoListResponse, DescribeScreenShotSheetNumListResponse, DescribeLiveCertRequest, CreateLivePullStreamTaskResponse, ModifyLivePushAuthKeyRequest, DeleteLiveCallbackTemplateRequest, DescribeLiveStreamStateRequest, DescribeLivePlayAuthKeyResponse, DescribeLiveCallbackTemplatesRequest, DescribeLiveTranscodeRulesRequest, DeleteLiveSnapshotRuleRequest, DescribePlayErrorCodeDetailInfoListRequest, DeleteLivePullStreamTaskRequest, DescribePushBandwidthAndFluxListResponse, DescribeUploadStreamNumsRequest, DescribeLiveSnapshotRulesResponse, DescribeLiveTranscodeDetailInfoResponse, DescribeLiveDomainRequest, DescribeLiveStreamPublishedListRequest, DeleteLiveTranscodeRuleRequest, DescribePushBandwidthAndFluxListRequest, CreateLiveRecordRuleRequest, DescribeLiveSnapshotTemplatesRequest, AddLiveWatermarkResponse, DescribeLiveStreamPushInfoListResponse, DescribeLiveDomainCertResponse, DescribeLiveRecordTemplateRequest, ModifyLiveDomainCertRequest, CreateLiveWatermarkRuleResponse, ModifyLiveSnapshotTemplateResponse, DeleteScreenshotTaskRequest, DescribeProIspPlaySumInfoListRequest, DescribeDeliverBandwidthListRequest, DescribeScreenshotTaskResponse, AddLiveWatermarkRequest, ModifyLiveTranscodeTemplateResponse, ModifyLiveRecordTemplateResponse, ModifyLivePlayDomainRequest, DeleteLiveRecordTemplateResponse, DescribeLiveWatermarkRequest, DescribeLiveDomainCertRequest, DescribeLiveStreamEventListRequest, DescribePullStreamConfigsRequest, DescribePlayErrorCodeSumInfoListResponse, UnBindLiveDomainCertRequest, DeleteLiveRecordResponse, DescribeScreenShotSheetNumListRequest, ForbidLiveStreamRequest, DescribeLiveDomainsResponse, ModifyLivePullStreamTaskRequest, CreateLiveRecordResponse, UpdateLiveWatermarkResponse, DescribeRecordTaskRequest, CreateLiveTranscodeTemplateResponse, DescribeVisitTopSumInfoListRequest, ModifyPullStreamStatusResponse, ModifyLivePlayDomainResponse, CancelCommonMixStreamResponse, DescribeConcurrentRecordStreamNumResponse, DescribeLiveCertsResponse, DescribeProvinceIspPlayInfoListResponse, DescribeLiveRecordTemplatesResponse, DescribeScreenshotTaskRequest, DescribeCallbackRecordsListRequest, DescribeLiveCallbackTemplatesResponse, ModifyLivePlayAuthKeyResponse, CreateLiveCallbackTemplateRequest, DescribeTopClientIpSumInfoListResponse, DropLiveStreamResponse, DescribeLiveStreamStateResponse, DeletePullStreamConfigResponse, DeleteLiveWatermarkRuleRequest, DeleteRecordTaskResponse, DescribeLiveWatermarksRequest, DescribeLivePackageInfoResponse, CreateLiveTranscodeRuleRequest, DescribeLiveWatermarkRulesRequest, DropLiveStreamRequest, StopLiveRecordResponse, UpdateLiveWatermarkRequest, CreateCommonMixStreamRequest, CreateLiveCertResponse, AddDelayLiveStreamRequest, DescribeGroupProIspPlayInfoListRequest, ModifyPullStreamStatusRequest, DescribeStreamDayPlayInfoListRequest, DescribeLiveSnapshotTemplateResponse, DescribeLiveTranscodeRulesResponse, DescribeLiveDomainRefererResponse, AddLiveDomainRequest, DescribeLivePackageInfoRequest, CreatePullStreamConfigRequest, DescribeLiveCertsRequest, DescribeLivePullStreamTasksRequest, AddLiveDomainResponse, DescribeHttpStatusInfoListRequest, ModifyPullStreamConfigResponse, ModifyLiveCallbackTemplateRequest, DescribeProvinceIspPlayInfoListRequest, DescribeLivePlayAuthKeyRequest, DeleteLivePullStreamTaskResponse, DescribeLiveForbidStreamListResponse, DescribeStreamPushInfoListRequest, DescribeLivePullStreamTasksResponse, ModifyLivePushAuthKeyResponse, DescribeLiveWatermarkResponse, ResumeLiveStreamResponse, DescribeLiveStreamOnlineListResponse, DeletePullStreamConfigRequest, ModifyPullStreamConfigRequest, DescribeStreamPushInfoListResponse, DescribeLiveStreamPushInfoListRequest, DescribeLiveWatermarksResponse, DescribeLiveForbidStreamListRequest, DescribeLiveDomainPlayInfoListRequest, CreatePullStreamConfigResponse, BindLiveDomainCertRequest, DescribeTopClientIpSumInfoListRequest, CreateLiveCallbackRuleRequest, DeleteLiveWatermarkRuleResponse, DescribeCallbackRecordsListResponse, ModifyLiveCertResponse, DescribePlayErrorCodeSumInfoListRequest, DescribeLiveTranscodeDetailInfoRequest, ModifyLiveDomainRefererResponse, DeleteLiveWatermarkRequest, DescribeLiveDomainsRequest, DeleteLiveSnapshotRuleResponse, CreateLiveRecordRequest, ForbidLiveStreamResponse, DescribeLogDownloadListResponse, CancelCommonMixStreamRequest, DescribeRecordTaskResponse, DescribeLiveDelayInfoListResponse, DeleteLiveTranscodeTemplateRequest, DescribeLiveCallbackRulesRequest, DescribeLiveTranscodeTemplateResponse, CreateLiveSnapshotTemplateResponse, DescribeConcurrentRecordStreamNumRequest, DeleteScreenshotTaskResponse, ModifyLiveCertRequest, ModifyLiveRecordTemplateRequest, DescribeAreaBillBandwidthAndFluxListResponse, ForbidLiveDomainRequest, DescribeLiveRecordRulesRequest, DescribePlayErrorCodeDetailInfoListResponse, CreateLiveRecordTemplateResponse, DeleteLiveRecordRequest, DescribeLiveSnapshotTemplatesResponse, StopRecordTaskRequest, DescribeLiveDomainRefererRequest, DescribeStreamPlayInfoListRequest, CreateLiveTranscodeTemplateRequest, DescribeLiveStreamPublishedListResponse, DeleteLiveDomainRequest, ForbidLiveDomainResponse, AddDelayLiveStreamResponse, DescribeLiveTranscodeTemplatesResponse, DeleteLiveCallbackRuleRequest, ModifyLiveTranscodeTemplateRequest, ModifyLiveDomainCertResponse, ModifyLiveCallbackTemplateResponse, EnableLiveDomainRequest, DescribeAllStreamPlayInfoListResponse, DescribeLiveTranscodeTotalInfoResponse, DescribeLiveSnapshotRulesRequest, CreateRecordTaskRequest, CreateLiveTranscodeRuleResponse, CreateLiveCallbackRuleResponse, DescribeLiveRecordTemplateResponse, DescribeAreaBillBandwidthAndFluxListRequest, BindLiveDomainCertResponse, DescribeLiveTranscodeTemplatesRequest, DescribeBillBandwidthAndFluxListRequest, DescribeLiveRecordRulesResponse, CreateLiveSnapshotTemplateRequest, DescribeLiveDomainPlayInfoListResponse, DescribeLiveStreamOnlineListRequest, DeleteLiveSnapshotTemplateResponse, DescribeLiveSnapshotTemplateRequest, DeleteLiveCertResponse, CreateCommonMixStreamResponse, ModifyLiveDomainRefererRequest, CreateLiveCallbackTemplateResponse, DescribeLivePushAuthKeyRequest, DescribeLiveCallbackTemplateRequest, ModifyLiveSnapshotTemplateRequest, DescribeLiveCertResponse, CreateLiveRecordRuleResponse, DescribeLiveTranscodeTemplateRequest, DescribeLogDownloadListRequest, DeleteLiveWatermarkResponse, DescribeLivePushAuthKeyResponse, CreateLiveWatermarkRuleRequest, DescribeLiveRecordTemplatesRequest, DescribeAllStreamPlayInfoListRequest, DescribeLiveDomainResponse, DeleteRecordTaskRequest, DescribeStreamDayPlayInfoListResponse, StopLiveRecordRequest, DescribeVisitTopSumInfoListResponse, ModifyLivePullStreamTaskResponse, CreateLiveSnapshotRuleResponse, DescribeLiveStreamEventListResponse, DescribePullStreamConfigsResponse, DescribeLiveCallbackRulesResponse, DescribeLiveTranscodeTotalInfoRequest, StopScreenshotTaskResponse, CreateRecordTaskResponse, ResumeDelayLiveStreamResponse, DeleteLiveDomainResponse, CreateLiveRecordTemplateRequest, DescribeProIspPlaySumInfoListResponse, DeleteLiveCertRequest, DescribeHttpStatusInfoListResponse, DeleteLiveRecordRuleResponse } from "./live_models";
|
|
3
3
|
/**
|
|
4
4
|
* live client
|
|
5
5
|
* @class
|
|
@@ -66,9 +66,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
66
66
|
*/
|
|
67
67
|
DescribeLiveStreamEventList(req: DescribeLiveStreamEventListRequest, cb?: (error: string, rep: DescribeLiveStreamEventListResponse) => void): Promise<DescribeLiveStreamEventListResponse>;
|
|
68
68
|
/**
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
69
|
+
* 该接口用来创建通用混流。用法与旧接口 mix_streamv2.start_mix_stream_advanced 基本一致。
|
|
70
|
+
注意：当前最多支持16路混流。
|
|
71
|
+
最佳实践：https://cloud.tencent.com/document/product/267/45566
|
|
72
|
+
*/
|
|
73
|
+
CreateCommonMixStream(req: CreateCommonMixStreamRequest, cb?: (error: string, rep: CreateCommonMixStreamResponse) => void): Promise<CreateCommonMixStreamResponse>;
|
|
72
74
|
/**
|
|
73
75
|
* 查询某段时间内5分钟粒度的各播放http状态码的个数。
|
|
74
76
|
备注：数据延迟1小时，如10:00-10:59点的数据12点才能查到。
|
|
@@ -107,6 +109,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
107
109
|
* 修改直播拉流配置的状态。
|
|
108
110
|
*/
|
|
109
111
|
ModifyPullStreamStatus(req: ModifyPullStreamStatusRequest, cb?: (error: string, rep: ModifyPullStreamStatusResponse) => void): Promise<ModifyPullStreamStatusResponse>;
|
|
112
|
+
/**
|
|
113
|
+
* 创建一个在指定时间启动、结束的截图任务，并使用指定截图模板ID对应的配置进行截图。
|
|
114
|
+
- 注意事项
|
|
115
|
+
1. 断流会结束当前截图。在结束时间到达之前任务仍然有效，期间只要正常推流都会正常截图，与是否多次推、断流无关。
|
|
116
|
+
2. 使用上避免创建时间段相互重叠的截图任务。若同一条流当前存在多个时段重叠的任务，为避免重复系统将启动最多3个截图任务。
|
|
117
|
+
3. 创建的截图任务记录在平台侧只保留3个月。
|
|
118
|
+
4. 当前截图任务管理API（CreateScreenshotTask/StopScreenshotTask/DeleteScreenshotTask）与旧API（CreateLiveInstantSnapshot/StopLiveInstantSnapshot）不兼容，两套接口不能混用。
|
|
119
|
+
5. 避免 创建截图任务 与 推流 操作同时进行，可能导致因截图任务未生效而引起任务延迟启动问题，两者操作间隔建议大于3秒。
|
|
120
|
+
*/
|
|
121
|
+
CreateScreenshotTask(req: CreateScreenshotTaskRequest, cb?: (error: string, rep: CreateScreenshotTaskResponse) => void): Promise<CreateScreenshotTaskResponse>;
|
|
110
122
|
/**
|
|
111
123
|
* 获取录制模板列表。
|
|
112
124
|
*/
|
|
@@ -179,11 +191,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
179
191
|
*/
|
|
180
192
|
DescribeLiveRecordTemplate(req: DescribeLiveRecordTemplateRequest, cb?: (error: string, rep: DescribeLiveRecordTemplateResponse) => void): Promise<DescribeLiveRecordTemplateResponse>;
|
|
181
193
|
/**
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
194
|
+
* 提前结束截图，中止运行中的截图任务。任务被成功终止后，本次任务将不再启动。
|
|
195
|
+
*/
|
|
196
|
+
StopScreenshotTask(req: StopScreenshotTaskRequest, cb?: (error: string, rep: StopScreenshotTaskResponse) => void): Promise<StopScreenshotTaskResponse>;
|
|
197
|
+
/**
|
|
198
|
+
* 查询直播拉流配置。
|
|
199
|
+
*/
|
|
200
|
+
DescribePullStreamConfigs(req: DescribePullStreamConfigsRequest, cb?: (error: string, rep: DescribePullStreamConfigsResponse) => void): Promise<DescribePullStreamConfigsResponse>;
|
|
187
201
|
/**
|
|
188
202
|
* 删除水印。
|
|
189
203
|
*/
|
|
@@ -410,11 +424,22 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
410
424
|
注意：分页最多支持查询1万条记录，可通过调整查询时间范围来获取更多数据。
|
|
411
425
|
*/
|
|
412
426
|
DescribeLiveStreamPublishedList(req: DescribeLiveStreamPublishedListRequest, cb?: (error: string, rep: DescribeLiveStreamPublishedListResponse) => void): Promise<DescribeLiveStreamPublishedListResponse>;
|
|
427
|
+
/**
|
|
428
|
+
* 查询指定时间段范围内启动和结束的截图任务列表。
|
|
429
|
+
- 使用前提
|
|
430
|
+
1. 仅用于查询由 CreateScreenshotTask接口创建的截图任务。
|
|
431
|
+
2. 不能查询被 DeleteScreenshotTask接口删除以及已过期（平台侧保留3个月）的截图任务。
|
|
432
|
+
*/
|
|
433
|
+
DescribeScreenshotTask(req: DescribeScreenshotTaskRequest, cb?: (error: string, rep: DescribeScreenshotTaskResponse) => void): Promise<DescribeScreenshotTaskResponse>;
|
|
413
434
|
/**
|
|
414
435
|
* 直播推流带宽和流量数据查询。
|
|
415
436
|
推流计费会先取全球推流用量和全球播放用量进行比较，满足计费条件后再按各地区用量出账。详情参见[计费文档](https://cloud.tencent.com/document/product/267/34175)。
|
|
416
437
|
*/
|
|
417
438
|
DescribePushBandwidthAndFluxList(req: DescribePushBandwidthAndFluxListRequest, cb?: (error: string, rep: DescribePushBandwidthAndFluxListResponse) => void): Promise<DescribePushBandwidthAndFluxListResponse>;
|
|
439
|
+
/**
|
|
440
|
+
* 删除截图任务配置。删除操作不影响正在运行当中的任务，仅对删除之后新的推流有效。
|
|
441
|
+
*/
|
|
442
|
+
DeleteScreenshotTask(req: DeleteScreenshotTaskRequest, cb?: (error: string, rep: DeleteScreenshotTaskResponse) => void): Promise<DeleteScreenshotTaskResponse>;
|
|
418
443
|
/**
|
|
419
444
|
* 禁止某条流的推送，可以预设某个时刻将流恢复。
|
|
420
445
|
*/
|
|
@@ -105,10 +105,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
105
105
|
return this.request("DescribeLiveStreamEventList", req, cb);
|
|
106
106
|
}
|
|
107
107
|
/**
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
108
|
+
* 该接口用来创建通用混流。用法与旧接口 mix_streamv2.start_mix_stream_advanced 基本一致。
|
|
109
|
+
注意：当前最多支持16路混流。
|
|
110
|
+
最佳实践：https://cloud.tencent.com/document/product/267/45566
|
|
111
|
+
*/
|
|
112
|
+
async CreateCommonMixStream(req, cb) {
|
|
113
|
+
return this.request("CreateCommonMixStream", req, cb);
|
|
112
114
|
}
|
|
113
115
|
/**
|
|
114
116
|
* 查询某段时间内5分钟粒度的各播放http状态码的个数。
|
|
@@ -166,6 +168,18 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
166
168
|
async ModifyPullStreamStatus(req, cb) {
|
|
167
169
|
return this.request("ModifyPullStreamStatus", req, cb);
|
|
168
170
|
}
|
|
171
|
+
/**
|
|
172
|
+
* 创建一个在指定时间启动、结束的截图任务，并使用指定截图模板ID对应的配置进行截图。
|
|
173
|
+
- 注意事项
|
|
174
|
+
1. 断流会结束当前截图。在结束时间到达之前任务仍然有效，期间只要正常推流都会正常截图，与是否多次推、断流无关。
|
|
175
|
+
2. 使用上避免创建时间段相互重叠的截图任务。若同一条流当前存在多个时段重叠的任务，为避免重复系统将启动最多3个截图任务。
|
|
176
|
+
3. 创建的截图任务记录在平台侧只保留3个月。
|
|
177
|
+
4. 当前截图任务管理API（CreateScreenshotTask/StopScreenshotTask/DeleteScreenshotTask）与旧API（CreateLiveInstantSnapshot/StopLiveInstantSnapshot）不兼容，两套接口不能混用。
|
|
178
|
+
5. 避免 创建截图任务 与 推流 操作同时进行，可能导致因截图任务未生效而引起任务延迟启动问题，两者操作间隔建议大于3秒。
|
|
179
|
+
*/
|
|
180
|
+
async CreateScreenshotTask(req, cb) {
|
|
181
|
+
return this.request("CreateScreenshotTask", req, cb);
|
|
182
|
+
}
|
|
169
183
|
/**
|
|
170
184
|
* 获取录制模板列表。
|
|
171
185
|
*/
|
|
@@ -270,12 +284,16 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
270
284
|
return this.request("DescribeLiveRecordTemplate", req, cb);
|
|
271
285
|
}
|
|
272
286
|
/**
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
287
|
+
* 提前结束截图，中止运行中的截图任务。任务被成功终止后，本次任务将不再启动。
|
|
288
|
+
*/
|
|
289
|
+
async StopScreenshotTask(req, cb) {
|
|
290
|
+
return this.request("StopScreenshotTask", req, cb);
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* 查询直播拉流配置。
|
|
294
|
+
*/
|
|
295
|
+
async DescribePullStreamConfigs(req, cb) {
|
|
296
|
+
return this.request("DescribePullStreamConfigs", req, cb);
|
|
279
297
|
}
|
|
280
298
|
/**
|
|
281
299
|
* 删除水印。
|
|
@@ -601,6 +619,15 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
601
619
|
async DescribeLiveStreamPublishedList(req, cb) {
|
|
602
620
|
return this.request("DescribeLiveStreamPublishedList", req, cb);
|
|
603
621
|
}
|
|
622
|
+
/**
|
|
623
|
+
* 查询指定时间段范围内启动和结束的截图任务列表。
|
|
624
|
+
- 使用前提
|
|
625
|
+
1. 仅用于查询由 CreateScreenshotTask接口创建的截图任务。
|
|
626
|
+
2. 不能查询被 DeleteScreenshotTask接口删除以及已过期（平台侧保留3个月）的截图任务。
|
|
627
|
+
*/
|
|
628
|
+
async DescribeScreenshotTask(req, cb) {
|
|
629
|
+
return this.request("DescribeScreenshotTask", req, cb);
|
|
630
|
+
}
|
|
604
631
|
/**
|
|
605
632
|
* 直播推流带宽和流量数据查询。
|
|
606
633
|
推流计费会先取全球推流用量和全球播放用量进行比较，满足计费条件后再按各地区用量出账。详情参见[计费文档](https://cloud.tencent.com/document/product/267/34175)。
|
|
@@ -608,6 +635,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
608
635
|
async DescribePushBandwidthAndFluxList(req, cb) {
|
|
609
636
|
return this.request("DescribePushBandwidthAndFluxList", req, cb);
|
|
610
637
|
}
|
|
638
|
+
/**
|
|
639
|
+
* 删除截图任务配置。删除操作不影响正在运行当中的任务，仅对删除之后新的推流有效。
|
|
640
|
+
*/
|
|
641
|
+
async DeleteScreenshotTask(req, cb) {
|
|
642
|
+
return this.request("DeleteScreenshotTask", req, cb);
|
|
643
|
+
}
|
|
611
644
|
/**
|
|
612
645
|
* 禁止某条流的推送，可以预设某个时刻将流恢复。
|
|
613
646
|
*/
|