tencentcloud-sdk-nodejs-trtc 4.0.397 → 4.0.432

package/src/services/trtc/v20190722/trtc_client.ts

@@ -17,83 +17,93 @@
  */
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
 import {
-  DescribeAbnormalEventResponse,
-  SdkAppIdRecordUsage,
-  EncodeParams,
-  DescribeAbnormalEventRequest,
-  DescribeScaleInfoRequest,
-  ModifyPictureResponse,
-  StartMCUMixTranscodeByStrRoomIdRequest,
-  LayoutParams,
-  DescribeScaleInfoResponse,
   CreatePictureRequest,
-  DescribeTrtcMcuTranscodeTimeRequest,
-  SdkAppIdTrtcMcuTranscodeTimeUsage,
-  RemoveUserByStrRoomIdRequest,
-  DismissRoomResponse,
-  EventMessage,
-  DescribeRecordStatisticRequest,
-  DescribeUserInformationRequest,
-  DescribeCallDetailRequest,
-  ScaleInfomation,
-  DescribeUserInformationResponse,
-  SdkAppIdNewTrtcTimeUsage,
-  DescribeTrtcMcuTranscodeTimeResponse,
+  MixLayout,
   RemoveUserByStrRoomIdResponse,
   StartMCUMixTranscodeRequest,
-  StopMCUMixTranscodeRequest,
-  DescribeCallDetailInfoResponse,
   DescribeUserEventRequest,
-  DescribeHistoryScaleRequest,
-  DeletePictureRequest,
-  TrtcTimeNewUsage,
-  DescribeRoomInformationResponse,
-  RecordUsage,
-  RemoveUserRequest,
+  StartMCUMixTranscodeByStrRoomIdRequest,
+  ScaleInfomation,
+  DescribeUserEventResponse,
+  StopMCUMixTranscodeByStrRoomIdResponse,
+  PictureInfo,
+  DescribeCallDetailInfoRequest,
+  MixTranscodeParams,
+  DescribeUserInfoRequest,
+  WaterMarkParams,
+  DescribeRecordStatisticResponse,
+  StartMCUMixTranscodeByStrRoomIdResponse,
+  CloudStorage,
+  TimeValue,
+  DismissRoomByStrRoomIdRequest,
+  EventMessage,
+  DescribeRecordStatisticRequest,
   DescribeRoomInfoRequest,
-  DescribeExternalTrtcMeasureRequest,
+  StorageParams,
+  CloudVod,
+  EncodeParams,
+  DescribeCallDetailInfoResponse,
+  TrtcTimeNewUsage,
   ModifyPictureRequest,
-  TimeValue,
-  StopMCUMixTranscodeByStrRoomIdRequest,
-  OutputParams,
-  QualityData,
-  AbnormalEvent,
-  StopMCUMixTranscodeByStrRoomIdResponse,
-  DeletePictureResponse,
+  SmallVideoLayoutParams,
+  SubscribeStreamUserIds,
+  WaterMarkImage,
   EventList,
   DescribeRoomInfoResponse,
-  DismissRoomRequest,
-  DescribeDetailEventResponse,
-  DismissRoomByStrRoomIdRequest,
-  UserInformation,
-  DescribeExternalTrtcMeasureResponse,
-  DescribeUserEventResponse,
-  DescribeCallDetailInfoRequest,
-  DescribePictureRequest,
-  DescribeUnusualEventRequest,
+  SdkAppIdTrtcMcuTranscodeTimeUsage,
   DescribeUserInfoResponse,
-  SmallVideoLayoutParams,
-  RemoveUserResponse,
-  PresetLayoutConfig,
+  ModifyPictureResponse,
+  StorageFile,
+  WaterMark,
+  DescribeScaleInfoResponse,
+  MixLayoutParams,
   StopMCUMixTranscodeResponse,
-  DescribeCallDetailResponse,
+  SdkAppIdNewTrtcTimeUsage,
+  RemoveUserRequest,
+  DismissRoomRequest,
+  DescribeUnusualEventRequest,
+  DescribeCloudRecordingRequest,
+  TencentVod,
+  StopMCUMixTranscodeRequest,
+  LayoutParams,
+  RecordUsage,
+  CreateCloudRecordingRequest,
+  OutputParams,
+  DeleteCloudRecordingResponse,
+  StopMCUMixTranscodeByStrRoomIdRequest,
+  QualityData,
+  DeletePictureResponse,
+  ModifyCloudRecordingRequest,
+  VideoParams,
   OneSdkAppIdTranscodeTimeUsagesInfo,
+  CreateCloudRecordingResponse,
+  StartMCUMixTranscodeResponse,
+  DescribeTrtcMcuTranscodeTimeResponse,
+  DeleteCloudRecordingRequest,
+  DescribePictureRequest,
+  DescribeExternalTrtcMeasureResponse,
   DescribePictureResponse,
+  DescribeTrtcMcuTranscodeTimeRequest,
+  UserInformation,
+  DescribeScaleInfoRequest,
+  DismissRoomByStrRoomIdResponse,
+  DescribeUnusualEventResponse,
+  ModifyCloudRecordingResponse,
+  AbnormalEvent,
+  DescribeCloudRecordingResponse,
+  DismissRoomResponse,
+  DeletePictureRequest,
+  DescribeExternalTrtcMeasureRequest,
+  RemoveUserByStrRoomIdRequest,
+  RecordParams,
+  SdkAppIdRecordUsage,
+  PresetLayoutConfig,
+  AudioParams,
   PublishCdnParams,
-  DescribeRoomInformationRequest,
-  DescribeUserInfoRequest,
-  DescribeDetailEventRequest,
   AbnormalExperience,
-  StartMCUMixTranscodeResponse,
   RoomState,
   CreatePictureResponse,
-  WaterMarkParams,
-  DescribeRecordStatisticResponse,
-  DismissRoomByStrRoomIdResponse,
-  DescribeHistoryScaleResponse,
-  DescribeUnusualEventResponse,
-  StartMCUMixTranscodeByStrRoomIdResponse,
-  PictureInfo,
+  RemoveUserResponse,
 } from "./trtc_models"
 
 /**
@@ -106,9 +116,11 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-   * 查询SdkAppId下的房间列表。默认返回10条通话，一次最多返回100条通话。可查询14天内的数据。（同老接口DescribeRoomInformation）
-   **注意**：该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
-   */
+     * 查询SdkAppId下的房间列表。默认返回10条通话，一次最多返回100条通话。可查询14天内的数据。（同老接口DescribeRoomInformation）
+**注意**：
+1.该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
+2.该接口目前免费提供中，监控仪表盘商业化计费后该接口需要订阅付费版后方可调用，仪表盘商业化说明请见：https://cloud.tencent.com/document/product/647/77735
+     */
   async DescribeRoomInfo(
     req: DescribeRoomInfoRequest,
     cb?: (error: string, rep: DescribeRoomInfoResponse) => void
@@ -147,20 +159,11 @@ TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过
   }
 
   /**
-   * 查询SdkAppId下的房间列表。默认返回10条通话，一次最多返回100条通话。可查询14天内的数据。
-   **注意**：该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
-   */
-  async DescribeRoomInformation(
-    req: DescribeRoomInformationRequest,
-    cb?: (error: string, rep: DescribeRoomInformationResponse) => void
-  ): Promise<DescribeRoomInformationResponse> {
-    return this.request("DescribeRoomInformation", req, cb)
-  }
-
-  /**
-   * 查询指定时间内的用户列表及用户通话质量数据，可查询14天内数据。DataType 不为null，查询起止时间不超过1个小时，查询用户不超过6个，支持跨天查询。DataType为null时，查询起止时间不超过4个小时， 默认查询6个用户，同时支持每页查询100以内用户个数（PageSize不超过100）。接口用于查询质量问题，不推荐作为计费使用。（同老接口DescribeCallDetail）
-   **注意**：该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
-   */
+     * 查询指定时间内的用户列表及用户通话质量数据，可查询14天内数据。DataType 不为null，查询起止时间不超过1个小时，查询用户不超过6个，支持跨天查询。DataType为null时，查询起止时间不超过4个小时， 默认查询6个用户，同时支持每页查询100以内用户个数（PageSize不超过100）。接口用于查询质量问题，不推荐作为计费使用。（同老接口DescribeCallDetail）
+**注意**：
+1.该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
+2.该接口目前免费提供中，监控仪表盘商业化计费后该接口需要订阅付费版后方可调用，仪表盘商业化说明请见：https://cloud.tencent.com/document/product/647/77735
+     */
   async DescribeCallDetailInfo(
     req: DescribeCallDetailInfoRequest,
     cb?: (error: string, rep: DescribeCallDetailInfoResponse) => void
@@ -178,16 +181,6 @@ TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过
     return this.request("StopMCUMixTranscode", req, cb)
   }
 
