v20180711

package
v3.0.313+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 28, 2021 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// Operation not allowed as your account is in arrears.
	FAILEDOPERATION_USERFEENEGATIVE = "FailedOperation.UserFeeNegative"

	// Internal error.
	INTERNALERROR = "InternalError"

	// Incorrect parameter.
	INVALIDPARAMETER = "InvalidParameter"

	// Incorrect callback URL.
	INVALIDPARAMETER_CALLBACKADDRESS = "InvalidParameter.CallbackAddress"

	// Invalid date.
	INVALIDPARAMETER_DATEINVALID = "InvalidParameter.DateInvalid"

	// Incorrect tag.
	INVALIDPARAMETER_TAGKEY = "InvalidParameter.TagKey"

	// Incorrect query time range.
	INVALIDPARAMETER_TIMERANGEERROR = "InvalidParameter.TimeRangeError"

	// The number of created applications has reached the upper limit.
	LIMITEXCEEDED_APPLICATION = "LimitExceeded.Application"

	// Missing parameter.
	MISSINGPARAMETER_ = "MissingParameter."

	// The resource does not exist.
	RESOURCENOTFOUND = "ResourceNotFound"

	// Incorrect application ID.
	RESOURCENOTFOUND_BIZIDISNOTFOUND = "ResourceNotFound.BizidIsNotFound"

	// The resource is unavailable
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// Unauthorized operation
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// Application creation is not authorized.
	UNAUTHORIZEDOPERATION_CREATEAPPDENIED = "UnauthorizedOperation.CreateAppDenied"

	// Unverified user.
	UNAUTHORIZEDOPERATION_UNREALNAMEAUTH = "UnauthorizedOperation.UnRealNameAuth"

	// Unknown parameter.
	UNKNOWNPARAMETER = "UnknownParameter"

	// Operation unsupported.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
View Source 
const APIVersion = "2018-07-11"

Variables

This section is empty.

Functions

This section is empty.

Types

type AppStatisticsItem 

type AppStatisticsItem struct {

	// Voice chat statistics
	// Note: This field may return null, indicating that no valid values can be obtained.
	RealtimeSpeechStatisticsItem *RealTimeSpeechStatisticsItem `json:"RealtimeSpeechStatisticsItem,omitempty" name:"RealtimeSpeechStatisticsItem"`

	// Voice messaging statistics
	// Note: This field may return null, indicating that no valid values can be obtained.
	VoiceMessageStatisticsItem *VoiceMessageStatisticsItem `json:"VoiceMessageStatisticsItem,omitempty" name:"VoiceMessageStatisticsItem"`

	// Phrase filtering statistics
	// Note: This field may return null, indicating that no valid values can be obtained.
	VoiceFilterStatisticsItem *VoiceFilterStatisticsItem `json:"VoiceFilterStatisticsItem,omitempty" name:"VoiceFilterStatisticsItem"`

	// Statistical period
	Date *string `json:"Date,omitempty" name:"Date"`
}

type ApplicationDataStatistics 

type ApplicationDataStatistics struct {

	// Application ID
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// DAU data
	DauDataNum *uint64 `json:"DauDataNum,omitempty" name:"DauDataNum"`

	// DAU in Chinese mainland
	DauDataMainland []*StatisticsItem `json:"DauDataMainland,omitempty" name:"DauDataMainland"`

	// DAU outside Chinese mainland
	DauDataOversea []*StatisticsItem `json:"DauDataOversea,omitempty" name:"DauDataOversea"`

	// Total DAU
	DauDataSum []*StatisticsItem `json:"DauDataSum,omitempty" name:"DauDataSum"`

	// Number of voice chat metrics
	DurationDataNum *uint64 `json:"DurationDataNum,omitempty" name:"DurationDataNum"`

	// Duration of voice chat in Chinese mainland in minutes
	DurationDataMainland []*StatisticsItem `json:"DurationDataMainland,omitempty" name:"DurationDataMainland"`

	// Duration of voice chat outside Chinese mainland in minutes
	DurationDataOversea []*StatisticsItem `json:"DurationDataOversea,omitempty" name:"DurationDataOversea"`

	// Total duration of voice chat in minutes
	DurationDataSum []*StatisticsItem `json:"DurationDataSum,omitempty" name:"DurationDataSum"`

	// PCU data
	PcuDataNum *uint64 `json:"PcuDataNum,omitempty" name:"PcuDataNum"`

	// PCU in Chinese mainland
	PcuDataMainland []*StatisticsItem `json:"PcuDataMainland,omitempty" name:"PcuDataMainland"`

	// PCU outside Chinese mainland
	PcuDataOversea []*StatisticsItem `json:"PcuDataOversea,omitempty" name:"PcuDataOversea"`

	// Total PCU
	PcuDataSum []*StatisticsItem `json:"PcuDataSum,omitempty" name:"PcuDataSum"`
}

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) CreateApp 

