v20180711

package
v3.0.753+incompatible Latest Latest
Warning

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

Go to latest
Published: Aug 7, 2023 License: Apache-2.0 Imports: 7 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"

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

	// The entered query date range is longer than 60 days.
	INVALIDPARAMETER_DATEOUTOFSIXTYDAYS = "InvalidParameter.DateOutOfSixtyDays"

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

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

	// Invalid BizId.
	INVALIDPARAMETERVALUE_INVALIDBIZID = "InvalidParameterValue.InvalidBizId"

	// Invalid RecordMode.
	INVALIDPARAMETERVALUE_INVALIDRECORDMODE = "InvalidParameterValue.InvalidRecordMode"

	// Invalid RoomId.
	INVALIDPARAMETERVALUE_INVALIDROOMID = "InvalidParameterValue.InvalidRoomId"

	// Incorrect blocklist/allowlist format.
	INVALIDPARAMETERVALUE_INVALIDSUBSCRIBERECORDUSERIDS = "InvalidParameterValue.InvalidSubscribeRecordUserIds"

	// The number of entries on the allowlist exceeds 20.
	INVALIDPARAMETERVALUE_INVALIDSUBSCRIBEUSERIDS = "InvalidParameterValue.InvalidSubscribeUserIds"

	// Invalid taskid.
	INVALIDPARAMETERVALUE_INVALIDTASKID = "InvalidParameterValue.InvalidTaskId"

	// The number of entries on the blocklist exceeds 20.
	INVALIDPARAMETERVALUE_INVALIDUNSUBSCRIBEUSERIDS = "InvalidParameterValue.InvalidUNSubscribeUserIds"

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

	// Parameter missing.
	MISSINGPARAMETER = "MissingParameter"

	// Operation denied.
	OPERATIONDENIED = "OperationDenied"

	// The task already exists.
	RESOURCEINUSE_TASKINUSE = "ResourceInUse.TaskInUse"

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

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

	// The room does not exist.
	RESOURCENOTFOUND_ROOMNOTFOUND = "ResourceNotFound.RoomNotFound"

	// The task ID does not exist.
	RESOURCENOTFOUND_TASKNOTFOUND = "ResourceNotFound.TaskNotFound"

	// Unauthorized operation.
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

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

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

	// Unknown parameter error.
	UNKNOWNPARAMETER = "UnknownParameter"

	// Operation unsupported.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"

	// The recording service is not activated.
	UNSUPPORTEDOPERATION_SERVICENOTOPENED = "UnsupportedOperation.ServiceNotOpened"
)
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 Message 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"`

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

	// Recording-to-Text usage statistics
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	AudioTextStatisticsItem *AudioTextStatisticsItem `json:"AudioTextStatisticsItem,omitempty" name:"AudioTextStatisticsItem"`

	// Stream-to-Text usage statistics
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	StreamTextStatisticsItem *StreamTextStatisticsItem `json:"StreamTextStatisticsItem,omitempty" name:"StreamTextStatisticsItem"`

	// Usage statistics of Voice-to-Text of outside-MLC requests
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	OverseaTextStatisticsItem *OverseaTextStatisticsItem `json:"OverseaTextStatisticsItem,omitempty" name:"OverseaTextStatisticsItem"`

	// Real-time Voice-to-Text usage statistics
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	RealtimeTextStatisticsItem *RealtimeTextStatisticsItem `json:"RealtimeTextStatisticsItem,omitempty" name:"RealtimeTextStatisticsItem"`
}

type ApplicationDataStatistics

type ApplicationDataStatistics struct {
	// Application ID
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Number of DAU metrics
	DauDataNum *uint64 `json:"DauDataNum,omitempty" name:"DauDataNum"`

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

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

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

	// Number of Voice Chat metrics
	DurationDataNum *uint64 `json:"DurationDataNum,omitempty" name:"DurationDataNum"`

	// Duration of Voice Chat in the Chinese mainland (in minutes)
	DurationDataMainland []*StatisticsItem `json:"DurationDataMainland,omitempty" name:"DurationDataMainland"`

	// Duration of Voice Chat outside the 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"`

	// Number of PCU metrics
	PcuDataNum *uint64 `json:"PcuDataNum,omitempty" name:"PcuDataNum"`

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

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

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

type AsrConf

type AsrConf struct {
	// Speech-to-Text status. Valid values: `open`, `close`.
	Status *string `json:"Status,omitempty" name:"Status"`
}

type AudioTextStatisticsItem

type AudioTextStatisticsItem struct {
	// Statistical value (in seconds)
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	Data *float64 `json:"Data,omitempty" name:"Data"`
}

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) CreateAppWithContext