-  /**
-   * 可查询SdkAppId每天的房间数和用户数，按天统计，可查询最近14天的数据。当天未结束，数据未统计完成，无法查到当天的房间数与用户数
-   */
-  async DescribeHistoryScale(
-    req: DescribeHistoryScaleRequest,
-    cb?: (error: string, rep: DescribeHistoryScaleResponse) => void
-  ): Promise<DescribeHistoryScaleResponse> {
-    return this.request("DescribeHistoryScale", req, cb)
-  }
-
   /**
    * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印，可通过此接口删除已上传的图片。无需频繁删除图片的场景，建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
    */
@@ -219,14 +212,13 @@ TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过
   }
 
   /**
-   * 查询指定时间内的用户列表及用户通话质量数据，可查询14天内数据。DataType 不为null，查询起止时间不超过1个小时，查询用户不超过6个，支持跨天查询。DataType为null时，查询起止时间不超过4个小时， 默认查询6个用户，同时支持每页查询100以内用户个数（PageSize不超过100）。接口用于查询质量问题，不推荐作为计费使用。
-   **注意**：该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
+   * 成功开启录制后，可以使用此接口来更新录制任务。仅在录制任务进行时有效，录制退出后更新将会返回错误。更新操作是全量覆盖，并不是增量更新的模式，也就是说每次更新都需要携带全量的信息。
    */
