tencentcloud-sdk-nodejs 4.0.294 → 4.0.295

package/src/services/live/v20180801/live_client.ts

@@ -23,13 +23,15 @@ import {
   EnableLiveDomainResponse,
   CreateLiveCertRequest,
   HlsSpecialParam,
+  TranscodeTotalInfo,
   StopRecordTaskResponse,
   DescribeDeliverBandwidthListResponse,
   DeleteLiveRecordRuleRequest,
   ResumeLiveStreamRequest,
   DeleteLiveTranscodeTemplateResponse,
+  StopScreenshotTaskRequest,
   DescribeBillBandwidthAndFluxListResponse,
-  TemplateInfo,
+  CreateScreenshotTaskResponse,
   DeleteLiveCallbackRuleResponse,
   ResumeDelayLiveStreamRequest,
   DescribeLiveWatermarkRulesResponse,
@@ -39,9 +41,10 @@ import {
   DescribeGroupProIspPlayInfoListResponse,
   PushAuthKeyInfo,
   DescribeUploadStreamNumsResponse,
+  PlayCodeTotalInfo,
   DeleteLiveRecordTemplateRequest,
   DeleteLiveCallbackTemplateResponse,
-  DescribeLiveStreamOnlineListResponse,
+  CreateScreenshotTaskRequest,
   PushQualityData,
   UnBindLiveDomainCertResponse,
   ModifyLivePlayAuthKeyRequest,
@@ -83,9 +86,10 @@ import {
   StreamOnlineInfo,
   CreateLiveWatermarkRuleResponse,
   ModifyLiveSnapshotTemplateResponse,
+  DeleteScreenshotTaskRequest,
   DescribeProIspPlaySumInfoListRequest,
   DescribeDeliverBandwidthListRequest,
-  PlayCodeTotalInfo,
+  DescribeScreenshotTaskResponse,
   AddLiveWatermarkRequest,
   ModifyLiveTranscodeTemplateResponse,
   BillCountryInfo,
@@ -127,6 +131,7 @@ import {
   CommonMixInputParam,
   DescribeProvinceIspPlayInfoListResponse,
   DescribeLiveRecordTemplatesResponse,
+  DescribeScreenshotTaskRequest,
   DescribeCallbackRecordsListRequest,
   DescribeLiveCallbackTemplatesResponse,
   ModifyLivePlayAuthKeyResponse,
@@ -135,7 +140,7 @@ import {
   DescribeTopClientIpSumInfoListResponse,
   DropLiveStreamResponse,
   DescribeLiveStreamStateResponse,
-  StopLiveRecordRequest,
+  ScreenshotTask,
   DeletePullStreamConfigResponse,
   DeleteLiveWatermarkRuleRequest,
   StreamEventInfo,
@@ -181,7 +186,7 @@ import {
   DomainInfoList,
   DescribeLiveWatermarkResponse,
   ResumeLiveStreamResponse,
-  ModifyLiveRecordTemplateRequest,
+  DescribeLiveStreamOnlineListResponse,
   DeletePullStreamConfigRequest,
   ModifyPullStreamConfigRequest,
   DescribeStreamPushInfoListResponse,
@@ -199,6 +204,7 @@ import {
   PublishTime,
   ModifyLiveCertResponse,
   MonitorStreamPlayInfo,
+  DescribePlayErrorCodeSumInfoListRequest,
   DescribeLiveTranscodeDetailInfoRequest,
   ModifyLiveDomainRefererResponse,
   DeleteLiveWatermarkRequest,
@@ -221,10 +227,10 @@ import {
   DescribeLiveTranscodeTemplateResponse,
   CreateLiveSnapshotTemplateResponse,
   DescribeConcurrentRecordStreamNumRequest,
-  DescribePlayErrorCodeSumInfoListRequest,
+  DeleteScreenshotTaskResponse,
   ModifyLiveCertRequest,
   CommonMixControlParams,
-  TranscodeTotalInfo,
+  ModifyLiveRecordTemplateRequest,
   DescribeAreaBillBandwidthAndFluxListResponse,
   ForbidLiveDomainRequest,
   DescribeLiveRecordRulesRequest,
@@ -293,6 +299,7 @@ import {
   DeleteRecordTaskRequest,
   PullStreamTaskInfo,
   DescribeStreamDayPlayInfoListResponse,
+  StopLiveRecordRequest,
   DescribeVisitTopSumInfoListResponse,
   ModifyLivePullStreamTaskResponse,
   CreateLiveSnapshotRuleResponse,
@@ -301,6 +308,7 @@ import {
   DescribePullStreamConfigsResponse,
   DescribeLiveCallbackRulesResponse,
   DescribeLiveTranscodeTotalInfoRequest,
+  StopScreenshotTaskResponse,
   CreateRecordTaskResponse,
   ForbidStreamInfo,
   ResumeDelayLiveStreamResponse,
@@ -308,6 +316,7 @@ import {
   DeleteLiveDomainResponse,
   CommonMixCropParams,
   CreateLiveRecordTemplateRequest,
+  TemplateInfo,
   DescribeProIspPlaySumInfoListResponse,
   DeleteLiveCertRequest,
   DescribeHttpStatusInfoListResponse,
@@ -437,13 +446,15 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 查询直播拉流配置。
-   */
-  async DescribePullStreamConfigs(
-    req: DescribePullStreamConfigsRequest,
-    cb?: (error: string, rep: DescribePullStreamConfigsResponse) => void
-  ): Promise<DescribePullStreamConfigsResponse> {
-    return this.request("DescribePullStreamConfigs", req, cb)
+     * 该接口用来创建通用混流。用法与旧接口 mix_streamv2.start_mix_stream_advanced 基本一致。
+注意：当前最多支持16路混流。
+最佳实践：https://cloud.tencent.com/document/product/267/45566
+     */
+  async CreateCommonMixStream(
+    req: CreateCommonMixStreamRequest,
+    cb?: (error: string, rep: CreateCommonMixStreamResponse) => void
+  ): Promise<CreateCommonMixStreamResponse> {
+    return this.request("CreateCommonMixStream", req, cb)
   }
 
   /**
@@ -538,6 +549,22 @@ export class Client extends AbstractClient {
     return this.request("ModifyPullStreamStatus", req, cb)
   }
 
+  /**
+     * 创建一个在指定时间启动、结束的截图任务，并使用指定截图模板ID对应的配置进行截图。
+- 注意事项
+1. 断流会结束当前截图。在结束时间到达之前任务仍然有效，期间只要正常推流都会正常截图，与是否多次推、断流无关。
+2. 使用上避免创建时间段相互重叠的截图任务。若同一条流当前存在多个时段重叠的任务，为避免重复系统将启动最多3个截图任务。
+3. 创建的截图任务记录在平台侧只保留3个月。
+4. 当前截图任务管理API（CreateScreenshotTask/StopScreenshotTask/DeleteScreenshotTask）与旧API（CreateLiveInstantSnapshot/StopLiveInstantSnapshot）不兼容，两套接口不能混用。
+5. 避免 创建截图任务 与 推流 操作同时进行，可能导致因截图任务未生效而引起任务延迟启动问题，两者操作间隔建议大于3秒。
+     */
+  async CreateScreenshotTask(
+    req: CreateScreenshotTaskRequest,
+    cb?: (error: string, rep: CreateScreenshotTaskResponse) => void
+  ): Promise<CreateScreenshotTaskResponse> {
+    return this.request("CreateScreenshotTask", req, cb)
+  }
+
   /**
    * 获取录制模板列表。
    */
@@ -706,15 +733,23 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 该接口用来创建通用混流。用法与旧接口 mix_streamv2.start_mix_stream_advanced 基本一致。
-注意：当前最多支持16路混流。
-最佳实践：https://cloud.tencent.com/document/product/267/45566
-     */
-  async CreateCommonMixStream(
-    req: CreateCommonMixStreamRequest,
-    cb?: (error: string, rep: CreateCommonMixStreamResponse) => void
-  ): Promise<CreateCommonMixStreamResponse> {
-    return this.request("CreateCommonMixStream", req, cb)
+   * 提前结束截图，中止运行中的截图任务。任务被成功终止后，本次任务将不再启动。
+   */
+  async StopScreenshotTask(
+    req: StopScreenshotTaskRequest,
+    cb?: (error: string, rep: StopScreenshotTaskResponse) => void
+  ): Promise<StopScreenshotTaskResponse> {
+    return this.request("StopScreenshotTask", req, cb)
+  }
+
+  /**
+   * 查询直播拉流配置。
+   */
+  async DescribePullStreamConfigs(
+    req: DescribePullStreamConfigsRequest,
+    cb?: (error: string, rep: DescribePullStreamConfigsResponse) => void
+  ): Promise<DescribePullStreamConfigsResponse> {
+    return this.request("DescribePullStreamConfigs", req, cb)
   }
 
   /**
@@ -1237,6 +1272,19 @@ DomainName+AppName+StreamName+TemplateId唯一标识单个转码规则，如需
     return this.request("DescribeLiveStreamPublishedList", req, cb)
   }
 
+  /**
+     * 查询指定时间段范围内启动和结束的截图任务列表。
+- 使用前提
+1. 仅用于查询由 CreateScreenshotTask接口创建的截图任务。
+2. 不能查询被 DeleteScreenshotTask接口删除以及已过期（平台侧保留3个月）的截图任务。
+     */
+  async DescribeScreenshotTask(
+    req: DescribeScreenshotTaskRequest,
+    cb?: (error: string, rep: DescribeScreenshotTaskResponse) => void
+  ): Promise<DescribeScreenshotTaskResponse> {
+    return this.request("DescribeScreenshotTask", req, cb)
+  }
+
   /**
      * 直播推流带宽和流量数据查询。
 推流计费会先取全球推流用量和全球播放用量进行比较，满足计费条件后再按各地区用量出账。详情参见[计费文档](https://cloud.tencent.com/document/product/267/34175)。
@@ -1248,6 +1296,16 @@ DomainName+AppName+StreamName+TemplateId唯一标识单个转码规则，如需
     return this.request("DescribePushBandwidthAndFluxList", req, cb)
   }
 
+  /**
+   * 删除截图任务配置。删除操作不影响正在运行当中的任务，仅对删除之后新的推流有效。
+   */
+  async DeleteScreenshotTask(
+    req: DeleteScreenshotTaskRequest,
+    cb?: (error: string, rep: DeleteScreenshotTaskResponse) => void
+  ): Promise<DeleteScreenshotTaskResponse> {
+    return this.request("DeleteScreenshotTask", req, cb)
+  }
+
   /**
    * 禁止某条流的推送，可以预设某个时刻将流恢复。
    */