func (c *Client) CreateApp(request *CreateAppRequest) (response *CreateAppResponse, err error)

CreateApp This API is used to create a GME application.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_USERFEENEGATIVE = "FailedOperation.UserFeeNegative"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_TAGKEY = "InvalidParameter.TagKey"
LIMITEXCEEDED_APPLICATION = "LimitExceeded.Application"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_CREATEAPPDENIED = "UnauthorizedOperation.CreateAppDenied"
UNAUTHORIZEDOPERATION_UNREALNAMEAUTH = "UnauthorizedOperation.UnRealNameAuth"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeAppStatistics 

func (c *Client) DescribeAppStatistics(request *DescribeAppStatisticsRequest) (response *DescribeAppStatisticsResponse, err error)

DescribeAppStatistics 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.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DATEINVALID = "InvalidParameter.DateInvalid"
INVALIDPARAMETER_TIMERANGEERROR = "InvalidParameter.TimeRangeError"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_BIZIDISNOTFOUND = "ResourceNotFound.BizidIsNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeApplicationData 

func (c *Client) DescribeApplicationData(request *DescribeApplicationDataRequest) (response *DescribeApplicationDataResponse, err error)

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeScanResultList 

func (c *Client) DescribeScanResultList(request *DescribeScanResultListRequest) (response *DescribeScanResultListResponse, err error)

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

<p style="color:red">If the `Callback` field is not set when a speech detection task is submitted, this API will be needed to get the detection result.</p>

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_TAGKEY = "InvalidParameter.TagKey"
MISSINGPARAMETER_ = "MissingParameter."
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ModifyAppStatus 

func (c *Client) ModifyAppStatus(request *ModifyAppStatusRequest) (response *ModifyAppStatusResponse, err error)

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

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_USERFEENEGATIVE = "FailedOperation.UserFeeNegative"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER_ = "MissingParameter."
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_BIZIDISNOTFOUND = "ResourceNotFound.BizidIsNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ScanVoice 

func (c *Client) ScanVoice(request *ScanVoiceRequest) (response *ScanVoiceResponse, err error)