-  async DescribeCallDetail(
-    req: DescribeCallDetailRequest,
-    cb?: (error: string, rep: DescribeCallDetailResponse) => void
-  ): Promise<DescribeCallDetailResponse> {
-    return this.request("DescribeCallDetail", req, cb)
+  async ModifyCloudRecording(
+    req: ModifyCloudRecordingRequest,
+    cb?: (error: string, rep: ModifyCloudRecordingResponse) => void
+  ): Promise<ModifyCloudRecordingResponse> {
+    return this.request("ModifyCloudRecording", req, cb)
   }
 
   /**
@@ -239,6 +231,27 @@ TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过
     return this.request("DescribeUserEvent", req, cb)
   }
 
+  /**
+     * 接口说明：
+启动云端录制功能，完成房间内的音视频录制，并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制有或者多路视频画面混流一路。
+
+您可以通过此接口实现如下目标：
+* 指定订阅流参数（RecordParams）来指定需要录制的主播的黑名单或者白名单。
+* 指定第三方存储的参数（StorageParams）来指定上传到您希望的云存储，目前仅支持云点播存储（CloudVod）
+* 指定混流模式下的音视频转码详细参数（MixTranscodeParams），包括视频分辨率、视频码率、视频帧率、以及声音质量等
+* 指定混流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。
+
+关键名词：
+* 单流录制：分别录制房间的订阅UserId的音频和视频。录制服务会实时将录制文件上传至云点播存储。
+* 合流录制：将房间内订阅UserId的音视频混录成一个音视频文件，并将录制文件上传至云点播存储。
+     */
+  async CreateCloudRecording(
+    req: CreateCloudRecordingRequest,
+    cb?: (error: string, rep: CreateCloudRecordingResponse) => void
+  ): Promise<CreateCloudRecordingResponse> {
+    return this.request("CreateCloudRecording", req, cb)
+  }
+
   /**
    * 获取Trtc的用量统计数据。走计费渠道二期 只允许查两天的数据
    */
@@ -270,9 +283,11 @@ TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过
   }
 
   /**
-   * 查询指定时间内的用户列表，可查询14天内数据，查询起止时间不超过4小时。默认每页查询6个用户，支持每页最大查询100个用户PageSize不超过100）。（同老接口DescribeUserInformation）
-   **注意**：该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
-   */
+     * 查询指定时间内的用户列表，可查询14天内数据，查询起止时间不超过4小时。默认每页查询6个用户，支持每页最大查询100个用户PageSize不超过100）。（同老接口DescribeUserInformation）
+**注意**：
+1.该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
+2.该接口目前免费提供中，监控仪表盘商业化计费后该接口需要订阅付费版后方可调用，仪表盘商业化说明请见：https://cloud.tencent.com/document/product/647/77735
+     */
   async DescribeUserInfo(
     req: DescribeUserInfoRequest,
     cb?: (error: string, rep: DescribeUserInfoResponse) => void
@@ -300,17 +315,6 @@ TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过
     return this.request("StopMCUMixTranscodeByStrRoomId", req, cb)
   }
 