func (c *Client) CreateAppWithContext(ctx context.Context, 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) DeleteRoomMember

func (c *Client) DeleteRoomMember(request *DeleteRoomMemberRequest) (response *DeleteRoomMemberResponse, err error)

DeleteRoomMember This API is used to delete a room or remove members from the room.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteRoomMemberWithContext

func (c *Client) DeleteRoomMemberWithContext(ctx context.Context, request *DeleteRoomMemberRequest) (response *DeleteRoomMemberResponse, err error)

DeleteRoomMember This API is used to delete a room or remove members from the room.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeAppStatistics

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

DescribeAppStatistics This API is used to query the usage statistics of a GME application, including those of Voice Chat, Voice Message Service, Voice 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_DATEOUTOFSIXTYDAYS = "InvalidParameter.DateOutOfSixtyDays"
INVALIDPARAMETER_TIMERANGEERROR = "InvalidParameter.TimeRangeError"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_BIZIDISNOTFOUND = "ResourceNotFound.BizidIsNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeAppStatisticsWithContext

func (c *Client) DescribeAppStatisticsWithContext(ctx context.Context, request *DescribeAppStatisticsRequest) (response *DescribeAppStatisticsResponse, err error)

DescribeAppStatistics This API is used to query the usage statistics of a GME application, including those of Voice Chat, Voice Message Service, Voice 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_DATEOUTOFSIXTYDAYS = "InvalidParameter.DateOutOfSixtyDays"
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 is used to query data details for up to the past 90 days.

error code that may be returned:

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

func (*Client) DescribeApplicationDataWithContext

func (c *Client) DescribeApplicationDataWithContext(ctx context.Context, request *DescribeApplicationDataRequest) (response *DescribeApplicationDataResponse, err error)

DescribeApplicationData This API is used to query data details for up to the past 90 days.

error code that may be returned:

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

func (*Client) DescribeRecordInfo

func (c *Client) DescribeRecordInfo(request *DescribeRecordInfoRequest) (response *DescribeRecordInfoResponse, err error)

DescribeRecordInfo This API is used to query a recording task.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDBIZID = "InvalidParameterValue.InvalidBizId"
INVALIDPARAMETERVALUE_INVALIDTASKID = "InvalidParameterValue.InvalidTaskId"
RESOURCENOTFOUND_TASKNOTFOUND = "ResourceNotFound.TaskNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_SERVICENOTOPENED = "UnsupportedOperation.ServiceNotOpened"

func (*Client) DescribeRecordInfoWithContext

func (c *Client) DescribeRecordInfoWithContext(ctx context.Context, request *DescribeRecordInfoRequest) (response *DescribeRecordInfoResponse, err error)

DescribeRecordInfo This API is used to query a recording task.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDBIZID = "InvalidParameterValue.InvalidBizId"
INVALIDPARAMETERVALUE_INVALIDTASKID = "InvalidParameterValue.InvalidTaskId"
RESOURCENOTFOUND_TASKNOTFOUND = "ResourceNotFound.TaskNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_SERVICENOTOPENED = "UnsupportedOperation.ServiceNotOpened"

func (*Client) DescribeTaskInfo

func (c *Client) DescribeTaskInfo(request *DescribeTaskInfoRequest) (response *DescribeTaskInfoResponse, err error)

DescribeTaskInfo This API is used to query the recording task in a room.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDBIZID = "InvalidParameterValue.InvalidBizId"
INVALIDPARAMETERVALUE_INVALIDROOMID = "InvalidParameterValue.InvalidRoomId"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_ROOMNOTFOUND = "ResourceNotFound.RoomNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_SERVICENOTOPENED = "UnsupportedOperation.ServiceNotOpened"

func (*Client) DescribeTaskInfoWithContext

func (c *Client) DescribeTaskInfoWithContext(ctx context.Context, request *DescribeTaskInfoRequest) (response *DescribeTaskInfoResponse, err error)

DescribeTaskInfo This API is used to query the recording task in a room.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDBIZID = "InvalidParameterValue.InvalidBizId"
INVALIDPARAMETERVALUE_INVALIDROOMID = "InvalidParameterValue.InvalidRoomId"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_ROOMNOTFOUND = "ResourceNotFound.RoomNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_SERVICENOTOPENED = "UnsupportedOperation.ServiceNotOpened"

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.

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) ModifyAppStatusWithContext

func (c *Client) ModifyAppStatusWithContext(ctx context.Context, request *ModifyAppStatusRequest) (response *ModifyAppStatusResponse, err error)

ModifyAppStatus This API is used to change the status of an application.

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) ModifyRecordInfo

