com.tencentcloudapi.gme.v20180711

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 and Description
GmeClient(Credential credential, String region)
GmeClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
CreateAppResponse	CreateApp(CreateAppRequest req) This API is used to create a GME application.
DescribeApplicationDataResponse	DescribeApplicationData(DescribeApplicationDataRequest req) This API (DescribeApplicationData) is used to query usage data details within 90 days.
DescribeAppStatisticsResponse	DescribeAppStatistics(DescribeAppStatisticsRequest req) This API is used to get the usage statistics of a GME application, including those of voice chat, voice messaging and speech-to-text, phrase analysis, etc.
DescribeScanResultListResponse	DescribeScanResultList(DescribeScanResultListRequest req) This API is used to query the speech detection result.
ModifyAppStatusResponse	ModifyAppStatus(ModifyAppStatusRequest req) This API is used to change the status of an application's primary switch.
ScanVoiceResponse	ScanVoice(ScanVoiceRequest req) This API is used to submit a speech detection task.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GmeClient

public GmeClient(Credential credential,
                 String region)

GmeClient

public GmeClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

CreateApp

public CreateAppResponse CreateApp(CreateAppRequest req)
                            throws TencentCloudSDKException

This API is used to create a GME application.

Parameters:

req - CreateAppRequest

Returns:

CreateAppResponse

Throws:

TencentCloudSDKException

DescribeAppStatistics

public DescribeAppStatisticsResponse DescribeAppStatistics(DescribeAppStatisticsRequest req)
                                                    throws TencentCloudSDKException

This API is used to get the usage statistics of a GME application, including those of voice chat, voice messaging and speech-to-text, phrase analysis, etc. The maximum query period is the past 30 days.

Parameters:

req - DescribeAppStatisticsRequest

Returns:

DescribeAppStatisticsResponse

Throws:

TencentCloudSDKException

DescribeApplicationData

public DescribeApplicationDataResponse DescribeApplicationData(DescribeApplicationDataRequest req)
                                                        throws TencentCloudSDKException

This API (DescribeApplicationData) is used to query usage data details within 90 days.

Parameters:

req - DescribeApplicationDataRequest

Returns:

DescribeApplicationDataResponse

Throws:

TencentCloudSDKException

DescribeScanResultList

public DescribeScanResultListResponse DescribeScanResultList(DescribeScanResultListRequest req)
                                                      throws TencentCloudSDKException

This API is used to query the speech detection result. Up to 100 tasks can be added in the task query list.

If the `Callback` field is not set when a speech detection task is submitted, this API will be needed to get the detection result.

Parameters:

req - DescribeScanResultListRequest

Returns:

DescribeScanResultListResponse

Throws:

TencentCloudSDKException

ModifyAppStatus

public ModifyAppStatusResponse ModifyAppStatus(ModifyAppStatusRequest req)
                                        throws TencentCloudSDKException

This API is used to change the status of an application's primary switch.

Parameters:

req - ModifyAppStatusRequest

Returns:

ModifyAppStatusResponse

Throws:

TencentCloudSDKException

ScanVoice

public ScanVoiceResponse ScanVoice(ScanVoiceRequest req)
                            throws TencentCloudSDKException

This API is used to submit a speech detection task. Up to 100 tasks can be added in the detection task list. Before using this API, please activate the speech analysis service in [Console > Service Configuration](https://console.cloud.tencent.com/gamegme/conf).

About the trial:

You can try out the speech analysis service free of charge in Console > Product Trial.

API feature description:

This API checks audio streams or files for non-compliant content. The detection result can be obtained by setting the callback address (`Callback`) or calling the `DescribeScanResultList` API for polling. The scenario can be specified, such as abusive or pornographic. Detection tasks can be submitted in batches. Up to 100 tasks can be added in the detection task list.

Audio file limit description:

Audio file size limit: 100 MB Audio file duration limit: 30 minutes Supported audio file formats: .wav, .m4a, .amr, .mp3, .aac, .wma, .ogg

Audio stream limit description:

Supported audio stream formats: .m3u8, .flv Supported audio stream transfer protocols: RTMP, HTTP, HTTPS Audio stream duration limit: 4 hours Audio/video stream separation and audio stream analysis are supported

`Scenes` and `Label` parameter description:

When submitting a speech detection task, you need to specify the `Scenes` parameter. You are currently required to set the `Scenes` parameter to `["default"]`. The detection result will contain the scenario specified at the time of request and detection result in the corresponding type.

Scenario	Description	Label
Speech detection	Speech detection type	normal: normal porn: pornographic abuse: abusive ad: advertising contraband: prohibited customized: custom keyword library. This feature is only available to beta users. To try it out, please contact us.

Callback description:

If the callback address parameter `Callback` (i.e., the URL of an HTTP(S) API) is specified in the request parameters, then the POST method should be supported and transferred data should be encoded with UTF-8. After the callback data is pushed, if the HTTP status code received is 200, the push is successful. HTTP header parameter description:

Item	Type	Required	Description
Signatue	string	Yes	Signature. For more information, please see Signature generation description.

• Signature generation description:
• The HMAC-SH1 algorithm should be used, and the result should be encoded with Base64;
• The original signature string is the entire JSON content of POST and body (the length is subject to `Content-Length`);
• The signature key is the `SecretKey` of the application, which can be viewed in the console.

Below is a sample callback (for more information on the fields, please see the structure: DescribeScanResult):

{
        "Code": 0,
        "DataId": "1400000000_test_data_id",
        "ScanFinishTime": 1566720906,
        "HitFlag": true,
        "Live": false,
        "Msg": "",
        "ScanPiece": [{
                "DumpUrl": "",
                "HitFlag": true,
                "MainType": "abuse",
                "RoomId": "123",
                "OpenId": "xxx",
                "Info":"",
                "Offset": 0,
                "Duration": 3400,
                "PieceStartTime":1574684231,
                "ScanDetail": [{
                        "EndTime": 1110,
                        "KeyWord": "xxx",
                        "Label": "abuse",
                        "Rate": "90.00",
                        "StartTime": 1110
                }, {
                        "EndTime": 1380,
                        "KeyWord": "xxx",
                        "Label": "abuse",
                        "Rate": "90.00",
                        "StartTime": 930
                }, {
                        "EndTime": 1560,
                        "KeyWord": "xxx",
                        "Label": "abuse",
                        "Rate": "90.00",
                        "StartTime": 930
                }, {
                        "EndTime": 2820,
                        "KeyWord": "xxx",
                        "Label": "abuse",
                        "Rate": "90.00",
                        "StartTime": 2490
                }]
        }],
        "ScanStartTime": 1566720905,
        "Scenes": [
                "default"
        ],
        "Status": "Success",
        "TaskId": "xxx",
        "Url": "https://xxx/xxx.m4a"
}

Parameters:

req - ScanVoiceRequest

Returns:

ScanVoiceResponse

Throws:

TencentCloudSDKException