Class GmeClient
- java.lang.Object
-
- com.tencentcloudapi.common.AbstractClient
-
- com.tencentcloudapi.gme.v20180711.GmeClient
-
public class GmeClient extends AbstractClient
-
-
Field Summary
-
Fields inherited from class com.tencentcloudapi.common.AbstractClient
gson, HTTP_RSP_OK, SDK_VERSION
-
-
Constructor Summary
Constructors Constructor Description GmeClient(Credential credential, String region)GmeClient(Credential credential, String region, ClientProfile profile)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateAgeDetectTaskResponseCreateAgeDetectTask(CreateAgeDetectTaskRequest req)用于创建年龄语音识别任务的接口,请求频率10次/秒。该接口目前通过白名单开放试用,如有需求,请提交工单申请。CreateAppResponseCreateApp(CreateAppRequest req)本接口(CreateApp)用于创建一个GME应用。CreateCustomizationResponseCreateCustomization(CreateCustomizationRequest req)用户使用该接口可以创建语音消息转文本热句模型,以供识别调用CreateScanUserResponseCreateScanUser(CreateScanUserRequest req)新增自定义送检用户。**接口使用前提**:目前 CreateScanUser 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。DeleteCustomizationResponseDeleteCustomization(DeleteCustomizationRequest req)用户通过该接口可以删除语音消息转文本热句模型DeleteRoomMemberResponseDeleteRoomMember(DeleteRoomMemberRequest req)本接口(DeleteRoomMember)用户删除房间或者剔除房间内用户DeleteScanUserResponseDeleteScanUser(DeleteScanUserRequest req)删除自定义送检用户。**接口使用前提**:目前 DeleteScanUser 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。DescribeAgeDetectTaskResponseDescribeAgeDetectTask(DescribeAgeDetectTaskRequest req)查询年龄语音识别任务结果,请求频率10次/秒。该接口目前通过白名单开放试用,如有需求,请提交工单申请。DescribeApplicationDataResponseDescribeApplicationData(DescribeApplicationDataRequest req)本接口(DescribeApplicationData)用于获取数据详情信息,最多可拉取最近90天的数据。DescribeApplicationListResponseDescribeApplicationList(DescribeApplicationListRequest req)本接口(DescribeApplicationList)用于查询自己账号下的应用列表DescribeAppStatisticsResponseDescribeAppStatistics(DescribeAppStatisticsRequest req)本接口(DescribeAppStatistics)用于获取某个GME应用的用量数据。包括实时语音,语音消息及转文本,语音分析等。最长查询周期为最近60天。DescribeRealtimeScanConfigResponseDescribeRealtimeScanConfig(DescribeRealtimeScanConfigRequest req)获取用户自定义送检信息。**接口使用前提**:目前 DescribeRealtimeScanConfig 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。DescribeRecordInfoResponseDescribeRecordInfo(DescribeRecordInfoRequest req)查询录制任务信息。DescribeRoomInfoResponseDescribeRoomInfo(DescribeRoomInfoRequest req)获取房间内用户信息DescribeScanResultListResponseDescribeScanResultList(DescribeScanResultListRequest req)本接口(DescribeScanResultList)用于查询语音检测结果,查询任务列表最多支持100个。DescribeTaskInfoResponseDescribeTaskInfo(DescribeTaskInfoRequest req)查询房间录制的详细信息DescribeUserInAndOutTimeResponseDescribeUserInAndOutTime(DescribeUserInAndOutTimeRequest req)拉取用户在房间得进出时间GetCustomizationListResponseGetCustomizationList(GetCustomizationListRequest req)查询语音消息转文本热句模型列表ModifyAppStatusResponseModifyAppStatus(ModifyAppStatusRequest req)本接口(ModifyAppStatus)用于修改应用总开关状态。ModifyCustomizationResponseModifyCustomization(ModifyCustomizationRequest req)用户通过该接口可以更新语音消息转文本热句模型。ModifyCustomizationStateResponseModifyCustomizationState(ModifyCustomizationStateRequest req)通过该接口,用户可以修改语音消息转文本热句模型状态,上下线热句模型ModifyRecordInfoResponseModifyRecordInfo(ModifyRecordInfoRequest req)修改录制配置信息ModifyUserMicStatusResponseModifyUserMicStatus(ModifyUserMicStatusRequest req)接口作用**:此接口用于修改房间用户的麦克风状态,例如房间内用户麦克风为打开状态,可调用此接口将该用户麦克风进行关闭,关闭后即使该用户使用客户端接口 EnableMic 打开麦克风,依然无法与房间内成员通话,属于被禁言状态。该状态持续到此用户退房后失效,或者调用该接口重新打开此用户麦克风状态。 接口应用场景**:此接口多用于游戏业务中台或者风控后台,对一些发表不当言论的玩家进行禁言处理。 接口使用前提**:目前 ModifyUserMicStatus 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。ScanVoiceResponseScanVoice(ScanVoiceRequest req)本接口(ScanVoice)用于提交语音检测任务,检测任务列表最多支持100个。使用前请您登录[控制台 - 服务配置](https://console.cloud.tencent.com/gamegme/conf)开启语音内容安全服务。StartRecordResponseStartRecord(StartRecordRequest req)开启录制StopRecordResponseStopRecord(StopRecordRequest req)停止录制UpdateScanRoomsResponseUpdateScanRooms(UpdateScanRoomsRequest req)更新自定义送检房间号。**接口使用前提**:目前 UpdateScanRooms 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。UpdateScanUsersResponseUpdateScanUsers(UpdateScanUsersRequest req)更新自定义送检用户号。 接口使用前提**:目前 UpdateScanUsers 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。-
Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, retry, setClientProfile, setCredential, setRegion, setRegionBreaker
-
-
-
-
Constructor Detail
-
GmeClient
public GmeClient(Credential credential, String region)
-
GmeClient
public GmeClient(Credential credential, String region, ClientProfile profile)
-
-
Method Detail
-
CreateAgeDetectTask
public CreateAgeDetectTaskResponse CreateAgeDetectTask(CreateAgeDetectTaskRequest req) throws TencentCloudSDKException
用于创建年龄语音识别任务的接口,请求频率10次/秒。该接口目前通过白名单开放试用,如有需求,请提交工单申请。接口功能说明:
- 支持对语音文件进行检测,判断是否为未成年人。
- 支持批量提交检测子任务。检测子任务列表最多支持100个。
音频文件限制说明:
- 音频文件大小限制:10 M
- 音频文件时长限制:3分钟
- 音频文件格式支持的类型:.wav、.m4a、.amr、.mp3、.aac、.wma、.ogg
- Parameters:
req- CreateAgeDetectTaskRequest- Returns:
- CreateAgeDetectTaskResponse
- Throws:
TencentCloudSDKException
-
CreateApp
public CreateAppResponse CreateApp(CreateAppRequest req) throws TencentCloudSDKException
本接口(CreateApp)用于创建一个GME应用。- Parameters:
req- CreateAppRequest- Returns:
- CreateAppResponse
- Throws:
TencentCloudSDKException
-
CreateCustomization
public CreateCustomizationResponse CreateCustomization(CreateCustomizationRequest req) throws TencentCloudSDKException
用户使用该接口可以创建语音消息转文本热句模型,以供识别调用- Parameters:
req- CreateCustomizationRequest- Returns:
- CreateCustomizationResponse
- Throws:
TencentCloudSDKException
-
CreateScanUser
public CreateScanUserResponse CreateScanUser(CreateScanUserRequest req) throws TencentCloudSDKException
新增自定义送检用户。**接口使用前提**:目前 CreateScanUser 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。- Parameters:
req- CreateScanUserRequest- Returns:
- CreateScanUserResponse
- Throws:
TencentCloudSDKException
-
DeleteCustomization
public DeleteCustomizationResponse DeleteCustomization(DeleteCustomizationRequest req) throws TencentCloudSDKException
用户通过该接口可以删除语音消息转文本热句模型- Parameters:
req- DeleteCustomizationRequest- Returns:
- DeleteCustomizationResponse
- Throws:
TencentCloudSDKException
-
DeleteRoomMember
public DeleteRoomMemberResponse DeleteRoomMember(DeleteRoomMemberRequest req) throws TencentCloudSDKException
本接口(DeleteRoomMember)用户删除房间或者剔除房间内用户- Parameters:
req- DeleteRoomMemberRequest- Returns:
- DeleteRoomMemberResponse
- Throws:
TencentCloudSDKException
-
DeleteScanUser
public DeleteScanUserResponse DeleteScanUser(DeleteScanUserRequest req) throws TencentCloudSDKException
删除自定义送检用户。**接口使用前提**:目前 DeleteScanUser 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。- Parameters:
req- DeleteScanUserRequest- Returns:
- DeleteScanUserResponse
- Throws:
TencentCloudSDKException
-
DescribeAgeDetectTask
public DescribeAgeDetectTaskResponse DescribeAgeDetectTask(DescribeAgeDetectTaskRequest req) throws TencentCloudSDKException
查询年龄语音识别任务结果,请求频率10次/秒。该接口目前通过白名单开放试用,如有需求,请提交工单申请。- Parameters:
req- DescribeAgeDetectTaskRequest- Returns:
- DescribeAgeDetectTaskResponse
- Throws:
TencentCloudSDKException
-
DescribeAppStatistics
public DescribeAppStatisticsResponse DescribeAppStatistics(DescribeAppStatisticsRequest req) throws TencentCloudSDKException
本接口(DescribeAppStatistics)用于获取某个GME应用的用量数据。包括实时语音,语音消息及转文本,语音分析等。最长查询周期为最近60天。- Parameters:
req- DescribeAppStatisticsRequest- Returns:
- DescribeAppStatisticsResponse
- Throws:
TencentCloudSDKException
-
DescribeApplicationData
public DescribeApplicationDataResponse DescribeApplicationData(DescribeApplicationDataRequest req) throws TencentCloudSDKException
本接口(DescribeApplicationData)用于获取数据详情信息,最多可拉取最近90天的数据。- Parameters:
req- DescribeApplicationDataRequest- Returns:
- DescribeApplicationDataResponse
- Throws:
TencentCloudSDKException
-
DescribeApplicationList
public DescribeApplicationListResponse DescribeApplicationList(DescribeApplicationListRequest req) throws TencentCloudSDKException
本接口(DescribeApplicationList)用于查询自己账号下的应用列表- Parameters:
req- DescribeApplicationListRequest- Returns:
- DescribeApplicationListResponse
- Throws:
TencentCloudSDKException
-
DescribeRealtimeScanConfig
public DescribeRealtimeScanConfigResponse DescribeRealtimeScanConfig(DescribeRealtimeScanConfigRequest req) throws TencentCloudSDKException
获取用户自定义送检信息。**接口使用前提**:目前 DescribeRealtimeScanConfig 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。- Parameters:
req- DescribeRealtimeScanConfigRequest- Returns:
- DescribeRealtimeScanConfigResponse
- Throws:
TencentCloudSDKException
-
DescribeRecordInfo
public DescribeRecordInfoResponse DescribeRecordInfo(DescribeRecordInfoRequest req) throws TencentCloudSDKException
查询录制任务信息。- Parameters:
req- DescribeRecordInfoRequest- Returns:
- DescribeRecordInfoResponse
- Throws:
TencentCloudSDKException
-
DescribeRoomInfo
public DescribeRoomInfoResponse DescribeRoomInfo(DescribeRoomInfoRequest req) throws TencentCloudSDKException
获取房间内用户信息- Parameters:
req- DescribeRoomInfoRequest- Returns:
- DescribeRoomInfoResponse
- Throws:
TencentCloudSDKException
-
DescribeScanResultList
public DescribeScanResultListResponse DescribeScanResultList(DescribeScanResultListRequest req) throws TencentCloudSDKException
本接口(DescribeScanResultList)用于查询语音检测结果,查询任务列表最多支持100个。如果在提交语音检测任务时未设置 Callback 字段,则需要通过本接口获取检测结果
- Parameters:
req- DescribeScanResultListRequest- Returns:
- DescribeScanResultListResponse
- Throws:
TencentCloudSDKException
-
DescribeTaskInfo
public DescribeTaskInfoResponse DescribeTaskInfo(DescribeTaskInfoRequest req) throws TencentCloudSDKException
查询房间录制的详细信息- Parameters:
req- DescribeTaskInfoRequest- Returns:
- DescribeTaskInfoResponse
- Throws:
TencentCloudSDKException
-
DescribeUserInAndOutTime
public DescribeUserInAndOutTimeResponse DescribeUserInAndOutTime(DescribeUserInAndOutTimeRequest req) throws TencentCloudSDKException
拉取用户在房间得进出时间- Parameters:
req- DescribeUserInAndOutTimeRequest- Returns:
- DescribeUserInAndOutTimeResponse
- Throws:
TencentCloudSDKException
-
GetCustomizationList
public GetCustomizationListResponse GetCustomizationList(GetCustomizationListRequest req) throws TencentCloudSDKException
查询语音消息转文本热句模型列表- Parameters:
req- GetCustomizationListRequest- Returns:
- GetCustomizationListResponse
- Throws:
TencentCloudSDKException
-
ModifyAppStatus
public ModifyAppStatusResponse ModifyAppStatus(ModifyAppStatusRequest req) throws TencentCloudSDKException
本接口(ModifyAppStatus)用于修改应用总开关状态。- Parameters:
req- ModifyAppStatusRequest- Returns:
- ModifyAppStatusResponse
- Throws:
TencentCloudSDKException
-
ModifyCustomization
public ModifyCustomizationResponse ModifyCustomization(ModifyCustomizationRequest req) throws TencentCloudSDKException
用户通过该接口可以更新语音消息转文本热句模型。- Parameters:
req- ModifyCustomizationRequest- Returns:
- ModifyCustomizationResponse
- Throws:
TencentCloudSDKException
-
ModifyCustomizationState
public ModifyCustomizationStateResponse ModifyCustomizationState(ModifyCustomizationStateRequest req) throws TencentCloudSDKException
通过该接口,用户可以修改语音消息转文本热句模型状态,上下线热句模型- Parameters:
req- ModifyCustomizationStateRequest- Returns:
- ModifyCustomizationStateResponse
- Throws:
TencentCloudSDKException
-
ModifyRecordInfo
public ModifyRecordInfoResponse ModifyRecordInfo(ModifyRecordInfoRequest req) throws TencentCloudSDKException
修改录制配置信息- Parameters:
req- ModifyRecordInfoRequest- Returns:
- ModifyRecordInfoResponse
- Throws:
TencentCloudSDKException
-
ModifyUserMicStatus
public ModifyUserMicStatusResponse ModifyUserMicStatus(ModifyUserMicStatusRequest req) throws TencentCloudSDKException
接口作用**:此接口用于修改房间用户的麦克风状态,例如房间内用户麦克风为打开状态,可调用此接口将该用户麦克风进行关闭,关闭后即使该用户使用客户端接口 EnableMic 打开麦克风,依然无法与房间内成员通话,属于被禁言状态。该状态持续到此用户退房后失效,或者调用该接口重新打开此用户麦克风状态。 接口应用场景**:此接口多用于游戏业务中台或者风控后台,对一些发表不当言论的玩家进行禁言处理。 接口使用前提**:目前 ModifyUserMicStatus 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。- Parameters:
req- ModifyUserMicStatusRequest- Returns:
- ModifyUserMicStatusResponse
- Throws:
TencentCloudSDKException
-
ScanVoice
public ScanVoiceResponse ScanVoice(ScanVoiceRequest req) throws TencentCloudSDKException
本接口(ScanVoice)用于提交语音检测任务,检测任务列表最多支持100个。使用前请您登录[控制台 - 服务配置](https://console.cloud.tencent.com/gamegme/conf)开启语音内容安全服务。功能试用说明:
- 打开前往控制台 - 产品试用免费试用语音内容安全服务。
接口功能说明:
- 支持对语音流或语音文件进行检测,判断其中是否包含违规内容。
- 支持设置回调地址 Callback 获取检测结果,同时支持通过接口(查询语音检测结果)主动轮询获取检测结果。
- 支持场景输入,包括:谩骂、色情等场景
- 支持批量提交检测任务。检测任务列表最多支持100个。
音频文件限制说明:
- 音频文件大小限制:100 M
- 音频文件时长限制:30分钟
- 音频文件格式支持的类型:.wav、.m4a、.amr、.mp3、.aac、.wma、.ogg
语音流限制说明:
- 语音流格式支持的类型:.m3u8、.flv
- 语音流支持的传输协议:RTMP、HTTP、HTTPS
- 语音流时长限制:4小时
- 支持音视频流分离并对音频流进行分析
Scenes 与 Label 参数说明:
提交语音检测任务时,需要指定 Scenes 场景参数,目前要求您设置 Scenes 参数值为:["default"];而在检测结果中,则包含请求时指定的场景,以及对应类型的检测结果。
场景 描述 Label 语音检测 语音检测的检测类型 normal:正常文本
porn:色情
abuse:谩骂
ad :广告
illegal :违法
moan :呻吟
customized:自定义词库
回调相关说明:
- 如果在请求参数中指定了回调地址参数 Callback,即一个 HTTP(S) 协议接口的 URL,则需要支持 POST 方法,传输数据编码采用 UTF-8。
- 在推送回调数据后,接收到的 HTTP 状态码为 200 时,表示推送成功。
- HTTP 请求参数(query)说明:
名称 类型 是否必需 描述 Signatue string 是 签名,具体见签名生成说明 - 签名生成说明:
- 使用 HMAC-SH1 算法, 最终结果做 BASE64 编码;
- 签名原文串为 POST+body 的整个json内容(长度以 Content-Length 为准);
- 签名key为应用的 SecretKey,可以通过控制台查看。
- 回调示例如下(详细字段说明见结构: DescribeScanResult):
{ "Code": 0, "DataId": "1400000000_test_data_id", "ScanFinishTime": 1566720906, "HitFlag": true, "Live": false, "Msg": "", "ScanPiece": [{ "DumpUrl": "", "HitFlag": true, "MainType": "abuse", "RoomId": "123", "OpenId": "111", "Info":"", "Offset": 0, "Duration": 3400, "PieceStartTime":1574684231, "ScanDetail": [{ "EndTime": 1110, "KeyWord": "违规字", "Label": "abuse", "Rate": "90.00", "StartTime": 1110 }, { "EndTime": 1380, "KeyWord": "违规字", "Label": "abuse", "Rate": "90.00", "StartTime": 930 }, { "EndTime": 1560, "KeyWord": "违规字", "Label": "abuse", "Rate": "90.00", "StartTime": 930 }, { "EndTime": 2820, "KeyWord": "违规字", "Label": "abuse", "Rate": "90.00", "StartTime": 2490 }] }], "ScanStartTime": 1566720905, "Scenes": [ "default" ], "Status": "Success", "TaskId": "6330xxxx-9xx7-11ed-98e3-52xxxxe4ac3b", "Url": "https://xxx/xxx.m4a" }- Parameters:
req- ScanVoiceRequest- Returns:
- ScanVoiceResponse
- Throws:
TencentCloudSDKException
-
StartRecord
public StartRecordResponse StartRecord(StartRecordRequest req) throws TencentCloudSDKException
开启录制- Parameters:
req- StartRecordRequest- Returns:
- StartRecordResponse
- Throws:
TencentCloudSDKException
-
StopRecord
public StopRecordResponse StopRecord(StopRecordRequest req) throws TencentCloudSDKException
停止录制- Parameters:
req- StopRecordRequest- Returns:
- StopRecordResponse
- Throws:
TencentCloudSDKException
-
UpdateScanRooms
public UpdateScanRoomsResponse UpdateScanRooms(UpdateScanRoomsRequest req) throws TencentCloudSDKException
更新自定义送检房间号。**接口使用前提**:目前 UpdateScanRooms 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。- Parameters:
req- UpdateScanRoomsRequest- Returns:
- UpdateScanRoomsResponse
- Throws:
TencentCloudSDKException
-
UpdateScanUsers
public UpdateScanUsersResponse UpdateScanUsers(UpdateScanUsersRequest req) throws TencentCloudSDKException
更新自定义送检用户号。 接口使用前提**:目前 UpdateScanUsers 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。- Parameters:
req- UpdateScanUsersRequest- Returns:
- UpdateScanUsersResponse
- Throws:
TencentCloudSDKException
-
-