func (c *Client) ModifyRecordInfo(request *ModifyRecordInfoRequest) (response *ModifyRecordInfoResponse, err error)

ModifyRecordInfo This API is used to modify recording configurations.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDBIZID = "InvalidParameterValue.InvalidBizId"
INVALIDPARAMETERVALUE_INVALIDRECORDMODE = "InvalidParameterValue.InvalidRecordMode"
INVALIDPARAMETERVALUE_INVALIDSUBSCRIBERECORDUSERIDS = "InvalidParameterValue.InvalidSubscribeRecordUserIds"
INVALIDPARAMETERVALUE_INVALIDSUBSCRIBEUSERIDS = "InvalidParameterValue.InvalidSubscribeUserIds"
INVALIDPARAMETERVALUE_INVALIDTASKID = "InvalidParameterValue.InvalidTaskId"
INVALIDPARAMETERVALUE_INVALIDUNSUBSCRIBEUSERIDS = "InvalidParameterValue.InvalidUNSubscribeUserIds"
RESOURCENOTFOUND_TASKNOTFOUND = "ResourceNotFound.TaskNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_SERVICENOTOPENED = "UnsupportedOperation.ServiceNotOpened"

func (*Client) ModifyRecordInfoWithContext

func (c *Client) ModifyRecordInfoWithContext(ctx context.Context, request *ModifyRecordInfoRequest) (response *ModifyRecordInfoResponse, err error)

ModifyRecordInfo This API is used to modify recording configurations.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDBIZID = "InvalidParameterValue.InvalidBizId"
INVALIDPARAMETERVALUE_INVALIDRECORDMODE = "InvalidParameterValue.InvalidRecordMode"
INVALIDPARAMETERVALUE_INVALIDSUBSCRIBERECORDUSERIDS = "InvalidParameterValue.InvalidSubscribeRecordUserIds"
INVALIDPARAMETERVALUE_INVALIDSUBSCRIBEUSERIDS = "InvalidParameterValue.InvalidSubscribeUserIds"
INVALIDPARAMETERVALUE_INVALIDTASKID = "InvalidParameterValue.InvalidTaskId"
INVALIDPARAMETERVALUE_INVALIDUNSUBSCRIBEUSERIDS = "InvalidParameterValue.InvalidUNSubscribeUserIds"
RESOURCENOTFOUND_TASKNOTFOUND = "ResourceNotFound.TaskNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_SERVICENOTOPENED = "UnsupportedOperation.ServiceNotOpened"

func (*Client) StartRecord

func (c *Client) StartRecord(request *StartRecordRequest) (response *StartRecordResponse, err error)

StartRecord This API is used to start recording.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDBIZID = "InvalidParameterValue.InvalidBizId"
INVALIDPARAMETERVALUE_INVALIDRECORDMODE = "InvalidParameterValue.InvalidRecordMode"
INVALIDPARAMETERVALUE_INVALIDROOMID = "InvalidParameterValue.InvalidRoomId"
INVALIDPARAMETERVALUE_INVALIDSUBSCRIBERECORDUSERIDS = "InvalidParameterValue.InvalidSubscribeRecordUserIds"
INVALIDPARAMETERVALUE_INVALIDSUBSCRIBEUSERIDS = "InvalidParameterValue.InvalidSubscribeUserIds"
INVALIDPARAMETERVALUE_INVALIDUNSUBSCRIBEUSERIDS = "InvalidParameterValue.InvalidUNSubscribeUserIds"
RESOURCEINUSE_TASKINUSE = "ResourceInUse.TaskInUse"
RESOURCENOTFOUND_ROOMNOTFOUND = "ResourceNotFound.RoomNotFound"
RESOURCENOTFOUND_TASKNOTFOUND = "ResourceNotFound.TaskNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_SERVICENOTOPENED = "UnsupportedOperation.ServiceNotOpened"

func (*Client) StartRecordWithContext

func (c *Client) StartRecordWithContext(ctx context.Context, request *StartRecordRequest) (response *StartRecordResponse, err error)

StartRecord This API is used to start recording.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDBIZID = "InvalidParameterValue.InvalidBizId"
INVALIDPARAMETERVALUE_INVALIDRECORDMODE = "InvalidParameterValue.InvalidRecordMode"
INVALIDPARAMETERVALUE_INVALIDROOMID = "InvalidParameterValue.InvalidRoomId"
INVALIDPARAMETERVALUE_INVALIDSUBSCRIBERECORDUSERIDS = "InvalidParameterValue.InvalidSubscribeRecordUserIds"
INVALIDPARAMETERVALUE_INVALIDSUBSCRIBEUSERIDS = "InvalidParameterValue.InvalidSubscribeUserIds"
INVALIDPARAMETERVALUE_INVALIDUNSUBSCRIBEUSERIDS = "InvalidParameterValue.InvalidUNSubscribeUserIds"
RESOURCEINUSE_TASKINUSE = "ResourceInUse.TaskInUse"
RESOURCENOTFOUND_ROOMNOTFOUND = "ResourceNotFound.RoomNotFound"
RESOURCENOTFOUND_TASKNOTFOUND = "ResourceNotFound.TaskNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_SERVICENOTOPENED = "UnsupportedOperation.ServiceNotOpened"