-  /**
-     * 查询SdkAppId下任意20条异常体验事件，返回异常体验ID与可能产生异常体验的原因。可查询14天内数据，查询起止时间不超过1个小时。支持跨天查询。
-异常体验ID映射见：https://cloud.tencent.com/document/product/647/44916
-     */
-  async DescribeAbnormalEvent(
-    req: DescribeAbnormalEventRequest,
-    cb?: (error: string, rep: DescribeAbnormalEventResponse) => void
-  ): Promise<DescribeAbnormalEventResponse> {
-    return this.request("DescribeAbnormalEvent", req, cb)
-  }
-
   /**
      * 接口说明：启动云端混流，并指定混流画面中各路画面的布局位置。
 
@@ -390,6 +394,27 @@ TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过
     return this.request("DescribeTrtcMcuTranscodeTime", req, cb)
   }
 
+  /**
+     * 成功开启录制后，可以使用此接口来查询录制状态。仅在录制任务进行时有效，录制退出后查询将会返回错误。
+录制文件上传到云点播VOD时，StorageFileList中不会返回录制文件信息，请订阅相关录制文件回调事件，获取录制文件信息。
+     */
+  async DescribeCloudRecording(
+    req: DescribeCloudRecordingRequest,
+    cb?: (error: string, rep: DescribeCloudRecordingResponse) => void
+  ): Promise<DescribeCloudRecordingResponse> {
+    return this.request("DescribeCloudRecording", req, cb)
+  }
+
+  /**
+   * 成功开启录制后，可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成，如果未完成后台将会继续上传文件，成功后通过事件回调通知客户文件全部传输完成状态。
+   */
+  async DeleteCloudRecording(
+    req: DeleteCloudRecordingRequest,
+    cb?: (error: string, rep: DeleteCloudRecordingResponse) => void
+  ): Promise<DeleteCloudRecordingResponse> {
+    return this.request("DeleteCloudRecording", req, cb)
+  }
+
   /**
    * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息，可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景，建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
    */
@@ -400,16 +425,6 @@ TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过
     return this.request("DescribePicture", req, cb)
   }
 
-  /**
-   * 查询用户某次通话内的进退房，视频开关等详细事件。可查询14天内数据。
-   */
-  async DescribeDetailEvent(
-    req: DescribeDetailEventRequest,
-    cb?: (error: string, rep: DescribeDetailEventResponse) => void
-  ): Promise<DescribeDetailEventResponse> {
-    return this.request("DescribeDetailEvent", req, cb)
-  }
-
   /**
      * 查询SdkAppId下任意20条异常体验事件，返回异常体验ID与可能产生异常体验的原因。可查询14天内数据，查询起止时间不超过1个小时。支持跨天查询。（同老接口DescribeAbnormalEvent）
 异常体验ID映射见：https://cloud.tencent.com/document/product/647/44916
@@ -420,15 +435,4 @@ TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过
   ): Promise<DescribeUnusualEventResponse> {
     return this.request("DescribeUnusualEvent", req, cb)
   }
-
-  /**
-   * 查询指定时间内的用户列表，可查询14天内数据，查询起止时间不超过4小时。默认每页查询6个用户，支持每页最大查询100个用户PageSize不超过100）。
-   **注意**：该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
-   */
-  async DescribeUserInformation(
-    req: DescribeUserInformationRequest,
-    cb?: (error: string, rep: DescribeUserInformationResponse) => void
-  ): Promise<DescribeUserInformationResponse> {
-    return this.request("DescribeUserInformation", req, cb)
-  }
 }