tencentcloud-sdk-nodejs 4.0.422 → 4.0.425

package/src/services/yinsuda/v20220527/yinsuda_client.ts

@@ -20,26 +20,46 @@ import { ClientConfig } from "../../../common/interface"
 import {
   DescribeKTVSuggestionsResponse,
   ChorusClip,
+  JoinRoomInput,
+  DestroyKTVRobotResponse,
   MusicAlbumCoverInfo,
+  CreateKTVRobotRequest,
   KTVSuggestionInfo,
+  SyncKTVRobotCommandRequest,
   DescribeKTVPlaylistDetailRequest,
+  CreateKTVRobotResponse,
   DescribeKTVSuggestionsRequest,
   DescribeKTVMatchMusicsRequest,
   DescribeKTVPlaylistsResponse,
   DescribeKTVPlaylistsRequest,
   DescribeKTVPlaylistDetailResponse,
+  SetDestroyModeCommandInput,
+  SetAudioParamCommandInput,
   KTVMatchMusic,
-  SearchKTVMusicsResponse,
+  TRTCJoinRoomInput,
+  DescribeKTVRobotsResponse,
+  PlayCommandInput,
   BatchDescribeKTVMusicDetailsRequest,
   KTVMusicDetailInfo,
   MusicAlbumInfo,
+  SetPlayModeCommandInput,
+  SyncRobotCommand,
+  SearchKTVMusicsResponse,
+  KTVRobotInfo,
   DescribeKTVMatchMusicsResponse,
   KTVMatchRuleMusicInfo,
+  SetPlaylistCommandInput,
+  SyncKTVRobotCommandResponse,
   BatchDescribeKTVMusicDetailsResponse,
+  KTVMatchRule,
   KTVMusicBaseInfo,
   SearchKTVMusicsRequest,
+  TimeRange,
   KTVPlaylistBaseInfo,
-  KTVMatchRule,
+  SendMessageCommandInput,
+  DestroyKTVRobotRequest,
+  DescribeKTVRobotsRequest,
+  SeekCommandInput,
 } from "./yinsuda_models"
 
 /**
@@ -51,6 +71,26 @@ export class Client extends AbstractClient {
     super("yinsuda.tencentcloudapi.com", "2022-05-27", clientConfig)
   }
 
+  /**
+   * 创建机器人，支持进入 RTC 房间，播放曲库歌曲。
+   */
+  async CreateKTVRobot(
+    req: CreateKTVRobotRequest,
+    cb?: (error: string, rep: CreateKTVRobotResponse) => void
+  ): Promise<CreateKTVRobotResponse> {
+    return this.request("CreateKTVRobot", req, cb)
+  }
+
+  /**
+   * 下发操作机器人指令，支持播放、暂停、恢复、歌单设置等操作指令，实现对机器人行为的控制。
+   */
+  async SyncKTVRobotCommand(
+    req: SyncKTVRobotCommandRequest,
+    cb?: (error: string, rep: SyncKTVRobotCommandResponse) => void
+  ): Promise<SyncKTVRobotCommandResponse> {
+    return this.request("SyncKTVRobotCommand", req, cb)
+  }
+
   /**
    * 根据歌单 Id 获取歌单详情。
    */
@@ -61,6 +101,16 @@ export class Client extends AbstractClient {
     return this.request("DescribeKTVPlaylistDetail", req, cb)
   }
 
+  /**
+   * 销毁机器人，机器人退出 RTC 房间。
+   */
+  async DestroyKTVRobot(
+    req: DestroyKTVRobotRequest,
+    cb?: (error: string, rep: DestroyKTVRobotResponse) => void
+  ): Promise<DestroyKTVRobotResponse> {
+    return this.request("DestroyKTVRobot", req, cb)
+  }
+
   /**
    * 根据关键词获取联想词列表。
    */
@@ -91,6 +141,16 @@ export class Client extends AbstractClient {
     return this.request("DescribeKTVPlaylists", req, cb)
   }
 
+  /**
+   * 获取机器人列表，支持 Id、状态等过滤条件。
+   */
+  async DescribeKTVRobots(
+    req: DescribeKTVRobotsRequest,
+    cb?: (error: string, rep: DescribeKTVRobotsResponse) => void
+  ): Promise<DescribeKTVRobotsResponse> {
+    return this.request("DescribeKTVRobots", req, cb)
+  }
+
   /**
    * 根据输入的规则匹配曲库中的歌曲。
    */

package/src/services/yinsuda/v20220527/yinsuda_models.ts

@@ -45,6 +45,26 @@ export interface ChorusClip {
   EndTime: number
 }
 
+/**
+ * 直播进房输入参数
+ */
+export interface JoinRoomInput {
+  /**
+   * TRTC进房参数
+   */
+  TRTCJoinRoomInput: TRTCJoinRoomInput
+}
+
+/**
+ * DestroyKTVRobot返回参数结构体
+ */
+export interface DestroyKTVRobotResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 歌曲专辑封面信息。
  */
@@ -63,6 +83,37 @@ export interface MusicAlbumCoverInfo {
   Url: string
 }
 
+/**
+ * CreateKTVRobot请求参数结构体
+ */
+export interface CreateKTVRobotRequest {
+  /**
+   * 应用名称。
+   */
+  AppName: string
+
+  /**
+   * 用户标识。
+   */
+  UserId: string
+
+  /**
+      * RTC厂商类型，取值有：
+<li>TRTC</li>
+      */
+  RTCSystem: string
+
+  /**
+   * 进房参数。
+   */
+  JoinRoomInput: JoinRoomInput
+
+  /**
+   * 创建机器人时初始化参数。
+   */
+  SyncRobotCommands?: Array<SyncRobotCommand>
+}
+
 /**
  * 联想词信息。
  */
@@ -73,6 +124,31 @@ export interface KTVSuggestionInfo {
   Suggestion: string
 }
 
+/**
+ * SyncKTVRobotCommand请求参数结构体
+ */
+export interface SyncKTVRobotCommandRequest {
+  /**
+   * 应用名称。
+   */
+  AppName: string
+
+  /**
+   * 用户标识。
+   */
+  UserId: string
+
+  /**
+   * 机器人Id。
+   */
+  RobotId: string
+
+  /**
+   * 指令及指令参数数组。
+   */
+  SyncRobotCommands: Array<SyncRobotCommand>
+}
+
 /**
  * DescribeKTVPlaylistDetail请求参数结构体
  */
@@ -110,6 +186,21 @@ export interface DescribeKTVPlaylistDetailRequest {
   RightFilters?: Array<string>
 }
 
+/**
+ * CreateKTVRobot返回参数结构体
+ */
+export interface CreateKTVRobotResponse {
+  /**
+   * 机器人Id。
+   */
+  RobotId: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * DescribeKTVSuggestions请求参数结构体
  */
@@ -207,6 +298,36 @@ export interface DescribeKTVPlaylistDetailResponse {
   RequestId?: string
 }
 
+/**
+ * 设置销毁模式
+ */
+export interface SetDestroyModeCommandInput {
+  /**
+      * 销毁模式，取值有：
+<li>Auto：房间没人时自动销毁</li>
+<li>Expire：房间没人时过期自动销毁</li>
+<li>Never：不自动销毁，需手动销毁</li>默认为：Auto。
+      */
+  DestroyMode: string
+
+  /**
+   * 过期销毁时间，单位：秒，当DestroyMode取Expire时必填。
+   */
+  DestroyExpireTime?: number
+}
+
+/**
+ * 音频参数信息
+ */
+export interface SetAudioParamCommandInput {
+  /**
+      * 音频类型，取值有：
+<li>Original：原唱</li>
+<li>Accompaniment：伴奏</li>
+      */
+  Type?: string
+}
+
 /**
  * 匹配歌曲信息。
  */
@@ -223,18 +344,43 @@ export interface KTVMatchMusic {
 }
 
 /**
- * SearchKTVMusics返回参数结构体
+ * TRTC推流进房信息
  */
-export interface SearchKTVMusicsResponse {
+export interface TRTCJoinRoomInput {
   /**
-   * 歌曲信息列表。
+   * 签名。
    */
-  KTVMusicInfoSet: Array<KTVMusicBaseInfo>
+  Sign: string
 
   /**
-   * 滚动标记，用于设置下次请求的 ScrollToken 参数。
+   * 房间号。
    */
-  ScrollToken: string
+  RoomId: string
+
+  /**
+   * 推流应用ID。
+   */
+  SdkAppId: string
+
+  /**
+   * 用户唯一标识。
+   */
+  UserId: string
+}
+
+/**
+ * DescribeKTVRobots返回参数结构体
+ */
+export interface DescribeKTVRobotsResponse {
+  /**
+   * 机器人总数。
+   */
+  TotalCount: number
+
+  /**
+   * 机器人信息集合。
+   */
+  KTVRobotInfoSet: Array<KTVRobotInfo>
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -242,6 +388,16 @@ export interface SearchKTVMusicsResponse {
   RequestId?: string
 }
 
+/**
+ * 播放指令输入参数
+ */
+export interface PlayCommandInput {
+  /**
+   * 歌曲位置索引。
+   */
+  Index: number
+}
+
 /**
  * BatchDescribeKTVMusicDetails请求参数结构体
  */
@@ -317,6 +473,153 @@ export interface MusicAlbumInfo {
   CoverInfoSet: Array<MusicAlbumCoverInfo>
 }
 
+/**
+ * 设置播放模式
+ */
+export interface SetPlayModeCommandInput {
+  /**
+      * 播放模式，取值有：
+<li>RepeatPlaylist：列表循环</li>
+<li>Order：顺序播放</li>
+<li>RepeatSingle：单曲循环</li>
+<li>Shuffle：随机播放</li>
+      */
+  PlayMode: string
+}
+
+/**
+ * KTV 机器人初始化参数，在创建后自动完成相关初始化工作。
+ */
+export interface SyncRobotCommand {
+  /**
+      * 可同时传入多个指令，顺序执行。取值有：
+<li>Play：播放</li>
+<li>Pause：暂停</li>
+<li>SwitchPrevious：上一首</li>
+<li>SwitchNext：下一首</li>
+<li>SetPlayMode：设置播放模式</li>
+<li>Seek：调整播放进度</li>
+<li>SetPlaylist：歌单变更</li>
+<li>SetAudioParam：音频参数变更</li>
+<li>SendMessage：发送自定义消息</li>
+<li>SetDestroyMode：设置销毁模式</li>
+      */
+  Command: string
+
+  /**
+   * 播放参数。
+   */
+  PlayCommandInput?: PlayCommandInput
+
+  /**
+   * 播放列表变更信息，当Command取SetPlaylist时，必填。
+   */
+  SetPlaylistCommandInput?: SetPlaylistCommandInput
+
+  /**
+   * 播放进度，当Command取Seek时，必填。
+   */
+  SeekCommandInput?: SeekCommandInput
+
+  /**
+   * 音频参数，当Command取SetAudioParam时，必填。
+   */
+  SetAudioParamCommandInput?: SetAudioParamCommandInput
+
+  /**
+   * 自定义消息，当Command取SendMessage时，必填。
+   */
+  SendMessageCommandInput?: SendMessageCommandInput
+
+  /**
+   * 播放模式，当Command取SetPlayMode时，必填。
+   */
+  SetPlayModeCommandInput?: SetPlayModeCommandInput
+
+  /**
+   * 销毁模式，当Command取SetDestroyMode时，必填。
+   */
+  SetDestroyModeCommandInput?: SetDestroyModeCommandInput
+}
+
+/**
+ * SearchKTVMusics返回参数结构体
+ */
+export interface SearchKTVMusicsResponse {
+  /**
+   * 歌曲信息列表。
+   */
+  KTVMusicInfoSet: Array<KTVMusicBaseInfo>
+
+  /**
+   * 滚动标记，用于设置下次请求的 ScrollToken 参数。
+   */
+  ScrollToken: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 机器人信息
+ */
+export interface KTVRobotInfo {
+  /**
+   * 机器人Id。
+   */
+  RobotId: string
+
+  /**
+      * 状态，取值有：
+<li>Play：播放</li>
+<li>Pause：暂停</li>
+<li>Destroy：销毁</li>
+      */
+  Status: string
+
+  /**
+   * 播放列表。
+   */
+  Playlists: Array<string>
+
+  /**
+   * 当前歌单索引位置。
+   */
+  CurIndex: number
+
+  /**
+   * 播放进度，单位：毫秒。
+   */
+  Position: number
+
+  /**
+   * 音频参数。
+   */
+  SetAudioParamInput: SetAudioParamCommandInput
+
+  /**
+   * 进房信息。
+   */
+  JoinRoomInput: JoinRoomInput
+
+  /**
+      * RTC厂商类型，取值有：
+<li>TRTC</li>
+      */
+  RTCSystem: string
+
+  /**
+      * 播放模式，PlayMode取值有：
+<li>RepeatPlaylist：列表循环</li>
+<li>Order：顺序播放</li>
+<li>RepeatSingle：单曲循环</li>
+<li>Shuffle：随机播放</li>
+      */
+  SetPlayModeInput: SetPlayModeCommandInput
+}
+
 /**
  * DescribeKTVMatchMusics返回参数结构体
  */
@@ -352,6 +655,48 @@ export interface KTVMatchRuleMusicInfo {
   SingerSet: Array<string>
 }
 
+/**
+ * 设置播放列表指令参数
+ */
+export interface SetPlaylistCommandInput {
+  /**
+      * 变更类型，取值有：
+<li>Add：添加</li>
+<li>Delete：删除</li>
+<li>ClearList：清空歌曲列表</li>
+<li>Move：移动歌曲</li>
+      */
+  Type: string
+
+  /**
+      * 歌单索引位置，
+当 Type 取 Add 时，-1表示添加在列表最后位置，大于-1表示要添加的位置；
+当 Type 取 Delete 时，表示待删除歌曲的位置；
+当 Type 取 Move 时，表示待调整歌曲的位置。
+      */
+  Index?: number
+
+  /**
+   * 当 Type 取 Move 时，必填，表示移动歌曲的目标位置。
+   */
+  ChangedIndex?: number
+
+  /**
+   * 歌曲 ID 列表，当 Type 取 Add 时，必填。
+   */
+  MusicIds?: Array<string>
+}
+
+/**
+ * SyncKTVRobotCommand返回参数结构体
+ */
+export interface SyncKTVRobotCommandResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * BatchDescribeKTVMusicDetails返回参数结构体
  */
@@ -372,6 +717,22 @@ export interface BatchDescribeKTVMusicDetailsResponse {
   RequestId?: string
 }
 
+/**
+ * 歌曲匹配规则。
+ */
+export interface KTVMatchRule {
+  /**
+   * AME 曲库 Id。
+   */
+  AMEMusicId?: string
+
+  /**
+      * 歌曲匹配信息。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  MusicInfo?: KTVMatchRuleMusicInfo
+}
+
 /**
  * 歌曲基础信息。
  */
@@ -459,6 +820,23 @@ export interface SearchKTVMusicsRequest {
   RightFilters?: Array<string>
 }
 
+/**
+ * 时间范围
+ */
+export interface TimeRange {
+  /**
+      * <li>大于等于此时间（起始时间）。</li>
+<li>格式按照 ISO 8601标准表示，详见 <a href="https://cloud.tencent.com/document/product/266/11732#I" target="_blank">ISO 日期格式说明</a>。</li>
+      */
+  Before?: string
+
+  /**
+      * <li>小于此时间（结束时间）。</li>
+<li>格式按照 ISO 8601标准表示，详见 <a href="https://cloud.tencent.com/document/product/266/11732#I" target="_blank">ISO 日期格式说明</a>。</li>
+      */
+  After?: string
+}
+
 /**
  * 歌单基础信息。
  */
@@ -475,17 +853,90 @@ export interface KTVPlaylistBaseInfo {
 }
 
 /**
- * 歌曲匹配规则。
+ * 发送自定义信息指令参数
  */
-export interface KTVMatchRule {
+export interface SendMessageCommandInput {
   /**
-   * AME 曲库 Id。
+   * 自定义消息，json格式字符串。
    */
-  AMEMusicId?: string
+  Message: string
 
   /**
-      * 歌曲匹配信息。
-注意：此字段可能返回 null，表示取不到有效值。
+   * 消息重复次数，默认为 1。
+   */
+  Repeat?: number
+}
+
+/**
+ * DestroyKTVRobot请求参数结构体
+ */
+export interface DestroyKTVRobotRequest {
+  /**
+   * 应用名称。
+   */
+  AppName: string
+
+  /**
+   * 用户标识。
+   */
+  UserId: string
+
+  /**
+   * 机器人Id。
+   */
+  RobotId: string
+}
+
+/**
+ * DescribeKTVRobots请求参数结构体
+ */
+export interface DescribeKTVRobotsRequest {
+  /**
+   * 应用名称。
+   */
+  AppName: string
+
+  /**
+   * 用户标识。
+   */
+  UserId: string
+
+  /**
+   * 机器人Id列表。
+   */
+  RobotIds?: Array<string>
+
+  /**
+      * 机器人状态，取值有：
+<li>Play：播放</li>
+<li>Pause：暂停</li>
+<li>Destroy：销毁</li>
       */
-  MusicInfo?: KTVMatchRuleMusicInfo
+  Statuses?: Array<string>
+
+  /**
+      * 匹配创建时间在此时间段内的机器人。
+<li>包含所指定的头尾时间点。</li>
+      */
+  CreateTime?: TimeRange
+
+  /**
+   * 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
+   */
+  Offset?: number
+
+  /**
+   * 分页返回的起始偏移量，默认值：10。
+   */
+  Limit?: number
+}
+
+/**
+ * 调整播放进度指令参数
+ */
+export interface SeekCommandInput {
+  /**
+   * 播放位置，单位：毫秒。
+   */
+  Position: number
 }

package/tencentcloud/common/sdk_version.d.ts

@@ -1 +1 @@
-export declare const sdkVersion = "4.0.422";
+export declare const sdkVersion = "4.0.425";

package/tencentcloud/common/sdk_version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sdkVersion = void 0;
-exports.sdkVersion = "4.0.422";
+exports.sdkVersion = "4.0.425";