func (*Client) StopRecord

func (c *Client) StopRecord(request *StopRecordRequest) (response *StopRecordResponse, err error)

StopRecord This API is used to stop recording.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDBIZID = "InvalidParameterValue.InvalidBizId"
INVALIDPARAMETERVALUE_INVALIDTASKID = "InvalidParameterValue.InvalidTaskId"
RESOURCENOTFOUND_TASKNOTFOUND = "ResourceNotFound.TaskNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_SERVICENOTOPENED = "UnsupportedOperation.ServiceNotOpened"

func (*Client) StopRecordWithContext

func (c *Client) StopRecordWithContext(ctx context.Context, request *StopRecordRequest) (response *StopRecordResponse, err error)

StopRecord This API is used to stop recording.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDBIZID = "InvalidParameterValue.InvalidBizId"
INVALIDPARAMETERVALUE_INVALIDTASKID = "InvalidParameterValue.InvalidTaskId"
RESOURCENOTFOUND_TASKNOTFOUND = "ResourceNotFound.TaskNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_SERVICENOTOPENED = "UnsupportedOperation.ServiceNotOpened"

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 that the default project is used.
	ProjectId *uint64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// List of engines to be supported.
	// Valid values: `android`, `ios`, `unity`, `cocos`, `unreal`, `windows`. All values are selected by default.
	EngineList []*string `json:"EngineList,omitempty" name:"EngineList"`

	// List of regions.
	// Valid values: `mainland` (Chinese mainland), `hmt` (Hong Kong, Macao and Taiwan (China)), `sea` (Southeast Asia), `na` (North America), `eu` (Europe), `jpkr` (Japan, Korea and Asia Pacific), `sa` (South America), `oc` (Oceania), `me` (Middle East). 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
	VoiceMessageConf *VoiceMessageConf `json:"VoiceMessageConf,omitempty" name:"VoiceMessageConf"`

	// Configuration information of Voice Analysis Service
	VoiceFilterConf *VoiceFilterConf `json:"VoiceFilterConf,omitempty" name:"VoiceFilterConf"`

	// Configuration information of Speech-to-Text
	AsrConf *AsrConf `json:"AsrConf,omitempty" name:"AsrConf"`

	// 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 CreateAppRequestParams

