AmeClient (tencentcloud-sdk-java 3.1.689 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.ame.v20190916.AmeClient

public class AmeClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`AmeClient(Credential credential, String region)`
`AmeClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchDescribeKTVMusicDetailsResponse`	`BatchDescribeKTVMusicDetails(BatchDescribeKTVMusicDetailsRequest req)` 根据 Id 列表查询歌曲的详细信息，包含基础信息及播放信息。
`CreateKTVRobotResponse`	`CreateKTVRobot(CreateKTVRobotRequest req)` 创建机器人，支持进入 RTC 房间，播放直播互动曲库歌曲。
`DescribeAuthInfoResponse`	`DescribeAuthInfo(DescribeAuthInfoRequest req)` 获取授权项目信息列表
`DescribeCloudMusicResponse`	`DescribeCloudMusic(DescribeCloudMusicRequest req)` 获取云音乐播放信息接口
`DescribeCloudMusicPurchasedResponse`	`DescribeCloudMusicPurchased(DescribeCloudMusicPurchasedRequest req)` 获取授权项目下已购云音乐列表
`DescribeItemByIdResponse`	`DescribeItemById(DescribeItemByIdRequest req)` 根据歌曲ID查询歌曲信息
`DescribeItemsResponse`	`DescribeItems(DescribeItemsRequest req)` 该服务后续会停用，不再建议使用
`DescribeKTVMusicDetailResponse`	`DescribeKTVMusicDetail(DescribeKTVMusicDetailRequest req)` 根据 Id 查询歌曲的详细信息，包含基础信息及播放信息。
`DescribeKTVMusicTagsResponse`	`DescribeKTVMusicTags(DescribeKTVMusicTagsRequest req)` 获取直播互动曲库标签分组信息和标签信息
`DescribeKTVPlaylistDetailResponse`	`DescribeKTVPlaylistDetail(DescribeKTVPlaylistDetailRequest req)` 根据歌单 Id 获取歌单详情，包括歌单的基础信息以及歌曲列表。
`DescribeKTVPlaylistsResponse`	`DescribeKTVPlaylists(DescribeKTVPlaylistsRequest req)` 获取直播互动曲库推荐歌单列表。
`DescribeKTVRobotsResponse`	`DescribeKTVRobots(DescribeKTVRobotsRequest req)` 获取机器人列表，支持 Id、状态等过滤条件。
`DescribeKTVSingerCategoriesResponse`	`DescribeKTVSingerCategories(DescribeKTVSingerCategoriesRequest req)` 获取直播互动曲库歌手分类信息
`DescribeKTVSingerMusicsResponse`	`DescribeKTVSingerMusics(DescribeKTVSingerMusicsRequest req)` 根据歌手id，返回该歌手下歌曲列表。
`DescribeKTVSingersResponse`	`DescribeKTVSingers(DescribeKTVSingersRequest req)` 根据过滤条件，返回匹配的歌手列表。
`DescribeKTVSuggestionsResponse`	`DescribeKTVSuggestions(DescribeKTVSuggestionsRequest req)` 获取直播互动曲库联想词
`DescribeKTVTopListResponse`	`DescribeKTVTopList(DescribeKTVTopListRequest req)` 获取直播互动曲库歌曲的周榜和月榜
`DescribeLyricResponse`	`DescribeLyric(DescribeLyricRequest req)` 根据接口的模式及歌曲ID来取得歌词信息或者波形图信息。
`DescribeMusicResponse`	`DescribeMusic(DescribeMusicRequest req)` 获取曲库包歌曲播放信息接口
`DescribeMusicSaleStatusResponse`	`DescribeMusicSaleStatus(DescribeMusicSaleStatusRequest req)` 根据音乐信息查询音乐是否在售
`DescribePackageItemsResponse`	`DescribePackageItems(DescribePackageItemsRequest req)` 获取曲库包下已核销歌曲列表接口
`DescribePackagesResponse`	`DescribePackages(DescribePackagesRequest req)` 获取已购曲库包列表接口
`DescribePkgOfflineMusicResponse`	`DescribePkgOfflineMusic(DescribePkgOfflineMusicRequest req)` 根据购买曲库包用户可查询已回退的歌曲信息
`DescribeStationsResponse`	`DescribeStations(DescribeStationsRequest req)` 该服务后续会停用，不再建议使用
`DestroyKTVRobotResponse`	`DestroyKTVRobot(DestroyKTVRobotRequest req)` 销毁机器人，机器人退出 RTC 房间。
`ModifyMusicOnShelvesResponse`	`ModifyMusicOnShelves(ModifyMusicOnShelvesRequest req)` 根据资源方，需要变更的参数，请求该接口进行变更，为空的参数默认为无变更
`PutMusicOnTheShelvesResponse`	`PutMusicOnTheShelves(PutMusicOnTheShelvesRequest req)` 根据资源方所传歌曲信息，进行歌曲上架，多个歌曲同时请求时，需构造复合结构进行请求
`ReportDataResponse`	`ReportData(ReportDataRequest req)` 客户上报用户数据功能，为了更好地为用户提供优质服务
`SearchKTVMusicsResponse`	`SearchKTVMusics(SearchKTVMusicsRequest req)` 根据搜索条件，返回匹配的歌曲列表。
`SyncKTVRobotCommandResponse`	`SyncKTVRobotCommand(SyncKTVRobotCommandRequest req)` 下发操作机器人指令，支持播放、暂停、恢复、歌单设置等操作指令，实现对机器人行为的控制。
`TakeMusicOffShelvesResponse`	`TakeMusicOffShelves(TakeMusicOffShelvesRequest req)` 根据资源方所传MusicId进行将歌曲进行下架，多个MusicId使用逗号隔开

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, internalRequest, retry, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AmeClient
```
public AmeClient(Credential credential,
                 String region)
```
  - AmeClient
```
public AmeClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- Method Detail
  - BatchDescribeKTVMusicDetails
```
public BatchDescribeKTVMusicDetailsResponse BatchDescribeKTVMusicDetails(BatchDescribeKTVMusicDetailsRequest req)
                                                                  throws TencentCloudSDKException
```
    根据 Id 列表查询歌曲的详细信息，包含基础信息及播放信息。
    
    Parameters:
    
    req - BatchDescribeKTVMusicDetailsRequest
    
    Returns:
    
    BatchDescribeKTVMusicDetailsResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateKTVRobot
```
public CreateKTVRobotResponse CreateKTVRobot(CreateKTVRobotRequest req)
                                      throws TencentCloudSDKException
```
    创建机器人，支持进入 RTC 房间，播放直播互动曲库歌曲。
    
    Parameters:
    
    req - CreateKTVRobotRequest
    
    Returns:
    
    CreateKTVRobotResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAuthInfo
```
public DescribeAuthInfoResponse DescribeAuthInfo(DescribeAuthInfoRequest req)
                                          throws TencentCloudSDKException
```
    获取授权项目信息列表
    
    Parameters:
    
    req - DescribeAuthInfoRequest
    
    Returns:
    
    DescribeAuthInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCloudMusic
```
public DescribeCloudMusicResponse DescribeCloudMusic(DescribeCloudMusicRequest req)
                                              throws TencentCloudSDKException
```
    获取云音乐播放信息接口
    
    Parameters:
    
    req - DescribeCloudMusicRequest
    
    Returns:
    
    DescribeCloudMusicResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCloudMusicPurchased
```
public DescribeCloudMusicPurchasedResponse DescribeCloudMusicPurchased(DescribeCloudMusicPurchasedRequest req)
                                                                throws TencentCloudSDKException
```
    获取授权项目下已购云音乐列表
    
    Parameters:
    
    req - DescribeCloudMusicPurchasedRequest
    
    Returns:
    
    DescribeCloudMusicPurchasedResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeItemById
```
public DescribeItemByIdResponse DescribeItemById(DescribeItemByIdRequest req)
                                          throws TencentCloudSDKException
```
    根据歌曲ID查询歌曲信息
    
    Parameters:
    
    req - DescribeItemByIdRequest
    
    Returns:
    
    DescribeItemByIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeItems
```
public DescribeItemsResponse DescribeItems(DescribeItemsRequest req)
                                    throws TencentCloudSDKException
```
    该服务后续会停用，不再建议使用
    
    Parameters:
    
    req - DescribeItemsRequest
    
    Returns:
    
    DescribeItemsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKTVMusicDetail
```
public DescribeKTVMusicDetailResponse DescribeKTVMusicDetail(DescribeKTVMusicDetailRequest req)
                                                      throws TencentCloudSDKException
```
    根据 Id 查询歌曲的详细信息，包含基础信息及播放信息。
    
    Parameters:
    
    req - DescribeKTVMusicDetailRequest
    
    Returns:
    
    DescribeKTVMusicDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKTVMusicTags
```
public DescribeKTVMusicTagsResponse DescribeKTVMusicTags(DescribeKTVMusicTagsRequest req)
                                                  throws TencentCloudSDKException
```
    获取直播互动曲库标签分组信息和标签信息
    
    Parameters:
    
    req - DescribeKTVMusicTagsRequest
    
    Returns:
    
    DescribeKTVMusicTagsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKTVPlaylistDetail
```
public DescribeKTVPlaylistDetailResponse DescribeKTVPlaylistDetail(DescribeKTVPlaylistDetailRequest req)
                                                            throws TencentCloudSDKException
```
    根据歌单 Id 获取歌单详情，包括歌单的基础信息以及歌曲列表。
    
    Parameters:
    
    req - DescribeKTVPlaylistDetailRequest
    
    Returns:
    
    DescribeKTVPlaylistDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKTVPlaylists
```
public DescribeKTVPlaylistsResponse DescribeKTVPlaylists(DescribeKTVPlaylistsRequest req)
                                                  throws TencentCloudSDKException
```
    获取直播互动曲库推荐歌单列表。
    
    Parameters:
    
    req - DescribeKTVPlaylistsRequest
    
    Returns:
    
    DescribeKTVPlaylistsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKTVRobots
```
public DescribeKTVRobotsResponse DescribeKTVRobots(DescribeKTVRobotsRequest req)
                                            throws TencentCloudSDKException
```
    获取机器人列表，支持 Id、状态等过滤条件。
    
    Parameters:
    
    req - DescribeKTVRobotsRequest
    
    Returns:
    
    DescribeKTVRobotsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKTVSingerCategories
```
public DescribeKTVSingerCategoriesResponse DescribeKTVSingerCategories(DescribeKTVSingerCategoriesRequest req)
                                                                throws TencentCloudSDKException
```
    获取直播互动曲库歌手分类信息
    
    Parameters:
    
    req - DescribeKTVSingerCategoriesRequest
    
    Returns:
    
    DescribeKTVSingerCategoriesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKTVSingerMusics
```
public DescribeKTVSingerMusicsResponse DescribeKTVSingerMusics(DescribeKTVSingerMusicsRequest req)
                                                        throws TencentCloudSDKException
```
    根据歌手id，返回该歌手下歌曲列表。
    
    Parameters:
    
    req - DescribeKTVSingerMusicsRequest
    
    Returns:
    
    DescribeKTVSingerMusicsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKTVSingers
```
public DescribeKTVSingersResponse DescribeKTVSingers(DescribeKTVSingersRequest req)
                                              throws TencentCloudSDKException
```
    根据过滤条件，返回匹配的歌手列表。
    
    Parameters:
    
    req - DescribeKTVSingersRequest
    
    Returns:
    
    DescribeKTVSingersResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKTVSuggestions
```
public DescribeKTVSuggestionsResponse DescribeKTVSuggestions(DescribeKTVSuggestionsRequest req)
                                                      throws TencentCloudSDKException
```
    获取直播互动曲库联想词
    
    Parameters:
    
    req - DescribeKTVSuggestionsRequest
    
    Returns:
    
    DescribeKTVSuggestionsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKTVTopList
```
public DescribeKTVTopListResponse DescribeKTVTopList(DescribeKTVTopListRequest req)
                                              throws TencentCloudSDKException
```
    获取直播互动曲库歌曲的周榜和月榜
    
    Parameters:
    
    req - DescribeKTVTopListRequest
    
    Returns:
    
    DescribeKTVTopListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLyric
```
public DescribeLyricResponse DescribeLyric(DescribeLyricRequest req)
                                    throws TencentCloudSDKException
```
    根据接口的模式及歌曲ID来取得歌词信息或者波形图信息。
    
    Parameters:
    
    req - DescribeLyricRequest
    
    Returns:
    
    DescribeLyricResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeMusic
```
public DescribeMusicResponse DescribeMusic(DescribeMusicRequest req)
                                    throws TencentCloudSDKException
```
    获取曲库包歌曲播放信息接口
    
    Parameters:
    
    req - DescribeMusicRequest
    
    Returns:
    
    DescribeMusicResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeMusicSaleStatus
```
public DescribeMusicSaleStatusResponse DescribeMusicSaleStatus(DescribeMusicSaleStatusRequest req)
                                                        throws TencentCloudSDKException
```
    根据音乐信息查询音乐是否在售
    
    Parameters:
    
    req - DescribeMusicSaleStatusRequest
    
    Returns:
    
    DescribeMusicSaleStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePackageItems
```
public DescribePackageItemsResponse DescribePackageItems(DescribePackageItemsRequest req)
                                                  throws TencentCloudSDKException
```
    获取曲库包下已核销歌曲列表接口
    
    Parameters:
    
    req - DescribePackageItemsRequest
    
    Returns:
    
    DescribePackageItemsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePackages
```
public DescribePackagesResponse DescribePackages(DescribePackagesRequest req)
                                          throws TencentCloudSDKException
```
    获取已购曲库包列表接口
    
    Parameters:
    
    req - DescribePackagesRequest
    
    Returns:
    
    DescribePackagesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePkgOfflineMusic
```
public DescribePkgOfflineMusicResponse DescribePkgOfflineMusic(DescribePkgOfflineMusicRequest req)
                                                        throws TencentCloudSDKException
```
    根据购买曲库包用户可查询已回退的歌曲信息
    
    Parameters:
    
    req - DescribePkgOfflineMusicRequest
    
    Returns:
    
    DescribePkgOfflineMusicResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeStations
```
public DescribeStationsResponse DescribeStations(DescribeStationsRequest req)
                                          throws TencentCloudSDKException
```
    该服务后续会停用，不再建议使用
    
    Parameters:
    
    req - DescribeStationsRequest
    
    Returns:
    
    DescribeStationsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DestroyKTVRobot
```
public DestroyKTVRobotResponse DestroyKTVRobot(DestroyKTVRobotRequest req)
                                        throws TencentCloudSDKException
```
    销毁机器人，机器人退出 RTC 房间。
    
    Parameters:
    
    req - DestroyKTVRobotRequest
    
    Returns:
    
    DestroyKTVRobotResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyMusicOnShelves
```
public ModifyMusicOnShelvesResponse ModifyMusicOnShelves(ModifyMusicOnShelvesRequest req)
                                                  throws TencentCloudSDKException
```
    根据资源方，需要变更的参数，请求该接口进行变更，为空的参数默认为无变更
    
    Parameters:
    
    req - ModifyMusicOnShelvesRequest
    
    Returns:
    
    ModifyMusicOnShelvesResponse
    
    Throws:
    
    TencentCloudSDKException
  - PutMusicOnTheShelves
```
public PutMusicOnTheShelvesResponse PutMusicOnTheShelves(PutMusicOnTheShelvesRequest req)
                                                  throws TencentCloudSDKException
```
    根据资源方所传歌曲信息，进行歌曲上架，多个歌曲同时请求时，需构造复合结构进行请求
    
    Parameters:
    
    req - PutMusicOnTheShelvesRequest
    
    Returns:
    
    PutMusicOnTheShelvesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ReportData
```
public ReportDataResponse ReportData(ReportDataRequest req)
                              throws TencentCloudSDKException
```
    客户上报用户数据功能，为了更好地为用户提供优质服务
    
    Parameters:
    
    req - ReportDataRequest
    
    Returns:
    
    ReportDataResponse
    
    Throws:
    
    TencentCloudSDKException
  - SearchKTVMusics
```
public SearchKTVMusicsResponse SearchKTVMusics(SearchKTVMusicsRequest req)
                                        throws TencentCloudSDKException
```
    根据搜索条件，返回匹配的歌曲列表。
    
    Parameters:
    
    req - SearchKTVMusicsRequest
    
    Returns:
    
    SearchKTVMusicsResponse
    
    Throws:
    
    TencentCloudSDKException
  - SyncKTVRobotCommand
```
public SyncKTVRobotCommandResponse SyncKTVRobotCommand(SyncKTVRobotCommandRequest req)
                                                throws TencentCloudSDKException
```
    下发操作机器人指令，支持播放、暂停、恢复、歌单设置等操作指令，实现对机器人行为的控制。
    
    Parameters:
    
    req - SyncKTVRobotCommandRequest
    
    Returns:
    
    SyncKTVRobotCommandResponse
    
    Throws:
    
    TencentCloudSDKException
  - TakeMusicOffShelves
```
public TakeMusicOffShelvesResponse TakeMusicOffShelves(TakeMusicOffShelvesRequest req)
                                                throws TencentCloudSDKException
```
    根据资源方所传MusicId进行将歌曲进行下架，多个MusicId使用逗号隔开
    
    Parameters:
    
    req - TakeMusicOffShelvesRequest
    
    Returns:
    
    TakeMusicOffShelvesResponse
    
    Throws:
    
    TencentCloudSDKException

Class AmeClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

AmeClient

AmeClient

Method Detail

BatchDescribeKTVMusicDetails

CreateKTVRobot

DescribeAuthInfo

DescribeCloudMusic

DescribeCloudMusicPurchased

DescribeItemById

DescribeItems

DescribeKTVMusicDetail

DescribeKTVMusicTags

DescribeKTVPlaylistDetail

DescribeKTVPlaylists

DescribeKTVRobots

DescribeKTVSingerCategories

DescribeKTVSingerMusics

DescribeKTVSingers

DescribeKTVSuggestions

DescribeKTVTopList

DescribeLyric

DescribeMusic

DescribeMusicSaleStatus

DescribePackageItems

DescribePackages

DescribePkgOfflineMusic

DescribeStations

DestroyKTVRobot

ModifyMusicOnShelves

PutMusicOnTheShelves

ReportData

SearchKTVMusics

SyncKTVRobotCommand

TakeMusicOffShelves