ScanVoice 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 enable the speech analysis service in [Console > Service Configuration](https://console.cloud.tencent.com/gamegme/conf).

</br></br>

<h4><b>Feature trial description:</b></h4>

<li>You can try out the speech analysis service free of charge in <a href="https://console.cloud.tencent.com/gamegme/tryout">Console > Product Trial</a>.</li>

</br>

<h4><b>API feature description:</b></h4>

<li>This API can check audio streams or files for non-compliant content.</li>

<li>The detection result can be obtained by setting the callback address (`Callback`) or calling the `DescribeScanResultList` API for polling.</li>

<li>The scenario can be specified, such as abusive, pornographic, or politically sensitive information.</li>

<li>Detection tasks can be submitted in batches. Up to 100 tasks can be added in the detection task list.</li>

</br>

<h4><b>Audio file limit description:</b></h4>

<li>Audio file size limit: 100 MB</li>

<li>Audio file duration limit: 30 minutes</li>

<li>Supported audio file formats: .wav, .m4a, .amr, .mp3, .aac, .wma, .ogg</li>

</br>

<h4><b>Audio stream limit description:</b></h4>

<li>Supported audio stream formats: .m3u8, .flv</li>

<li>Supported audio stream transfer protocols: RTMP, HTTP, HTTPS</li>

<li>Audio stream duration limit: 4 hours</li>

<li>Audio/video stream separation and audio stream analysis are supported</li>

</br>

<h4 id="Label_Value"><b>`Scenes` and `Label` parameter description:</b></h4>

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

<table>

<thread>

<tr>

<th>Scenario</th>

<th>Description</th>

<th>Label</th>

</tr>

</thread>

<tbody>

<tr>

<td>Speech detection</td>

<td>Speech detection type</td>

<td>

<p>normal: normal</p>

<p>porn: pornographic</p>

<p>politics: politically sensitive</p>

<p>abuse: abusive</p>

<p>ad: advertising</p>

<p>terrorism: terrorism</p>

<p>contraband: prohibited</p>

<p>customized: custom keyword library. This feature is only available to allowlisted users. To try it out, please <a href="https://intl.cloud.tencent.com/apply/p/8809fjcik56?from_cn_redirect=1">contact us</a>.</p>

</td>

</tr>

</tbody>

</table>

</br>

<h4 id="Callback_Declare"><b>Callback description:</b></h4>

<li>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.</li>

<li>After the callback data is pushed, if the HTTP status code received is 200, the push is successful.</li>

<li>HTTP header parameter description:</li>

<table>

<thread>

<tr>

<th>Name</th>

<th>Type</th>

<th>Required</th>

<th>Description</th>

</tr>

</thread>

<tbody>

<tr>

<td>Signatue</td>

<td>string</td>

<td>Yes</td>

<td>Signature. For more information, please see <a href="#Callback_Signatue">Signature generation description</a>.</td>

</tr>

</tbody>

</table>

<ul id="Callback_Signatue"> 

<li>Signature generation description:</li>

<ul>

	<li>The HMAC-SH1 algorithm should be used, and the result should be encoded with Base64;</li>

	<li>The original signature string is the entire JSON content of POST and body (the length is subject to `Content-Length`);</li>

	<li>The signature key is the `SecretKey` of the application, which can be viewed in the console.</li>

</ul>

</ul>

<li>Below is a sample callback <font color="red">(for more information on the fields, please see the structure:

<a href="https://intl.cloud.tencent.com/document/api/607/35375?from_cn_redirect=1#DescribeScanResult" target="_blank">DescribeScanResult</a>)</font>:</li>

<pre><code>{ 

"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"

}

</code></pre>

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CALLBACKADDRESS = "InvalidParameter.CallbackAddress"
MISSINGPARAMETER_ = "MissingParameter."
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

type CreateAppRequest 

type CreateAppRequest struct {
	*tchttp.BaseRequest

	// Application name
	AppName *string `json:"AppName,omitempty" name:"AppName"`

	// Tencent Cloud project ID. Default value: 0, which means the default project
	ProjectId *uint64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// List of engines to be supported. All values are selected by default.
	EngineList []*string `json:"EngineList,omitempty" name:"EngineList"`

	// Service region list. All values are selected by default.
	RegionList []*string `json:"RegionList,omitempty" name:"RegionList"`

	// Configuration information of voice chat
	RealtimeSpeechConf *RealtimeSpeechConf `json:"RealtimeSpeechConf,omitempty" name:"RealtimeSpeechConf"`

	// Configuration information of voice messaging and speech-to-text
	VoiceMessageConf *VoiceMessageConf `json:"VoiceMessageConf,omitempty" name:"VoiceMessageConf"`

	// Configuration information of phrase analysis
	VoiceFilterConf *VoiceFilterConf `json:"VoiceFilterConf,omitempty" name:"VoiceFilterConf"`

	// List of tags to be added
	Tags []*Tag `json:"Tags,omitempty" name:"Tags"`
}

func NewCreateAppRequest 

func NewCreateAppRequest() (request *CreateAppRequest)

func (*CreateAppRequest) FromJsonString 

func (r *CreateAppRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateAppRequest) ToJsonString 

func (r *CreateAppRequest) ToJsonString() string

type CreateAppResp 

type CreateAppResp struct {

	// App ID, automatically generated by the backend.
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// App name, the input of `AppName`.
	AppName *string `json:"AppName,omitempty" name:"AppName"`

	// Project ID, the input of `ProjectId`.
	ProjectId *uint64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// App key, used to initialize GME SDK.
	SecretKey *string `json:"SecretKey,omitempty" name:"SecretKey"`

	// Timestamp, indicating when the service is created.
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// Configuration information of voice chat
	RealtimeSpeechConf *RealtimeSpeechConf `json:"RealtimeSpeechConf,omitempty" name:"RealtimeSpeechConf"`

	// Configuration information of voice messaging and speech-to-text
	VoiceMessageConf *VoiceMessageConf `json:"VoiceMessageConf,omitempty" name:"VoiceMessageConf"`

	// Configuration information of phrase analysis
	VoiceFilterConf *VoiceFilterConf `json:"VoiceFilterConf,omitempty" name:"VoiceFilterConf"`
}

type CreateAppResponse 

type CreateAppResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Returned data
		Data *CreateAppResp `json:"Data,omitempty" name:"Data"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateAppResponse 

func NewCreateAppResponse() (response *CreateAppResponse)

func (*CreateAppResponse) FromJsonString 

func (r *CreateAppResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateAppResponse) ToJsonString 

func (r *CreateAppResponse) ToJsonString() string

type DescribeAppStatisticsRequest 

type DescribeAppStatisticsRequest struct {
	*tchttp.BaseRequest

	// GME application ID
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Data start date (GMT+8) in the format of yyyy-mm-dd, such as 2018-07-13
	StartDate *string `json:"StartDate,omitempty" name:"StartDate"`

	// Data end date (GMT+8) in the format of yyyy-mm-dd, such as 2018-07-13
	EndDate *string `json:"EndDate,omitempty" name:"EndDate"`

	// List of services to be queried. Valid values: RealTimeSpeech, VoiceMessage, VoiceFilter
	Services []*string `json:"Services,omitempty" name:"Services"`
}

func NewDescribeAppStatisticsRequest 

func NewDescribeAppStatisticsRequest() (request *DescribeAppStatisticsRequest)

func (*DescribeAppStatisticsRequest) FromJsonString 

func (r *DescribeAppStatisticsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAppStatisticsRequest) ToJsonString 

func (r *DescribeAppStatisticsRequest) ToJsonString() string

type DescribeAppStatisticsResp 

type DescribeAppStatisticsResp struct {

	// App usage statistics
	AppStatistics []*AppStatisticsItem `json:"AppStatistics,omitempty" name:"AppStatistics"`
}

type DescribeAppStatisticsResponse 

type DescribeAppStatisticsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// App usage statistics
		Data *DescribeAppStatisticsResp `json:"Data,omitempty" name:"Data"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeAppStatisticsResponse 

func NewDescribeAppStatisticsResponse() (response *DescribeAppStatisticsResponse)

func (*DescribeAppStatisticsResponse) FromJsonString 

func (r *DescribeAppStatisticsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAppStatisticsResponse) ToJsonString 

func (r *DescribeAppStatisticsResponse) ToJsonString() string

type DescribeApplicationDataRequest 

type DescribeApplicationDataRequest struct {
	*tchttp.BaseRequest

	// Application ID
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Data start date in the format of yyyy-mm-dd, such as 2018-07-13
	StartDate *string `json:"StartDate,omitempty" name:"StartDate"`

	// Data end date in the format of yyyy-mm-dd, such as 2018-07-13
	EndDate *string `json:"EndDate,omitempty" name:"EndDate"`
}

func NewDescribeApplicationDataRequest 

func NewDescribeApplicationDataRequest() (request *DescribeApplicationDataRequest)

func (*DescribeApplicationDataRequest) FromJsonString 

func (r *DescribeApplicationDataRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApplicationDataRequest) ToJsonString 

func (r *DescribeApplicationDataRequest) ToJsonString() string

type DescribeApplicationDataResponse 

type DescribeApplicationDataResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Application statistics
		Data *ApplicationDataStatistics `json:"Data,omitempty" name:"Data"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeApplicationDataResponse 

func NewDescribeApplicationDataResponse() (response *DescribeApplicationDataResponse)

func (*DescribeApplicationDataResponse) FromJsonString 

func (r *DescribeApplicationDataResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApplicationDataResponse) ToJsonString 

func (r *DescribeApplicationDataResponse) ToJsonString() string

type DescribeScanResult 

type DescribeScanResult struct {

	// Business return code
	Code *int64 `json:"Code,omitempty" name:"Code"`

	// Unique data ID
	DataId *string `json:"DataId,omitempty" name:"DataId"`

	// Detection completion timestamp
	ScanFinishTime *uint64 `json:"ScanFinishTime,omitempty" name:"ScanFinishTime"`

	// Whether non-compliant information is detected
	HitFlag *bool `json:"HitFlag,omitempty" name:"HitFlag"`

	// Whether it is a stream
	Live *bool `json:"Live,omitempty" name:"Live"`

	// Business return description
	// Note: this field may return null, indicating that no valid values can be obtained.
	Msg *string `json:"Msg,omitempty" name:"Msg"`

	// Detection result, which will be returned if `Code` is 0
	// Note: this field may return null, indicating that no valid values can be obtained.
	ScanPiece []*ScanPiece `json:"ScanPiece,omitempty" name:"ScanPiece"`

	// Detection task submission timestamp
	ScanStartTime *uint64 `json:"ScanStartTime,omitempty" name:"ScanStartTime"`

	// Speech detection scenario, which corresponds to the `Scene` at the time of request
	Scenes []*string `json:"Scenes,omitempty" name:"Scenes"`

	// Speech detection task ID, which is assigned by the backend
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// File or stream address
	Url *string `json:"Url,omitempty" name:"Url"`

	// Detection task execution result task. Valid values:
	// <li>Start: task started</li>
	// <li>Success: task ended successfully</li>
	// <li>Error: exceptional</li>
	Status *string `json:"Status,omitempty" name:"Status"`

	// ID of the application submitted for detection
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`
}

type DescribeScanResultListRequest 

type DescribeScanResultListRequest struct {
	*tchttp.BaseRequest

	// Application ID, which is the `AppID` obtained when you create an application in the [console](https://console.cloud.tencent.com/gamegme)
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// List of IDs of the tasks to be queried. Up to 100 entries can be added in the ID list.
	TaskIdList []*string `json:"TaskIdList,omitempty" name:"TaskIdList"`

	// Number of task results to be returned. Default value: 10. Maximum value: 500. This parameter will be ignored for large file tasks where all results will be returned
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeScanResultListRequest 

func NewDescribeScanResultListRequest() (request *DescribeScanResultListRequest)

func (*DescribeScanResultListRequest) FromJsonString 

func (r *DescribeScanResultListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeScanResultListRequest) ToJsonString 

func (r *DescribeScanResultListRequest) ToJsonString() string

type DescribeScanResultListResponse 

type DescribeScanResultListResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Result of the speech detection task to be queried
		// Note: this field may return null, indicating that no valid values can be obtained.
		Data []*DescribeScanResult `json:"Data,omitempty" name:"Data"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeScanResultListResponse 

func NewDescribeScanResultListResponse() (response *DescribeScanResultListResponse)

func (*DescribeScanResultListResponse) FromJsonString 

func (r *DescribeScanResultListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeScanResultListResponse) ToJsonString 

func (r *DescribeScanResultListResponse) ToJsonString() string

type ModifyAppStatusRequest 

type ModifyAppStatusRequest struct {
	*tchttp.BaseRequest

	// Application ID, which is generated and returned by the backend after application creation.
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Application status. Valid values: open, close
	Status *string `json:"Status,omitempty" name:"Status"`
}

func NewModifyAppStatusRequest 

func NewModifyAppStatusRequest() (request *ModifyAppStatusRequest)

func (*ModifyAppStatusRequest) FromJsonString 

func (r *ModifyAppStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyAppStatusRequest) ToJsonString 

func (r *ModifyAppStatusRequest) ToJsonString() string

type ModifyAppStatusResp 

type ModifyAppStatusResp struct {

	// GME app ID
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// App status. Valid values: `open`, `close`
	Status *string `json:"Status,omitempty" name:"Status"`
}

type ModifyAppStatusResponse 

type ModifyAppStatusResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Returned data
		Data *ModifyAppStatusResp `json:"Data,omitempty" name:"Data"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewModifyAppStatusResponse 

func NewModifyAppStatusResponse() (response *ModifyAppStatusResponse)

func (*ModifyAppStatusResponse) FromJsonString 

func (r *ModifyAppStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyAppStatusResponse) ToJsonString 

func (r *ModifyAppStatusResponse) ToJsonString() string

type RealTimeSpeechStatisticsItem 

type RealTimeSpeechStatisticsItem struct {

	// DAU in Mainland China
	MainLandDau *uint64 `json:"MainLandDau,omitempty" name:"MainLandDau"`

	// PCU in Mainland China
	MainLandPcu *uint64 `json:"MainLandPcu,omitempty" name:"MainLandPcu"`

	// Total duration of use in Mainland China in minutes
	MainLandDuration *uint64 `json:"MainLandDuration,omitempty" name:"MainLandDuration"`

	// DAU outside Mainland China
	OverseaDau *uint64 `json:"OverseaDau,omitempty" name:"OverseaDau"`

	// PCU outside Mainland China
	OverseaPcu *uint64 `json:"OverseaPcu,omitempty" name:"OverseaPcu"`

	// Total duration of use outside Mainland China in minutes
	OverseaDuration *uint64 `json:"OverseaDuration,omitempty" name:"OverseaDuration"`
}

type RealtimeSpeechConf 

type RealtimeSpeechConf struct {

	// Voice chat status. Valid values: open, close
	Status *string `json:"Status,omitempty" name:"Status"`

	// Voice chat sound quality. Valid value: `high`
	Quality *string `json:"Quality,omitempty" name:"Quality"`
}

type ScanDetail 

type ScanDetail struct {

	// Violation scenario. For more information, please see the definition of <a href="https://intl.cloud.tencent.com/document/product/607/37622?from_cn_redirect=1#Label_Value">Label</a>
	Label *string `json:"Label,omitempty" name:"Label"`

	// Confidence score in scenario. Value range: [0.00,100.00]. The higher the score, the more likely the content is non-compliant
	Rate *string `json:"Rate,omitempty" name:"Rate"`

	// Non-compliant keyword
	KeyWord *string `json:"KeyWord,omitempty" name:"KeyWord"`

	// Start time offset in milliseconds from 0 of keyword in audio
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// End time offset in milliseconds from 0 of keyword in audio
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
}

type ScanPiece 

type ScanPiece struct {

	// Audio retention address, which will be returned for stream detection. The audio will be retained for 30 minutes
	// Note: this field may return null, indicating that no valid values can be obtained.
	DumpUrl *string `json:"DumpUrl,omitempty" name:"DumpUrl"`

	// Whether non-compliant information is detected
	HitFlag *bool `json:"HitFlag,omitempty" name:"HitFlag"`

	// Main non-compliant content type
	// Note: this field may return null, indicating that no valid values can be obtained.
	MainType *string `json:"MainType,omitempty" name:"MainType"`

	// Speech detection details
	ScanDetail []*ScanDetail `json:"ScanDetail,omitempty" name:"ScanDetail"`

	// GME voice chat room ID, which is the `RoomId` passed through when the task was submitted
	// Note: this field may return null, indicating that no valid values can be obtained.
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// GME voice chat user ID, which is the `OpenId` passed through when the task was submitted
	// Note: this field may return null, indicating that no valid values can be obtained.
	OpenId *string `json:"OpenId,omitempty" name:"OpenId"`

	// Remarks
	// Note: this field may return null, indicating that no valid values can be obtained.
	Info *string `json:"Info,omitempty" name:"Info"`

	// Offset time in milliseconds of segment in stream during stream detection
	// Note: this field may return null, indicating that no valid values can be obtained.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Segment duration during stream detection
	// Note: this field may return null, indicating that no valid values can be obtained.
	Duration *uint64 `json:"Duration,omitempty" name:"Duration"`

	// Segment detection start time
	// Note: this field may return null, indicating that no valid values can be obtained.
	PieceStartTime *uint64 `json:"PieceStartTime,omitempty" name:"PieceStartTime"`
}

type ScanVoiceRequest 

type ScanVoiceRequest struct {
	*tchttp.BaseRequest

	// Application ID, which is the `AppID` obtained when you create an application in [Console > Service Management](https://console.cloud.tencent.com/gamegme)
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Speech detection scenario. The value of this parameter is currently required to be `default`. Preset scenarios: abusive, pornographic, politically sensitive, advertising, terrorism, and prohibited scenarios. For specific values, please see the <a href="#Label_Value">Label description</a> above.
	Scenes []*string `json:"Scenes,omitempty" name:"Scenes"`

	// Whether it is a live stream. false: audio file detection, true: audio stream detection.
	Live *bool `json:"Live,omitempty" name:"Live"`

	// Speech detection task list. Up to 100 tasks can be added in the list. The structure contains:
	// <li>DataId: unique data ID</li>
	// <li>Url: URL-encoded data file URL, which is a pull address if the detected speech is a stream</li>
	Tasks []*Task `json:"Tasks,omitempty" name:"Tasks"`

	// Async callback address for detection result. For more information, please see the <a href="#Callback_Declare">callback description</a> above. (Note: if this field is empty, the detection result can only be obtained by calling the `DescribeScanResultList` API.)
	Callback *string `json:"Callback,omitempty" name:"Callback"`
}

func NewScanVoiceRequest 

func NewScanVoiceRequest() (request *ScanVoiceRequest)

func (*ScanVoiceRequest) FromJsonString 

func (r *ScanVoiceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ScanVoiceRequest) ToJsonString 

func (r *ScanVoiceRequest) ToJsonString() string

type ScanVoiceResponse 

type ScanVoiceResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Speech detection return. The `Data` field is a JSON array where each element contains: <li>DataId: corresponding `DataId` in request.</li>
		// <li>TaskID: detection task ID, which is used to poll the speech detection result.</li>
		Data []*ScanVoiceResult `json:"Data,omitempty" name:"Data"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewScanVoiceResponse 

func NewScanVoiceResponse() (response *ScanVoiceResponse)

func (*ScanVoiceResponse) FromJsonString 

func (r *ScanVoiceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ScanVoiceResponse) ToJsonString 

func (r *ScanVoiceResponse) ToJsonString() string

type ScanVoiceResult 

type ScanVoiceResult struct {

	// Data ID
	DataId *string `json:"DataId,omitempty" name:"DataId"`

	// Task ID
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`
}

type StatisticsItem 

type StatisticsItem struct {

	// Date in the format of yyyy-mm-dd, such as 2018-07-13
	StatDate *string `json:"StatDate,omitempty" name:"StatDate"`

	// Statistics
	Data *uint64 `json:"Data,omitempty" name:"Data"`
}

type Tag 

type Tag struct {

	// Tag key
	// Note: This field may return null, indicating that no valid values can be obtained.
	TagKey *string `json:"TagKey,omitempty" name:"TagKey"`

	// Tag value
	// Note: This field may return null, indicating that no valid values can be obtained.
	TagValue *string `json:"TagValue,omitempty" name:"TagValue"`
}

type Task 

type Task struct {

	// Unique data ID
	DataId *string `json:"DataId,omitempty" name:"DataId"`

	// URL-encoded data file URL, which is a pull address if the detected speech is a stream
	Url *string `json:"Url,omitempty" name:"Url"`

	// GME voice chat room ID, which is entered during speech detection by GME voice chat
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// GME voice chat user ID, which is entered during speech detection by GME voice chat
	OpenId *string `json:"OpenId,omitempty" name:"OpenId"`
}

type VoiceFilterConf 

type VoiceFilterConf struct {

	// Phrase filtering status. Valid values: open, close
	Status *string `json:"Status,omitempty" name:"Status"`
}

type VoiceFilterStatisticsItem 

type VoiceFilterStatisticsItem struct {

	// Total duration of phrase filtering
	Duration *uint64 `json:"Duration,omitempty" name:"Duration"`
}

type VoiceMessageConf 

type VoiceMessageConf struct {

	// Voice messaging and speech-to-text status. Valid values: open, close
	Status *string `json:"Status,omitempty" name:"Status"`

	// Language supported for voice messaging and speech-to-text. Valid values: all (all languages), cnen (Chinese and English). Default value: cnen
	Language *string `json:"Language,omitempty" name:"Language"`
}

type VoiceMessageStatisticsItem 

type VoiceMessageStatisticsItem struct {

	// DAU of voice messaging and speech-to-text
	Dau *uint64 `json:"Dau,omitempty" name:"Dau"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.