type CreateAppRequestParams struct {
	// Application name
	AppName *string `json:"AppName,omitempty" name:"AppName"`

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

	// List of engines to be supported.
	// Valid values: `android`, `ios`, `unity`, `cocos`, `unreal`, `windows`. All values are selected by default.
	EngineList []*string `json:"EngineList,omitempty" name:"EngineList"`

	// List of regions.
	// Valid values: `mainland` (Chinese mainland), `hmt` (Hong Kong, Macao and Taiwan (China)), `sea` (Southeast Asia), `na` (North America), `eu` (Europe), `jpkr` (Japan, Korea and Asia Pacific), `sa` (South America), `oc` (Oceania), `me` (Middle East). 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
	VoiceMessageConf *VoiceMessageConf `json:"VoiceMessageConf,omitempty" name:"VoiceMessageConf"`

	// Configuration information of Voice Analysis Service
	VoiceFilterConf *VoiceFilterConf `json:"VoiceFilterConf,omitempty" name:"VoiceFilterConf"`

	// Configuration information of Speech-to-Text
	AsrConf *AsrConf `json:"AsrConf,omitempty" name:"AsrConf"`

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

Predefined struct for user

type CreateAppResp

type CreateAppResp struct {
	// Application ID, automatically generated by the backend.
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Application 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"`

	// Application 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
	VoiceMessageConf *VoiceMessageConf `json:"VoiceMessageConf,omitempty" name:"VoiceMessageConf"`

	// Configuration information of Voice Analysis Service
	VoiceFilterConf *VoiceFilterConf `json:"VoiceFilterConf,omitempty" name:"VoiceFilterConf"`

	// Configuration information of Speech-to-Text
	AsrConf *AsrConf `json:"AsrConf,omitempty" name:"AsrConf"`
}

type CreateAppResponse

type CreateAppResponse struct {
	*tchttp.BaseResponse
	Response *CreateAppResponseParams `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 CreateAppResponseParams

type CreateAppResponseParams 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"`
}

Predefined struct for user

type DeleteResult

type DeleteResult struct {
	// Status code. `0`: Succeeded. Others: Failed\
	Code *int64 `json:"Code,omitempty" name:"Code"`

	// Description
	ErrorMsg *string `json:"ErrorMsg,omitempty" name:"ErrorMsg"`
}

type DeleteRoomMemberRequest

type DeleteRoomMemberRequest struct {
	*tchttp.BaseRequest

	// ID of the target room
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// List of the members to remove
	Uids []*string `json:"Uids,omitempty" name:"Uids"`

	// Operation type. `1`: Delete a room; `2`: Remove members
	DeleteType *uint64 `json:"DeleteType,omitempty" name:"DeleteType"`

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

func NewDeleteRoomMemberRequest

func NewDeleteRoomMemberRequest() (request *DeleteRoomMemberRequest)

func (*DeleteRoomMemberRequest) FromJsonString

func (r *DeleteRoomMemberRequest) 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 (*DeleteRoomMemberRequest) ToJsonString

func (r *DeleteRoomMemberRequest) ToJsonString() string

type DeleteRoomMemberRequestParams

type DeleteRoomMemberRequestParams struct {
	// ID of the target room
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// List of the members to remove
	Uids []*string `json:"Uids,omitempty" name:"Uids"`

	// Operation type. `1`: Delete a room; `2`: Remove members
	DeleteType *uint64 `json:"DeleteType,omitempty" name:"DeleteType"`

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

Predefined struct for user

type DeleteRoomMemberResponse

type DeleteRoomMemberResponse struct {
	*tchttp.BaseResponse
	Response *DeleteRoomMemberResponseParams `json:"Response"`
}

func NewDeleteRoomMemberResponse

func NewDeleteRoomMemberResponse() (response *DeleteRoomMemberResponse)

func (*DeleteRoomMemberResponse) FromJsonString

func (r *DeleteRoomMemberResponse) 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 (*DeleteRoomMemberResponse) ToJsonString

func (r *DeleteRoomMemberResponse) ToJsonString() string

type DeleteRoomMemberResponseParams

type DeleteRoomMemberResponseParams struct {
	// Result of the operation to delete a room or remove a member
	DeleteResult *DeleteResult `json:"DeleteResult,omitempty" name:"DeleteResult"`

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

Predefined struct for user

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`, `SpeechToText`.
	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 DescribeAppStatisticsRequestParams

type DescribeAppStatisticsRequestParams struct {
	// 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`, `SpeechToText`.
	Services []*string `json:"Services,omitempty" name:"Services"`
}

Predefined struct for user

type DescribeAppStatisticsResp

type DescribeAppStatisticsResp struct {
	// Application usage statistics
	AppStatistics []*AppStatisticsItem `json:"AppStatistics,omitempty" name:"AppStatistics"`
}

type DescribeAppStatisticsResponse

type DescribeAppStatisticsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAppStatisticsResponseParams `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 DescribeAppStatisticsResponseParams

type DescribeAppStatisticsResponseParams struct {
	// Application 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"`
}

Predefined struct for user

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 DescribeApplicationDataRequestParams

type DescribeApplicationDataRequestParams struct {
	// 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"`
}

Predefined struct for user

type DescribeApplicationDataResponse

type DescribeApplicationDataResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApplicationDataResponseParams `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 DescribeApplicationDataResponseParams

type DescribeApplicationDataResponseParams 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"`
}

Predefined struct for user

type DescribeRecordInfoRequest

type DescribeRecordInfoRequest struct {
	*tchttp.BaseRequest

	// ID of the ongoing task, which is returned from the `StartRecord` API.
	TaskId *uint64 `json:"TaskId,omitempty" name:"TaskId"`

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

func NewDescribeRecordInfoRequest

func NewDescribeRecordInfoRequest() (request *DescribeRecordInfoRequest)

func (*DescribeRecordInfoRequest) FromJsonString

func (r *DescribeRecordInfoRequest) 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 (*DescribeRecordInfoRequest) ToJsonString

func (r *DescribeRecordInfoRequest) ToJsonString() string

type DescribeRecordInfoRequestParams

type DescribeRecordInfoRequestParams struct {
	// ID of the ongoing task, which is returned from the `StartRecord` API.
	TaskId *uint64 `json:"TaskId,omitempty" name:"TaskId"`

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

Predefined struct for user

type DescribeRecordInfoResponse

type DescribeRecordInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRecordInfoResponseParams `json:"Response"`
}

func NewDescribeRecordInfoResponse

func NewDescribeRecordInfoResponse() (response *DescribeRecordInfoResponse)

func (*DescribeRecordInfoResponse) FromJsonString

func (r *DescribeRecordInfoResponse) 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 (*DescribeRecordInfoResponse) ToJsonString

func (r *DescribeRecordInfoResponse) ToJsonString() string

type DescribeRecordInfoResponseParams

type DescribeRecordInfoResponseParams struct {
	// Information about the recording task.
	// Note: This field may return null, indicating that no valid values can be obtained.
	RecordInfo []*RecordInfo `json:"RecordInfo,omitempty" name:"RecordInfo"`

	// Recording mode. Valid values: `1`: single stream; `2`: mixed streams; `3`: single stream and mixed streams.
	RecordMode *uint64 `json:"RecordMode,omitempty" name:"RecordMode"`

	// Room ID.
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

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

Predefined struct for user

type DescribeTaskInfoRequest

type DescribeTaskInfoRequest struct {
	*tchttp.BaseRequest

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

	// Room ID.
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`
}

func NewDescribeTaskInfoRequest

func NewDescribeTaskInfoRequest() (request *DescribeTaskInfoRequest)

func (*DescribeTaskInfoRequest) FromJsonString

func (r *DescribeTaskInfoRequest) 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 (*DescribeTaskInfoRequest) ToJsonString

func (r *DescribeTaskInfoRequest) ToJsonString() string

type DescribeTaskInfoRequestParams

type DescribeTaskInfoRequestParams struct {
	// Application ID.
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Room ID.
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`
}

Predefined struct for user

type DescribeTaskInfoResponse

type DescribeTaskInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTaskInfoResponseParams `json:"Response"`
}

func NewDescribeTaskInfoResponse

func NewDescribeTaskInfoResponse() (response *DescribeTaskInfoResponse)

func (*DescribeTaskInfoResponse) FromJsonString

func (r *DescribeTaskInfoResponse) 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 (*DescribeTaskInfoResponse) ToJsonString

func (r *DescribeTaskInfoResponse) ToJsonString() string

type DescribeTaskInfoResponseParams

type DescribeTaskInfoResponseParams struct {
	// ID of the ongoing task, which is returned from the `StartRecord` API.
	// Note: This field may return null, indicating that no valid values can be obtained.
	TaskId *uint64 `json:"TaskId,omitempty" name:"TaskId"`

	// Recording mode. Valid values: `1`: single stream; `2`: mixed streams; `3`: single stream and mixed streams.
	// Note: This field may return null, indicating that no valid values can be obtained.
	RecordMode *uint64 `json:"RecordMode,omitempty" name:"RecordMode"`

	// Allowlist or blocklist for stream subscription.
	// Note: This field may return null, indicating that no valid values can be obtained.
	SubscribeRecordUserIds *SubscribeRecordUserIds `json:"SubscribeRecordUserIds,omitempty" name:"SubscribeRecordUserIds"`

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

Predefined struct for user

type ModifyAppStatusRequest

type ModifyAppStatusRequest struct {
	*tchttp.BaseRequest

	// Application ID, which is generated and returned by the backend after the 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 ModifyAppStatusRequestParams

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

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

Predefined struct for user

type ModifyAppStatusResp

type ModifyAppStatusResp struct {
	// GME application ID
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

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

type ModifyAppStatusResponse

type ModifyAppStatusResponse struct {
	*tchttp.BaseResponse
	Response *ModifyAppStatusResponseParams `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 ModifyAppStatusResponseParams

type ModifyAppStatusResponseParams 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"`
}

Predefined struct for user

type ModifyRecordInfoRequest

type ModifyRecordInfoRequest struct {
	*tchttp.BaseRequest

	// ID of the ongoing task, which is returned from the `StartRecord` API.
	TaskId *uint64 `json:"TaskId,omitempty" name:"TaskId"`

	// Recording mode. Valid values: `1`: single stream; `2`: mixed streams; `3`: single stream and mixed streams.
	RecordMode *uint64 `json:"RecordMode,omitempty" name:"RecordMode"`

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

	// Allowlist or blocklist for stream subscription.
	SubscribeRecordUserIds *SubscribeRecordUserIds `json:"SubscribeRecordUserIds,omitempty" name:"SubscribeRecordUserIds"`
}

func NewModifyRecordInfoRequest

func NewModifyRecordInfoRequest() (request *ModifyRecordInfoRequest)

func (*ModifyRecordInfoRequest) FromJsonString

func (r *ModifyRecordInfoRequest) 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 (*ModifyRecordInfoRequest) ToJsonString

func (r *ModifyRecordInfoRequest) ToJsonString() string

type ModifyRecordInfoRequestParams

type ModifyRecordInfoRequestParams struct {
	// ID of the ongoing task, which is returned from the `StartRecord` API.
	TaskId *uint64 `json:"TaskId,omitempty" name:"TaskId"`

	// Recording mode. Valid values: `1`: single stream; `2`: mixed streams; `3`: single stream and mixed streams.
	RecordMode *uint64 `json:"RecordMode,omitempty" name:"RecordMode"`

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

	// Allowlist or blocklist for stream subscription.
	SubscribeRecordUserIds *SubscribeRecordUserIds `json:"SubscribeRecordUserIds,omitempty" name:"SubscribeRecordUserIds"`
}

Predefined struct for user

type ModifyRecordInfoResponse

type ModifyRecordInfoResponse struct {
	*tchttp.BaseResponse
	Response *ModifyRecordInfoResponseParams `json:"Response"`
}

func NewModifyRecordInfoResponse

func NewModifyRecordInfoResponse() (response *ModifyRecordInfoResponse)

func (*ModifyRecordInfoResponse) FromJsonString

func (r *ModifyRecordInfoResponse) 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 (*ModifyRecordInfoResponse) ToJsonString

func (r *ModifyRecordInfoResponse) ToJsonString() string

type ModifyRecordInfoResponseParams

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

Predefined struct for user

type OverseaTextStatisticsItem

type OverseaTextStatisticsItem struct {
	// Statistical value (in seconds)
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	Data *float64 `json:"Data,omitempty" name:"Data"`
}

type RealTimeSpeechStatisticsItem

type RealTimeSpeechStatisticsItem struct {
	// DAUs in the Chinese mainland
	MainLandDau *uint64 `json:"MainLandDau,omitempty" name:"MainLandDau"`

	// PCUs in the Chinese mainland
	MainLandPcu *uint64 `json:"MainLandPcu,omitempty" name:"MainLandPcu"`

	// Total duration of use in the Chinese mainland (in minutes)
	MainLandDuration *uint64 `json:"MainLandDuration,omitempty" name:"MainLandDuration"`

	// DAUs outside the Chinese mainland
	OverseaDau *uint64 `json:"OverseaDau,omitempty" name:"OverseaDau"`

	// PCUs outside the Chinese mainland
	OverseaPcu *uint64 `json:"OverseaPcu,omitempty" name:"OverseaPcu"`

	// Total duration of use outside the Chinese mainland (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 type. Valid values: `high` (HD), `ordinary` (SD).
	Quality *string `json:"Quality,omitempty" name:"Quality"`
}

type RealtimeTextStatisticsItem

type RealtimeTextStatisticsItem struct {
	// Statistical value (in seconds)
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	Data *float64 `json:"Data,omitempty" name:"Data"`
}

type RecordInfo

type RecordInfo struct {
	// User ID. The value is `0` in mixed streams recording mode.
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// Recording filename.
	FileName *string `json:"FileName,omitempty" name:"FileName"`

	// Recording start time, which is a Unix timestamp. Example: 1234567868.
	RecordBeginTime *uint64 `json:"RecordBeginTime,omitempty" name:"RecordBeginTime"`

	// Recording status. Valid values: `2`: recording; `10`: to be transcoded; `11`: transcoding; `12`: uploading; `13`: uploaded; `14`: user notified.
	RecordStatus *uint64 `json:"RecordStatus,omitempty" name:"RecordStatus"`
}

type SceneInfo

type SceneInfo struct {
}

type StartRecordRequest

type StartRecordRequest struct {
	*tchttp.BaseRequest

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

	// Room ID.
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// Recording mode. Valid values: `1`: single stream; `2`: mixed streams; `3`: single stream and mixed streams.
	RecordMode *uint64 `json:"RecordMode,omitempty" name:"RecordMode"`

	// Allowlist or blocklist for stream subscription. If you do not specify this parameter, the audio streams of all the users in the room are subscribed to by default.
	SubscribeRecordUserIds *SubscribeRecordUserIds `json:"SubscribeRecordUserIds,omitempty" name:"SubscribeRecordUserIds"`
}

func NewStartRecordRequest

func NewStartRecordRequest() (request *StartRecordRequest)

func (*StartRecordRequest) FromJsonString

func (r *StartRecordRequest) 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 (*StartRecordRequest) ToJsonString

func (r *StartRecordRequest) ToJsonString() string

type StartRecordRequestParams

type StartRecordRequestParams struct {
	// Application ID.
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Room ID.
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// Recording mode. Valid values: `1`: single stream; `2`: mixed streams; `3`: single stream and mixed streams.
	RecordMode *uint64 `json:"RecordMode,omitempty" name:"RecordMode"`

	// Allowlist or blocklist for stream subscription. If you do not specify this parameter, the audio streams of all the users in the room are subscribed to by default.
	SubscribeRecordUserIds *SubscribeRecordUserIds `json:"SubscribeRecordUserIds,omitempty" name:"SubscribeRecordUserIds"`
}

Predefined struct for user

type StartRecordResponse

type StartRecordResponse struct {
	*tchttp.BaseResponse
	Response *StartRecordResponseParams `json:"Response"`
}

func NewStartRecordResponse

func NewStartRecordResponse() (response *StartRecordResponse)

func (*StartRecordResponse) FromJsonString

func (r *StartRecordResponse) 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 (*StartRecordResponse) ToJsonString

func (r *StartRecordResponse) ToJsonString() string

type StartRecordResponseParams

type StartRecordResponseParams struct {
	// Task ID.
	TaskId *uint64 `json:"TaskId,omitempty" name:"TaskId"`

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

Predefined struct for user

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

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

type StopRecordRequest

type StopRecordRequest struct {
	*tchttp.BaseRequest

	// Task ID.
	TaskId *uint64 `json:"TaskId,omitempty" name:"TaskId"`

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

func NewStopRecordRequest

func NewStopRecordRequest() (request *StopRecordRequest)

func (*StopRecordRequest) FromJsonString

func (r *StopRecordRequest) 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 (*StopRecordRequest) ToJsonString

func (r *StopRecordRequest) ToJsonString() string

type StopRecordRequestParams

type StopRecordRequestParams struct {
	// Task ID.
	TaskId *uint64 `json:"TaskId,omitempty" name:"TaskId"`

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

Predefined struct for user

type StopRecordResponse

type StopRecordResponse struct {
	*tchttp.BaseResponse
	Response *StopRecordResponseParams `json:"Response"`
}

func NewStopRecordResponse

func NewStopRecordResponse() (response *StopRecordResponse)

func (*StopRecordResponse) FromJsonString

func (r *StopRecordResponse) 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 (*StopRecordResponse) ToJsonString

func (r *StopRecordResponse) ToJsonString() string

type StopRecordResponseParams

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

Predefined struct for user

type StreamTextStatisticsItem

type StreamTextStatisticsItem struct {
	// Usage of the service (in seconds)
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	Data *float64 `json:"Data,omitempty" name:"Data"`
}

type SubscribeRecordUserIds

type SubscribeRecordUserIds struct {
	// Blocklist for audio subscription. For example, `["1", "2", "3"]` means to not subscribe to the audio streams of users 1, 2, and 3. If this parameter is left empty, the audio streams of all users (max 20) in the room will not be subscribed to.
	// Note: You cannot specify `UnSubscribeAudioUserIds` and `SubscribeAudioUserIds` at the same time.
	UnSubscribeUserIds []*string `json:"UnSubscribeUserIds,omitempty" name:"UnSubscribeUserIds"`

	// Allowlist for audio subscription. For example, `["1", "2", "3"]` means to subscribe to the audio streams of users 1, 2, and 3. If this parameter is left empty, the audio streams of all users (max 20) in the room will be subscribed to.
	// Note: You cannot specify `UnSubscribeAudioUserIds` and `SubscribeAudioUserIds` at the same time.
	SubscribeUserIds []*string `json:"SubscribeUserIds,omitempty" name:"SubscribeUserIds"`
}

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 VoiceFilterConf

type VoiceFilterConf struct {
	// Phrase Filtering status. Valid values: `open`, `close`.
	Status *string `json:"Status,omitempty" name:"Status"`

	// Scenario configuration information, such as status and callback URL.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	SceneInfos []*SceneInfo `json:"SceneInfos,omitempty" name:"SceneInfos"`
}

type VoiceFilterStatisticsItem

type VoiceFilterStatisticsItem struct {
	// Total duration of phrase filtering (in minutes)
	Duration *uint64 `json:"Duration,omitempty" name:"Duration"`
}

type VoiceMessageConf

type VoiceMessageConf struct {
	// Voice Message Service status. Valid values: `open`, `close`.
	Status *string `json:"Status,omitempty" name:"Status"`

	// Language supported for Voice Message Service. Valid values: `all` (all languages), `cnen` (Chinese and English). Default value: `cnen`.
	Language *string `json:"Language,omitempty" name:"Language"`
}

type VoiceMessageStatisticsItem

type VoiceMessageStatisticsItem struct {
	// DAUs of Voice Message Service
	Dau *uint64 `json:"Dau,omitempty" name:"Dau"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL