v20190722

package
v3.0.957+incompatible Latest Latest
Warning

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

 Go to latest Published: May 15, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// CAM signature/authentication error.
	AUTHFAILURE = "AuthFailure"

	// Identity verification has not been completed, so this operation is not allowed.
	AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"

	// CAM authentication failed.
	AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"

	// Unsupported operation.
	AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// Unsupported on-cloud recording method.
	FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"

	//
	FAILEDOPERATION_NOTRTMPFUNCTION = "FailedOperation.NotRtmpFunction"

	// Query task failed
	FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed"

	// Maximum number of concurrent on-cloud recording tasks reached. Contact us to raise the limit.
	FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency"

	// The room does not exist.
	FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"

	// The application ID does not exist.
	FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist"

	// Task already exists
	FAILEDOPERATION_TASKEXIST = "FailedOperation.TaskExist"

	// Task has ended when calling the interface.
	FAILEDOPERATION_TASKFINISHED = "FailedOperation.TaskFinished"

	// The user is not in the room.
	FAILEDOPERATION_USERNOTEXIST = "FailedOperation.UserNotExist"

	// Internal error.
	INTERNALERROR = "InternalError"

	// On-cloud recording internal error.
	INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError"

	// An error occurred while querying the database.
	INTERNALERROR_DBERROR = "InternalError.DBError"

	// An error occurred during an ES query.
	INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError"

	// Failed to query the room.
	INTERNALERROR_GETROOMCACHEIPERROR = "InternalError.GetRoomCacheIpError"

	// Failed to get room information.
	INTERNALERROR_GETROOMFROMCACHEERROR = "InternalError.GetRoomFromCacheError"

	// Failed to parse the HTTP request.
	INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"

	// HTTP request parsing failed.
	INTERNALERROR_HTTPPARSEFAILED = "InternalError.HttpParseFailed"

	// API error.
	INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"

	// Internal error, please retry.
	INTERNALERROR_INTERNALERROR = "InternalError.InternalError"

	// Unsupported method.
	INTERNALERROR_METHODERR = "InternalError.MethodErr"

	// The user is not in the room.
	INTERNALERROR_USERNOTEXIST = "InternalError.UserNotExist"

	// Parameter error.
	INVALIDPARAMETER = "InvalidParameter"

	// Failed to parse body parameters.
	INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"

	// Invalid `EncodeParams`.
	INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams"

	// Invalid `EndTs`.
	INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs"

	// Parameter value is out of range.
	INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange"

	// Invalid `PageNumber`.
	INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber"

	// Invalid `PageSize`.
	INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize"

	// The value of `PageSize` exceeds 100.
	INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize"

	// The query period exceeds the limit.
	INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"

	// `RoomId` is incorrect.
	INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"

	// `SdkAppId` is incorrect.
	INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

	// The start time for query exceeded the limit.
	INVALIDPARAMETER_STARTTIMEEXPIRE = "InvalidParameter.StartTimeExpire"

	// The query start time exceeds the range allowed by the current dashboard edition. For details, see https://intl.cloud.tencent.com/document/product/647/81331?from_cn_redirect=1
	INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize"

	// Invalid `StartTs`.
	INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"

	// The start time for query exceeded the limit.
	INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"

	// StrRoomId parameter error.
	INVALIDPARAMETER_STRROOMID = "InvalidParameter.StrRoomId"

	// TaskId parameter error.
	INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"

	// Failed to parse URL parameters.
	INVALIDPARAMETER_URLPARAMSERROR = "InvalidParameter.UrlParamsError"

	// Invalid `UserId`.
	INVALIDPARAMETER_USERID = "InvalidParameter.UserId"

	// `UserIds` is incorrect.
	INVALIDPARAMETER_USERIDS = "InvalidParameter.UserIds"

	// The number of users exceeds 6.
	INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix"

	//
	INVALIDPARAMETER_USERSIG = "InvalidParameter.UserSig"

	// Invalid RoomId.
	INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"

	// Missing parameter.
	MISSINGPARAMETER = "MissingParameter"

	// `AccessKey` parameter missing.
	MISSINGPARAMETER_ACCESSKEY = "MissingParameter.AccessKey"

	// `AppId` missing.
	MISSINGPARAMETER_APPID = "MissingParameter.AppId"

	// `Bucket` parameter missing.
	MISSINGPARAMETER_BUCKET = "MissingParameter.Bucket"

	// `CloudStorage` parameter missing.
	MISSINGPARAMETER_CLOUDSTORAGE = "MissingParameter.CloudStorage"

	// `CommId` is missing.
	MISSINGPARAMETER_COMMID = "MissingParameter.CommId"

	// `SdkAppId` or `CommID` missing.
	MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId"

	// `endTS_s` is missing.
	MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"

	// `RecordMode` parameter missing.
	MISSINGPARAMETER_RECORDMODE = "MissingParameter.RecordMode"

	// `RecordParams` parameter missing.
	MISSINGPARAMETER_RECORDPARAMS = "MissingParameter.RecordParams"

	// `Region` parameter missing.
	MISSINGPARAMETER_REGION = "MissingParameter.Region"

	// `RoomId` is missing.
	MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"

	// `RoomNum` is missing.
	MISSINGPARAMETER_ROOMNUM = "MissingParameter.RoomNum"

	// `SdkAppId` is missing.
	MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"

	// `SecretKey` parameter missing.
	MISSINGPARAMETER_SECRETKEY = "MissingParameter.SecretKey"

	// `startTS_s` is missing.
	MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"

	// `StorageParams` parameter missing.
	MISSINGPARAMETER_STORAGEPARAMS = "MissingParameter.StorageParams"

	// `StreamType` parameter missing.
	MISSINGPARAMETER_STREAMTYPE = "MissingParameter.StreamType"

	// `TaskId` parameter missing.
	MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"

	// Missing `UserId` parameter.
	MISSINGPARAMETER_USERID = "MissingParameter.UserId"

	// `UserIds` is missing.
	MISSINGPARAMETER_USERIDS = "MissingParameter.UserIds"

	// `UserSig` parameter missing.
	MISSINGPARAMETER_USERSIG = "MissingParameter.UserSig"

	// `Vendor` parameter missing.
	MISSINGPARAMETER_VENDOR = "MissingParameter.Vendor"

	// Insufficient resources.
	RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection"

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

	// No permission to manipulate `SdkAppId`.
	UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

	// Unsupported operation.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
View Source 
const APIVersion = "2019-07-22"

Variables

This section is empty.

Functions

This section is empty.

Types

type AbnormalEvent 

type AbnormalEvent struct {
	// The error event ID. For details, see https://www.tencentcloud.com/document/product/647/37906?has_map=1
	AbnormalEventId *uint64 `json:"AbnormalEventId,omitnil,omitempty" name:"AbnormalEventId"`

	// The remote user ID. If this parameter is empty, it indicates that the error event is not associated with a remote user.
	// Note: This field may return null, indicating that no valid values can be obtained.
	PeerId *string `json:"PeerId,omitnil,omitempty" name:"PeerId"`
}

type AbnormalExperience 

type AbnormalExperience struct {
	// The user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The abnormal experience ID.
	ExperienceId *uint64 `json:"ExperienceId,omitnil,omitempty" name:"ExperienceId"`

	// The room ID (string).
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The possible error events.
	AbnormalEventList []*AbnormalEvent `json:"AbnormalEventList,omitnil,omitempty" name:"AbnormalEventList"`

	// The report time.
	EventTime *uint64 `json:"EventTime,omitnil,omitempty" name:"EventTime"`
}

type AgentParams 

type AgentParams struct {
	// The [user ID](https://intl.cloud.tencent.com/document/product/647/37714) of the relaying robot in the TRTC room, which cannot be the same as a user ID already in use. We recommend you include the room ID in this user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The signature (similar to a login password) required for the relaying robot to enter the room. For information on how to calculate the signature, see [What is UserSig?](https://intl.cloud.tencent.com/document/product/647/38104). |
	UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"`

	// The timeout period (seconds) for relaying to stop automatically after all the users whose streams are mixed leave the room. The value cannot be smaller than 5 or larger than 86400 (24 hours). Default value: 30.
	MaxIdleTime *uint64 `json:"MaxIdleTime,omitnil,omitempty" name:"MaxIdleTime"`
}

type AudioEncode 

type AudioEncode struct {
	// The audio sample rate (Hz). Valid values: 48000, 44100, 32000, 24000, 16000, 8000.
	SampleRate *uint64 `json:"SampleRate,omitnil,omitempty" name:"SampleRate"`

	// The number of sound channels. Valid values: 1 (mono), 2 (dual).
	Channel *uint64 `json:"Channel,omitnil,omitempty" name:"Channel"`

	// The audio bitrate (Kbps). Value range: 8-500.
	BitRate *uint64 `json:"BitRate,omitnil,omitempty" name:"BitRate"`

	// The audio codec. Valid values: 0 (LC-AAC), 1 (HE-AAC), 2 (HE-AACv2). The default value is 0. If this parameter is set to 2, `Channel` must be 2. If it is set to 1 or 2, `SampleRate` can only be 48000, 44100, 32000, 24000, or 16000.
	Codec *uint64 `json:"Codec,omitnil,omitempty" name:"Codec"`
}

type AudioEncodeParams 

type AudioEncodeParams struct {
	// Audio Sample rate, Value range [48000, 44100], unit is Hz.
	SampleRate *uint64 `json:"SampleRate,omitnil,omitempty" name:"SampleRate"`

	// Audio Channel number, Value range [1,2], 1 means Audio is Mono-channel, 2 means Audio is Dual-channel.
	Channel *uint64 `json:"Channel,omitnil,omitempty" name:"Channel"`

	// Audio Bitrate, Value range [8,500], unit is kbps.
	BitRate *uint64 `json:"BitRate,omitnil,omitempty" name:"BitRate"`
}

type AudioParams 

type AudioParams struct {
	// The audio sample rate.
	// 1: 48000 Hz (default)
	// 2: 44100 Hz
	// 3: 16000 Hz
	SampleRate *uint64 `json:"SampleRate,omitnil,omitempty" name:"SampleRate"`

	// The number of sound channels.
	// 1: Mono-channel
	// 2: Dual-channel (default)
	Channel *uint64 `json:"Channel,omitnil,omitempty" name:"Channel"`

	// The audio bitrate (bps). Value range: [32000, 128000]. Default: 64000.
	BitRate *uint64 `json:"BitRate,omitnil,omitempty" name:"BitRate"`
}

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

func (c *Client) CreateCloudRecording(request *CreateCloudRecordingRequest) (response *CreateCloudRecordingResponse, err error)

CreateCloudRecording API description:

This API is used to start an on-cloud recording task. It records the audio and video streams in a room and saves them to the specified cloud storage. You can use this API to record the streams in a room separately, or you can mix the streams first and then record the mixed stream.

You can use this API to perform the following operations:

* Specify the anchors whose streams you want or do not want to record by using the `RecordParams` parameter

* Specify the storage service you want to save recording files to by using the `StorageParams` parameter. Currently, you can save recording files to Tencent Cloud VOD or COS.

* Specify transcoding settings for mixed-stream recording, including video resolution, video bitrate, frame rate, and audio quality, by using `MixTranscodeParams`

* Specify the layout of different videos in mixed-stream recording mode or select an auto-arranged layout template

Key concepts:

* Single-stream recording: Record the audio and video of each subscribed user (`UserId`) in a room and save the recording files to the storage you specify.

Mixed-stream recording: Mix the audios and videos of subscribed users (`UserId`) in a room, record the mixed stream, and save the recording files to the storage you specify. After a recording task ends, you can go to the VOD console (https://console.tencentcloud.com/vod/media) or [COS console](https://console.cloud.tencent.com/cos/bucket) to view the recording files.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"
FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency"
INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError"
INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
MISSINGPARAMETER_ACCESSKEY = "MissingParameter.AccessKey"
MISSINGPARAMETER_BUCKET = "MissingParameter.Bucket"
MISSINGPARAMETER_CLOUDSTORAGE = "MissingParameter.CloudStorage"
MISSINGPARAMETER_RECORDMODE = "MissingParameter.RecordMode"
MISSINGPARAMETER_RECORDPARAMS = "MissingParameter.RecordParams"
MISSINGPARAMETER_REGION = "MissingParameter.Region"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_SECRETKEY = "MissingParameter.SecretKey"
MISSINGPARAMETER_STORAGEPARAMS = "MissingParameter.StorageParams"
MISSINGPARAMETER_STREAMTYPE = "MissingParameter.StreamType"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
MISSINGPARAMETER_USERID = "MissingParameter.UserId"
MISSINGPARAMETER_USERSIG = "MissingParameter.UserSig"
MISSINGPARAMETER_VENDOR = "MissingParameter.Vendor"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateCloudRecordingWithContext 

func (c *Client) CreateCloudRecordingWithContext(ctx context.Context, request *CreateCloudRecordingRequest) (response *CreateCloudRecordingResponse, err error)

CreateCloudRecording API description:

This API is used to start an on-cloud recording task. It records the audio and video streams in a room and saves them to the specified cloud storage. You can use this API to record the streams in a room separately, or you can mix the streams first and then record the mixed stream.

You can use this API to perform the following operations:

* Specify the anchors whose streams you want or do not want to record by using the `RecordParams` parameter

* Specify the storage service you want to save recording files to by using the `StorageParams` parameter. Currently, you can save recording files to Tencent Cloud VOD or COS.

* Specify transcoding settings for mixed-stream recording, including video resolution, video bitrate, frame rate, and audio quality, by using `MixTranscodeParams`

* Specify the layout of different videos in mixed-stream recording mode or select an auto-arranged layout template

Key concepts:

* Single-stream recording: Record the audio and video of each subscribed user (`UserId`) in a room and save the recording files to the storage you specify.

Mixed-stream recording: Mix the audios and videos of subscribed users (`UserId`) in a room, record the mixed stream, and save the recording files to the storage you specify. After a recording task ends, you can go to the VOD console (https://console.tencentcloud.com/vod/media) or [COS console](https://console.cloud.tencent.com/cos/bucket) to view the recording files.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"
FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency"
INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError"
INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
MISSINGPARAMETER_ACCESSKEY = "MissingParameter.AccessKey"
MISSINGPARAMETER_BUCKET = "MissingParameter.Bucket"
MISSINGPARAMETER_CLOUDSTORAGE = "MissingParameter.CloudStorage"
MISSINGPARAMETER_RECORDMODE = "MissingParameter.RecordMode"
MISSINGPARAMETER_RECORDPARAMS = "MissingParameter.RecordParams"
MISSINGPARAMETER_REGION = "MissingParameter.Region"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_SECRETKEY = "MissingParameter.SecretKey"
MISSINGPARAMETER_STORAGEPARAMS = "MissingParameter.StorageParams"
MISSINGPARAMETER_STREAMTYPE = "MissingParameter.StreamType"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
MISSINGPARAMETER_USERID = "MissingParameter.UserId"
MISSINGPARAMETER_USERSIG = "MissingParameter.UserSig"
MISSINGPARAMETER_VENDOR = "MissingParameter.Vendor"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteCloudRecording 

func (c *Client) DeleteCloudRecording(request *DeleteCloudRecordingRequest) (response *DeleteCloudRecordingResponse, err error)

DeleteCloudRecording This API is used to stop a recording task. If a task is stopped successfully, but the uploading of recording files has not completed, the backend will continue to upload the files and will notify you via a callback when the upload is completed.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"
INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError"
INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
MISSINGPARAMETER_USERID = "MissingParameter.UserId"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DeleteCloudRecordingWithContext 

func (c *Client) DeleteCloudRecordingWithContext(ctx context.Context, request *DeleteCloudRecordingRequest) (response *DeleteCloudRecordingResponse, err error)

DeleteCloudRecording This API is used to stop a recording task. If a task is stopped successfully, but the uploading of recording files has not completed, the backend will continue to upload the files and will notify you via a callback when the upload is completed.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"
INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError"
INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
MISSINGPARAMETER_USERID = "MissingParameter.UserId"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeCallDetailInfo 

func (c *Client) DescribeCallDetailInfo(request *DescribeCallDetailInfoRequest) (response *DescribeCallDetailInfoResponse, err error)

DescribeCallDetailInfo This API (the old `DescribeCallDetail`) is used to query the user list and call quality data of a specified time range in the last 14 days. If `DataType` is not null, the data of up to six users during a period of up to one hour can be queried (the period can start and end on different days). If `DataType` is null, the data of up to 100 users can be returned per page (the value of `PageSize` cannot exceed 100). Six users are queried by default. The period queried cannot exceed four hours. This API is used to query call quality and is not recommended for billing purposes.

**Note**:

1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.

2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://www.tencentcloud.com/document/product/647/54481.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError"
INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"
INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"
INTERNALERROR_METHODERR = "InternalError.MethodErr"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams"
INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber"
INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize"
INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize"
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize"
INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"
INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"
INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_COMMID = "MissingParameter.CommId"
MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId"
MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"

func (*Client) DescribeCallDetailInfoWithContext 

func (c *Client) DescribeCallDetailInfoWithContext(ctx context.Context, request *DescribeCallDetailInfoRequest) (response *DescribeCallDetailInfoResponse, err error)

DescribeCallDetailInfo This API (the old `DescribeCallDetail`) is used to query the user list and call quality data of a specified time range in the last 14 days. If `DataType` is not null, the data of up to six users during a period of up to one hour can be queried (the period can start and end on different days). If `DataType` is null, the data of up to 100 users can be returned per page (the value of `PageSize` cannot exceed 100). Six users are queried by default. The period queried cannot exceed four hours. This API is used to query call quality and is not recommended for billing purposes.

**Note**:

1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.

2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://www.tencentcloud.com/document/product/647/54481.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError"
INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"
INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"
INTERNALERROR_METHODERR = "InternalError.MethodErr"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams"
INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber"
INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize"
INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize"
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize"
INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"
INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"
INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_COMMID = "MissingParameter.CommId"
MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId"
MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"

func (*Client) DescribeCloudRecording 

func (c *Client) DescribeCloudRecording(request *DescribeCloudRecordingRequest) (response *DescribeCloudRecordingResponse, err error)

DescribeCloudRecording This API is used to query the status of a recording task after it starts. It works only when a task is in progress. If the task has already ended when this API is called, an error will be returned.

If a recording file is being uploaded to VOD, the response parameter `StorageFileList` will not contain the information of the recording file. Please listen for the recording file callback to get the information.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"
INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError"
INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
MISSINGPARAMETER_USERID = "MissingParameter.UserId"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeCloudRecordingWithContext 

func (c *Client) DescribeCloudRecordingWithContext(ctx context.Context, request *DescribeCloudRecordingRequest) (response *DescribeCloudRecordingResponse, err error)

DescribeCloudRecording This API is used to query the status of a recording task after it starts. It works only when a task is in progress. If the task has already ended when this API is called, an error will be returned.

If a recording file is being uploaded to VOD, the response parameter `StorageFileList` will not contain the information of the recording file. Please listen for the recording file callback to get the information.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"
INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError"
INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
MISSINGPARAMETER_USERID = "MissingParameter.UserId"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeMixTranscodingUsage 

func (c *Client) DescribeMixTranscodingUsage(request *DescribeMixTranscodingUsageRequest) (response *DescribeMixTranscodingUsageResponse, err error)

DescribeMixTranscodingUsage This API is used to query your usage of TRTC’s On-Cloud MixTranscoding service.

- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.

- The period queried per request cannot be longer than 31 days.

- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.

- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.

- The rate limit of this API is five calls per second.

error code that may be returned: 

INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeMixTranscodingUsageWithContext 

func (c *Client) DescribeMixTranscodingUsageWithContext(ctx context.Context, request *DescribeMixTranscodingUsageRequest) (response *DescribeMixTranscodingUsageResponse, err error)

DescribeMixTranscodingUsage This API is used to query your usage of TRTC’s On-Cloud MixTranscoding service.

- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.

- The period queried per request cannot be longer than 31 days.

- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.

- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.

- The rate limit of this API is five calls per second.

error code that may be returned: 

INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeRecordingUsage 

func (c *Client) DescribeRecordingUsage(request *DescribeRecordingUsageRequest) (response *DescribeRecordingUsageResponse, err error)

DescribeRecordingUsage This API is used to query your TRTC recording usage.

- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.

- The period queried per request cannot be longer than 31 days.

- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.

- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.

- The rate limit of this API is five calls per second.

error code that may be returned: 

INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeRecordingUsageWithContext 

func (c *Client) DescribeRecordingUsageWithContext(ctx context.Context, request *DescribeRecordingUsageRequest) (response *DescribeRecordingUsageResponse, err error)

DescribeRecordingUsage This API is used to query your TRTC recording usage.

- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.

- The period queried per request cannot be longer than 31 days.

- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.

- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.

- The rate limit of this API is five calls per second.

error code that may be returned: 

INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeRelayUsage 

func (c *Client) DescribeRelayUsage(request *DescribeRelayUsageRequest) (response *DescribeRelayUsageResponse, err error)

DescribeRelayUsage This API is used to query your usage of TRTC’s relay to CDN service.

- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.

- The period queried per request cannot be longer than 31 days.

- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.

- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.

- The rate limit of this API is five calls per second.

error code that may be returned: 

INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeRelayUsageWithContext 

func (c *Client) DescribeRelayUsageWithContext(ctx context.Context, request *DescribeRelayUsageRequest) (response *DescribeRelayUsageResponse, err error)

DescribeRelayUsage This API is used to query your usage of TRTC’s relay to CDN service.

- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.

- The period queried per request cannot be longer than 31 days.

- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.

- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.

- The rate limit of this API is five calls per second.

error code that may be returned: 

INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeRoomInfo 

func (c *Client) DescribeRoomInfo(request *DescribeRoomInfoRequest) (response *DescribeRoomInfoResponse, err error)

DescribeRoomInfo This API (the old `DescribeRoomInformation`) is used to query the rooms of an application (`SDKAppID`) in the last 14 days. Up to 100 records can be returned per call (10 are returned by default).

**Note**:

1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.

2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://trtc.io/document/54481

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError"
INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"
INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"
INTERNALERROR_METHODERR = "InternalError.MethodErr"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs"
INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber"
INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize"
INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize"
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize"
INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"
INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"
INVALIDPARAMETER_URLPARAMSERROR = "InvalidParameter.UrlParamsError"
INVALIDPARAMETER_USERID = "InvalidParameter.UserId"
MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId"
MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"
MISSINGPARAMETER_ROOMNUM = "MissingParameter.RoomNum"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"

func (*Client) DescribeRoomInfoWithContext 

func (c *Client) DescribeRoomInfoWithContext(ctx context.Context, request *DescribeRoomInfoRequest) (response *DescribeRoomInfoResponse, err error)

DescribeRoomInfo This API (the old `DescribeRoomInformation`) is used to query the rooms of an application (`SDKAppID`) in the last 14 days. Up to 100 records can be returned per call (10 are returned by default).

**Note**:

1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.

2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://trtc.io/document/54481

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError"
INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"
INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"
INTERNALERROR_METHODERR = "InternalError.MethodErr"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs"
INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber"
INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize"
INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize"
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize"
INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"
INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"
INVALIDPARAMETER_URLPARAMSERROR = "InvalidParameter.UrlParamsError"
INVALIDPARAMETER_USERID = "InvalidParameter.UserId"
MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId"
MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"
MISSINGPARAMETER_ROOMNUM = "MissingParameter.RoomNum"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"

func (*Client) DescribeScaleInfo 

func (c *Client) DescribeScaleInfo(request *DescribeScaleInfoRequest) (response *DescribeScaleInfoResponse, err error)

DescribeScaleInfo This API (the old `DescribeHistoryScale`) is used to query the daily number of rooms and users of an application (`SDKAppID`) in the last 14 days. Data for the current day cannot be queried.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"
INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"
INTERNALERROR_METHODERR = "InternalError.MethodErr"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"
INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"
INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix"
MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"

func (*Client) DescribeScaleInfoWithContext 

func (c *Client) DescribeScaleInfoWithContext(ctx context.Context, request *DescribeScaleInfoRequest) (response *DescribeScaleInfoResponse, err error)

DescribeScaleInfo This API (the old `DescribeHistoryScale`) is used to query the daily number of rooms and users of an application (`SDKAppID`) in the last 14 days. Data for the current day cannot be queried.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"
INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"
INTERNALERROR_METHODERR = "InternalError.MethodErr"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"
INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"
INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix"
MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"

func (*Client) DescribeStreamIngest 

func (c *Client) DescribeStreamIngest(request *DescribeStreamIngestRequest) (response *DescribeStreamIngestResponse, err error)

DescribeStreamIngest You can query the status of the Relay task.

error code that may be returned: 

FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"

func (*Client) DescribeStreamIngestWithContext 

func (c *Client) DescribeStreamIngestWithContext(ctx context.Context, request *DescribeStreamIngestRequest) (response *DescribeStreamIngestResponse, err error)

DescribeStreamIngest You can query the status of the Relay task.

error code that may be returned: 

FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"

func (*Client) DescribeTRTCMarketQualityData 

func (c *Client) DescribeTRTCMarketQualityData(request *DescribeTRTCMarketQualityDataRequest) (response *DescribeTRTCMarketQualityDataResponse, err error)

DescribeTRTCMarketQualityData Query TRTC Monitoring Dashboard - Data Dashboard Quality Metrics (including the following metrics)

joinSuccessRate: Join channel success rate.

joinSuccessIn5sRate: Join channel success rate within 5s.

audioFreezeRate: Audio stutter rate.

videoFreezeRate: Video stutter rate.

networkDelay: Lag rate.

Note:

1. To call the API, you need to activate the monitoring dashboard Standard Edition and Premium Edition, the monitoring dashboard Free Edition does not support calling. Monitoring dashboard version features and billing overview: https://trtc.io/document/54481.

2. The query time range depends on the monitoring dashboard function version, premium edition can query the last 30 days.

error code that may be returned: 

FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"

func (*Client) DescribeTRTCMarketQualityDataWithContext 

func (c *Client) DescribeTRTCMarketQualityDataWithContext(ctx context.Context, request *DescribeTRTCMarketQualityDataRequest) (response *DescribeTRTCMarketQualityDataResponse, err error)

DescribeTRTCMarketQualityData Query TRTC Monitoring Dashboard - Data Dashboard Quality Metrics (including the following metrics)

joinSuccessRate: Join channel success rate.

joinSuccessIn5sRate: Join channel success rate within 5s.

audioFreezeRate: Audio stutter rate.

videoFreezeRate: Video stutter rate.

networkDelay: Lag rate.

Note:

1. To call the API, you need to activate the monitoring dashboard Standard Edition and Premium Edition, the monitoring dashboard Free Edition does not support calling. Monitoring dashboard version features and billing overview: https://trtc.io/document/54481.

2. The query time range depends on the monitoring dashboard function version, premium edition can query the last 30 days.

error code that may be returned: 

FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"

func (*Client) DescribeTRTCMarketScaleData 

func (c *Client) DescribeTRTCMarketScaleData(request *DescribeTRTCMarketScaleDataRequest) (response *DescribeTRTCMarketScaleDataResponse, err error)

DescribeTRTCMarketScaleData Query TRTC Monitoring Dashboard - Data Dashboard Scale Metrics (will return userCount, roomCount, peakCurrentUsers, peakCurrentChannels)

- userCount: number of users in the call,

- roomCount: number of rooms in the call, counted as one call channel from the time a user joins the channel to the time all users leave the channel.

- peakCurrentChannels: peak number of channels online at the same time.

- peakCurrentUsers: peak number of users online at the same time.

Note:

1. To call the interface, you need to activate the monitoring dashboard Standard Edition and Premium Edition, the monitoring dashboard Free Edition does not support calling, for monitoring dashboard version features and billing overview: https://trtc.io/document/54481.

2. The query time range depends on the monitoring dashboard function version, premium edition can query up to 60 days.

error code that may be returned: 

FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"

func (*Client) DescribeTRTCMarketScaleDataWithContext 

func (c *Client) DescribeTRTCMarketScaleDataWithContext(ctx context.Context, request *DescribeTRTCMarketScaleDataRequest) (response *DescribeTRTCMarketScaleDataResponse, err error)

DescribeTRTCMarketScaleData Query TRTC Monitoring Dashboard - Data Dashboard Scale Metrics (will return userCount, roomCount, peakCurrentUsers, peakCurrentChannels)

- userCount: number of users in the call,

- roomCount: number of rooms in the call, counted as one call channel from the time a user joins the channel to the time all users leave the channel.

- peakCurrentChannels: peak number of channels online at the same time.

- peakCurrentUsers: peak number of users online at the same time.

Note:

1. To call the interface, you need to activate the monitoring dashboard Standard Edition and Premium Edition, the monitoring dashboard Free Edition does not support calling, for monitoring dashboard version features and billing overview: https://trtc.io/document/54481.

2. The query time range depends on the monitoring dashboard function version, premium edition can query up to 60 days.

error code that may be returned: 

FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"

func (*Client) DescribeTRTCRealTimeQualityData 

func (c *Client) DescribeTRTCRealTimeQualityData(request *DescribeTRTCRealTimeQualityDataRequest) (response *DescribeTRTCRealTimeQualityDataResponse, err error)

DescribeTRTCRealTimeQualityData Query TRTC Monitoring Dashboard - Real-Time Monitoring Quality Metrics (return the following metrics) 

-Video stutter rate

-Audio stutter rate

Note:

1. To call the API, you need to activate the Monitoring Dashboard Standard Edition and Premium Edition. The Monitoring Dashboard Free Edition does not support calling. For monitoring dashboard version features and billing overview, please visit: https://trtc.io/document/54481.

2. The query time range depends on the monitoring dashboard function version. The premium edition can query up to 1 hours

error code that may be returned: 

FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"

func (*Client) DescribeTRTCRealTimeQualityDataWithContext 

func (c *Client) DescribeTRTCRealTimeQualityDataWithContext(ctx context.Context, request *DescribeTRTCRealTimeQualityDataRequest) (response *DescribeTRTCRealTimeQualityDataResponse, err error)

DescribeTRTCRealTimeQualityData Query TRTC Monitoring Dashboard - Real-Time Monitoring Quality Metrics (return the following metrics) 

-Video stutter rate

-Audio stutter rate

Note:

1. To call the API, you need to activate the Monitoring Dashboard Standard Edition and Premium Edition. The Monitoring Dashboard Free Edition does not support calling. For monitoring dashboard version features and billing overview, please visit: https://trtc.io/document/54481.

2. The query time range depends on the monitoring dashboard function version. The premium edition can query up to 1 hours

error code that may be returned: 

FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"

func (*Client) DescribeTRTCRealTimeScaleData 

func (c *Client) DescribeTRTCRealTimeScaleData(request *DescribeTRTCRealTimeScaleDataRequest) (response *DescribeTRTCRealTimeScaleDataResponse, err error)

DescribeTRTCRealTimeScaleData Query TRTC Monitoring Dashboard - Real-Time Monitoring Scale Metrics (the following metrics will be returned) -userCount (Online users) -roomCount (Online rooms) Note: 1. To call the interface, you need to activate the monitoring dashboard Standard Edition and Premium Edition, the monitoring dashboard Free Edition does not support calling. For monitoring dashboard version features and billing overview, please visit: https://trtc.io/document/54481. 2. The query time range depends on the function version of the monitoring dashboard. The premium edition can query the last 1 hours

error code that may be returned: 

UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeTRTCRealTimeScaleDataWithContext 

func (c *Client) DescribeTRTCRealTimeScaleDataWithContext(ctx context.Context, request *DescribeTRTCRealTimeScaleDataRequest) (response *DescribeTRTCRealTimeScaleDataResponse, err error)

DescribeTRTCRealTimeScaleData Query TRTC Monitoring Dashboard - Real-Time Monitoring Scale Metrics (the following metrics will be returned) -userCount (Online users) -roomCount (Online rooms) Note: 1. To call the interface, you need to activate the monitoring dashboard Standard Edition and Premium Edition, the monitoring dashboard Free Edition does not support calling. For monitoring dashboard version features and billing overview, please visit: https://trtc.io/document/54481. 2. The query time range depends on the function version of the monitoring dashboard. The premium edition can query the last 1 hours

error code that may be returned: 

UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeTrtcRoomUsage 

func (c *Client) DescribeTrtcRoomUsage(request *DescribeTrtcRoomUsageRequest) (response *DescribeTrtcRoomUsageResponse, err error)

DescribeTrtcRoomUsage This API is used to query usage data grouped by room.

- The queried period cannot exceed 24 hours. If the period spans two different days, the data returned may not be accurate due to a delay in data collection. You can make multiple calls to query the usage on different days.

- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.

- The rate limit of this API is one call every 15 seconds.

error code that may be returned: 

FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) DescribeTrtcRoomUsageWithContext 

func (c *Client) DescribeTrtcRoomUsageWithContext(ctx context.Context, request *DescribeTrtcRoomUsageRequest) (response *DescribeTrtcRoomUsageResponse, err error)

DescribeTrtcRoomUsage This API is used to query usage data grouped by room.

- The queried period cannot exceed 24 hours. If the period spans two different days, the data returned may not be accurate due to a delay in data collection. You can make multiple calls to query the usage on different days.

- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.

- The rate limit of this API is one call every 15 seconds.

error code that may be returned: 

FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) DescribeTrtcUsage 

func (c *Client) DescribeTrtcUsage(request *DescribeTrtcUsageRequest) (response *DescribeTrtcUsageResponse, err error)

DescribeTrtcUsage This API is used to query your TRTC audio/video duration.

- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.

- The period queried per request cannot be longer than 31 days.

- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.

- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.

- The rate limit of this API is five calls per second.

error code that may be returned: 

INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeTrtcUsageWithContext 

func (c *Client) DescribeTrtcUsageWithContext(ctx context.Context, request *DescribeTrtcUsageRequest) (response *DescribeTrtcUsageResponse, err error)

DescribeTrtcUsage This API is used to query your TRTC audio/video duration.

- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.

- The period queried per request cannot be longer than 31 days.

- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.

- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.

- The rate limit of this API is five calls per second.

error code that may be returned: 

INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeUnusualEvent 

func (c *Client) DescribeUnusualEvent(request *DescribeUnusualEventRequest) (response *DescribeUnusualEventResponse, err error)

DescribeUnusualEvent This API (the old `DescribeAbnormalEvent`) is used to query up to 20 random abnormal user experiences of an application (`SDKAppID`) in the last 14 days. The start and end time can be on two different days, but they cannot be more than one hour apart.

For details about the error events, see https://intl.cloud.tencent.com/document/product/647/44916?from_cn_redirect=1

**Note**:

1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.

2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://www.tencentcloud.com/document/product/647/54481.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError"
INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"
INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"
INTERNALERROR_METHODERR = "InternalError.MethodErr"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams"
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIMEEXPIRE = "InvalidParameter.StartTimeExpire"
INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"
INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"

func (*Client) DescribeUnusualEventWithContext 

func (c *Client) DescribeUnusualEventWithContext(ctx context.Context, request *DescribeUnusualEventRequest) (response *DescribeUnusualEventResponse, err error)

DescribeUnusualEvent This API (the old `DescribeAbnormalEvent`) is used to query up to 20 random abnormal user experiences of an application (`SDKAppID`) in the last 14 days. The start and end time can be on two different days, but they cannot be more than one hour apart.

For details about the error events, see https://intl.cloud.tencent.com/document/product/647/44916?from_cn_redirect=1

**Note**:

1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.

2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://www.tencentcloud.com/document/product/647/54481.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError"
INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"
INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"
INTERNALERROR_METHODERR = "InternalError.MethodErr"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams"
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIMEEXPIRE = "InvalidParameter.StartTimeExpire"
INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"
INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"

func (*Client) DescribeUserEvent 

func (c *Client) DescribeUserEvent(request *DescribeUserEventRequest) (response *DescribeUserEventResponse, err error)

DescribeUserEvent This API (the old `DescribeDetailEvent`) is used to query the events of a call in the last 14 days, including user entry and exit, turning the camera on/off, etc.

**Note**:

1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.

2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://www.tencentcloud.com/document/product/647/54481.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError"
INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"
INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"
INTERNALERROR_METHODERR = "InternalError.MethodErr"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs"
INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"
INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"
INVALIDPARAMETER_URLPARAMSERROR = "InvalidParameter.UrlParamsError"
INVALIDPARAMETER_USERID = "InvalidParameter.UserId"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_APPID = "MissingParameter.AppId"
MISSINGPARAMETER_COMMID = "MissingParameter.CommId"
MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId"
MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"
MISSINGPARAMETER_USERID = "MissingParameter.UserId"

func (*Client) DescribeUserEventWithContext 

func (c *Client) DescribeUserEventWithContext(ctx context.Context, request *DescribeUserEventRequest) (response *DescribeUserEventResponse, err error)

DescribeUserEvent This API (the old `DescribeDetailEvent`) is used to query the events of a call in the last 14 days, including user entry and exit, turning the camera on/off, etc.

**Note**:

1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.

2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://www.tencentcloud.com/document/product/647/54481.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError"
INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"
INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"
INTERNALERROR_METHODERR = "InternalError.MethodErr"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs"
INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"
INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"
INVALIDPARAMETER_URLPARAMSERROR = "InvalidParameter.UrlParamsError"
INVALIDPARAMETER_USERID = "InvalidParameter.UserId"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_APPID = "MissingParameter.AppId"
MISSINGPARAMETER_COMMID = "MissingParameter.CommId"
MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId"
MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"
MISSINGPARAMETER_USERID = "MissingParameter.UserId"

func (*Client) DescribeUserInfo 

func (c *Client) DescribeUserInfo(request *DescribeUserInfoRequest) (response *DescribeUserInfoResponse, err error)

DescribeUserInfo This API (the old `DescribeUserInformation`) is used to query the user list of a specified time range (up to four hours) in the last 14 days. The data of up to 100 users can be returned per page (six are returned by default).

**Note**:

1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.

2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://www.tencentcloud.com/document/product/647/54481.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"
INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"
INTERNALERROR_METHODERR = "InternalError.MethodErr"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams"
INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber"
INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize"
INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize"
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize"
INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"
INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"
INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_COMMID = "MissingParameter.CommId"
MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId"
MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"

func (*Client) DescribeUserInfoWithContext 

func (c *Client) DescribeUserInfoWithContext(ctx context.Context, request *DescribeUserInfoRequest) (response *DescribeUserInfoResponse, err error)

DescribeUserInfo This API (the old `DescribeUserInformation`) is used to query the user list of a specified time range (up to four hours) in the last 14 days. The data of up to 100 users can be returned per page (six are returned by default).

**Note**:

1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.

2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://www.tencentcloud.com/document/product/647/54481.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"
INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"
INTERNALERROR_METHODERR = "InternalError.MethodErr"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams"
INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber"
INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize"
INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize"
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize"
INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"
INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"
INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_COMMID = "MissingParameter.CommId"
MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId"
MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"

func (*Client) DismissRoom 

func (c *Client) DismissRoom(request *DismissRoomRequest) (response *DismissRoomResponse, err error)

DismissRoom This API is used to remove all users from a room and dismiss the room. It supports all platforms. For Android, iOS, Windows, and macOS, the TRTC SDK needs to be upgraded to v6.6 or above.

error code that may be returned: 

FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_GETROOMCACHEIPERROR = "InternalError.GetRoomCacheIpError"
INTERNALERROR_GETROOMFROMCACHEERROR = "InternalError.GetRoomFromCacheError"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DismissRoomByStrRoomId 

func (c *Client) DismissRoomByStrRoomId(request *DismissRoomByStrRoomIdRequest) (response *DismissRoomByStrRoomIdResponse, err error)

DismissRoomByStrRoomId This API is used to remove all users from a room and close the room. It works on all platforms. For Android, iOS, Windows, and macOS, you need to update the TRTC SDK to version 6.6 or above.

error code that may be returned: 

FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_GETROOMCACHEIPERROR = "InternalError.GetRoomCacheIpError"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DismissRoomByStrRoomIdWithContext 

func (c *Client) DismissRoomByStrRoomIdWithContext(ctx context.Context, request *DismissRoomByStrRoomIdRequest) (response *DismissRoomByStrRoomIdResponse, err error)

DismissRoomByStrRoomId This API is used to remove all users from a room and close the room. It works on all platforms. For Android, iOS, Windows, and macOS, you need to update the TRTC SDK to version 6.6 or above.

error code that may be returned: 

FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_GETROOMCACHEIPERROR = "InternalError.GetRoomCacheIpError"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DismissRoomWithContext 

func (c *Client) DismissRoomWithContext(ctx context.Context, request *DismissRoomRequest) (response *DismissRoomResponse, err error)

DismissRoom This API is used to remove all users from a room and dismiss the room. It supports all platforms. For Android, iOS, Windows, and macOS, the TRTC SDK needs to be upgraded to v6.6 or above.

error code that may be returned: 

FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_GETROOMCACHEIPERROR = "InternalError.GetRoomCacheIpError"
INTERNALERROR_GETROOMFROMCACHEERROR = "InternalError.GetRoomFromCacheError"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) ModifyCloudRecording 

func (c *Client) ModifyCloudRecording(request *ModifyCloudRecordingRequest) (response *ModifyCloudRecordingResponse, err error)

ModifyCloudRecording This API is used to modify a recording task. It works only when a task is in progress. If the task has already ended when this API is called, an error will be returned. You need to specify all the parameters for each request instead of just the ones you want to modify.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"
INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError"
INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
MISSINGPARAMETER_USERID = "MissingParameter.UserId"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) ModifyCloudRecordingWithContext 

func (c *Client) ModifyCloudRecordingWithContext(ctx context.Context, request *ModifyCloudRecordingRequest) (response *ModifyCloudRecordingResponse, err error)

ModifyCloudRecording This API is used to modify a recording task. It works only when a task is in progress. If the task has already ended when this API is called, an error will be returned. You need to specify all the parameters for each request instead of just the ones you want to modify.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"
INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError"
INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
MISSINGPARAMETER_USERID = "MissingParameter.UserId"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) RemoveUser 

func (c *Client) RemoveUser(request *RemoveUserRequest) (response *RemoveUserResponse, err error)

RemoveUser This API is used to remove a user from a room. It is applicable to scenarios where the anchor, room owner, or admin wants to kick out a user. It supports all platforms. For Android, iOS, Windows, and macOS, the TRTC SDK needs to be upgraded to v6.6 or above.

error code that may be returned: 

FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_GETROOMCACHEIPERROR = "InternalError.GetRoomCacheIpError"
INTERNALERROR_GETROOMFROMCACHEERROR = "InternalError.GetRoomFromCacheError"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_USERIDS = "InvalidParameter.UserIds"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_USERIDS = "MissingParameter.UserIds"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) RemoveUserByStrRoomId 

func (c *Client) RemoveUserByStrRoomId(request *RemoveUserByStrRoomIdRequest) (response *RemoveUserByStrRoomIdResponse, err error)

RemoveUserByStrRoomId This API is used to remove a user from a room. It allows the anchor, room owner, or admin to kick out a user, and works on all platforms. For Android, iOS, Windows, and macOS, you need to update the TRTC SDK to version 6.6 or above.

error code that may be returned: 

FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_GETROOMCACHEIPERROR = "InternalError.GetRoomCacheIpError"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_USERIDS = "InvalidParameter.UserIds"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_USERIDS = "MissingParameter.UserIds"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) RemoveUserByStrRoomIdWithContext 

func (c *Client) RemoveUserByStrRoomIdWithContext(ctx context.Context, request *RemoveUserByStrRoomIdRequest) (response *RemoveUserByStrRoomIdResponse, err error)

RemoveUserByStrRoomId This API is used to remove a user from a room. It allows the anchor, room owner, or admin to kick out a user, and works on all platforms. For Android, iOS, Windows, and macOS, you need to update the TRTC SDK to version 6.6 or above.

error code that may be returned: 

FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_GETROOMCACHEIPERROR = "InternalError.GetRoomCacheIpError"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_USERIDS = "InvalidParameter.UserIds"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_USERIDS = "MissingParameter.UserIds"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) RemoveUserWithContext 

func (c *Client) RemoveUserWithContext(ctx context.Context, request *RemoveUserRequest) (response *RemoveUserResponse, err error)

RemoveUser This API is used to remove a user from a room. It is applicable to scenarios where the anchor, room owner, or admin wants to kick out a user. It supports all platforms. For Android, iOS, Windows, and macOS, the TRTC SDK needs to be upgraded to v6.6 or above.

error code that may be returned: 

FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_GETROOMCACHEIPERROR = "InternalError.GetRoomCacheIpError"
INTERNALERROR_GETROOMFROMCACHEERROR = "InternalError.GetRoomFromCacheError"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_USERIDS = "InvalidParameter.UserIds"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_USERIDS = "MissingParameter.UserIds"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetUserBlocked 

func (c *Client) SetUserBlocked(request *SetUserBlockedRequest) (response *SetUserBlockedResponse, err error)

SetUserBlocked This API is used to disable or enable the audio and video of a user. It can be used by an anchor, room owner, or admin to block or unblock a user. It supports platforms including Android, iOS, Windows, macOS, web, and WeChat Mini Program. Use this API if the room ID is a number.

error code that may be returned: 

FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist"
FAILEDOPERATION_USERNOTEXIST = "FailedOperation.UserNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_USERNOTEXIST = "InternalError.UserNotExist"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_USERID = "InvalidParameter.UserId"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetUserBlockedByStrRoomId 

func (c *Client) SetUserBlockedByStrRoomId(request *SetUserBlockedByStrRoomIdRequest) (response *SetUserBlockedByStrRoomIdResponse, err error)

SetUserBlockedByStrRoomId This API allows an anchor, room owner, admin to mute/unmute a user. It can be used on platforms including Android, iOS, Windows, macOS, web, and WeChat Mini Program. Use this API when the room ID is a string.

error code that may be returned: 

FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist"
FAILEDOPERATION_USERNOTEXIST = "FailedOperation.UserNotExist"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_USERID = "InvalidParameter.UserId"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_APPID = "MissingParameter.AppId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_USERID = "MissingParameter.UserId"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetUserBlockedByStrRoomIdWithContext 

func (c *Client) SetUserBlockedByStrRoomIdWithContext(ctx context.Context, request *SetUserBlockedByStrRoomIdRequest) (response *SetUserBlockedByStrRoomIdResponse, err error)

SetUserBlockedByStrRoomId This API allows an anchor, room owner, admin to mute/unmute a user. It can be used on platforms including Android, iOS, Windows, macOS, web, and WeChat Mini Program. Use this API when the room ID is a string.

error code that may be returned: 

FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist"
FAILEDOPERATION_USERNOTEXIST = "FailedOperation.UserNotExist"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_USERID = "InvalidParameter.UserId"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_APPID = "MissingParameter.AppId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_USERID = "MissingParameter.UserId"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetUserBlockedWithContext 

func (c *Client) SetUserBlockedWithContext(ctx context.Context, request *SetUserBlockedRequest) (response *SetUserBlockedResponse, err error)

SetUserBlocked This API is used to disable or enable the audio and video of a user. It can be used by an anchor, room owner, or admin to block or unblock a user. It supports platforms including Android, iOS, Windows, macOS, web, and WeChat Mini Program. Use this API if the room ID is a number.

error code that may be returned: 

FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist"
FAILEDOPERATION_USERNOTEXIST = "FailedOperation.UserNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_USERNOTEXIST = "InternalError.UserNotExist"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_USERID = "InvalidParameter.UserId"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) StartPublishCdnStream 

func (c *Client) StartPublishCdnStream(request *StartPublishCdnStreamRequest) (response *StartPublishCdnStreamResponse, err error)

StartPublishCdnStream In a TRTC room, there may be multiple audio and video streams concurrently active. You can use the MixTranscoding API to notify Tencent Cloud server to mix multiple video screens from the same room or multiple rooms together, and specify the position of each screen, while mixing multiple audio streams together. The final result is a single audio and video stream, which can be used for recording and live viewing. It also supports pushing this mixed audio and video stream back to the TRTC room.

The Cloud API MixTranscoding feature includes three interfaces:

1. StartPublishCdnStream: Start a MixTranscoding task. This interface will initiate a new MixTranscoding task. After the task is successfully started, a unique TaskId will be returned under the sdkappid dimension. You need to save this TaskId, as it will be required for updating and stopping the task later.

2. UpdatePublishCdnStream: Update the specified MixTranscoding task, including updating the video screen layout, updating the mixing list, updating the list of CDN addresses to be relayed, and updating the list of rooms to be pushed back.

3. StopPublishCdnStream: Stop the specified MixTranscoding task.

You can achieve the following goals through this set of interfaces:

1. Set the final video and audio quality, including video resolution, video frame rate, video bitrate, and audio quality.

2. Set the layout position of each screen. You only need to set it once. When you specify the MixTranscoding user to enter the room and send audio and video, the layout engine will automatically mix the user's screen to the specified layout position. You can also use the update interface to adjust the layout position.

3. Set multiple CDN relay target addresses. A single relay task can support up to 10 CDN relay addresses at the same time.

4. Set multiple room pushback lists. A single relay task can support up to 10 TRTC rooms for mixed stream pushback.

The following layout templates are currently supported. Dynamic layout templates (floating template, grid template, screen sharing template) only support a single TRTC room, while custom templates support mixing audio and video streams from multiple TRTC rooms. The specific descriptions are as follows:

1. Floating template: The video screen of the first user entering the room will fill the entire screen, and the video screens of other users will be arranged horizontally from the bottom left corner, displaying as small screens, with up to 4 rows and 4 screens per row. The small screens float above the large screen. It supports up to 1 large screen and 15 small screens. If the user only sends audio, it does not occupy the layout configuration by default, but it can also be set. Each sub-screen is rendered by default using the center cropping method, and the rendering method of the sub-screen can also be set uniformly.

2. Grid template: The video screens of all users are of the same size, evenly dividing the entire screen. The more people there are, the smaller the size of each user's screen. It supports up to 16 screens. If the user only sends audio, it does not occupy the layout configuration by default, but it can also be set. Each sub-screen is rendered by default using the center cropping method, and the rendering method of the sub-screen can also be set uniformly.

3. Screen sharing template: Suitable for video conference and online education scenarios. The screen sharing (or the main speaker's camera) always occupies the large screen position on the left side of the screen. You need to explicitly set the MixTranscoding user information that occupies the large screen. Other users are arranged vertically on the right side, with up to two columns and 8 small screens per column. It supports up to 1 large screen and 15 small screens. If the uplink resolution aspect ratio is different from the screen output aspect ratio, the large screen on the left side will be scaled to maintain content integrity, while the small screens on the right side will be cropped. The rendering method of the sub-screen can also be set uniformly.

4. Custom layout template: Allows you to actively set the layout position according to your business needs. Each preset layout position supports named settings (named settings require specifying the room number and username) and unnamed settings. When a sub-screen is named, the position is reserved for the user, and the user will automatically occupy the position when entering the room and sending audio and video data. Other users will not occupy this position. When the preset layout position is not named, the layout engine will automatically fill in the order of entering the room. When the preset positions are full, no other users' screens and sounds will be mixed. Each sub-screen position supports setting placeholder images (BackgroundImageUrl). When the user does not enter the room or only sends audio data, the screen at this position can display the corresponding placeholder image.

When using the relay API, you may incur the following costs depending on the usage characteristics:

For MCU MixTranscoding fees, please refer to the documentation: Billing of MixTranscoding and Relay to CDN | Tencent Cloud.

For non-Tencent Cloud CDN relay fees, please refer to the documentation: Billing of MixTranscoding and Relay to CDN | Tencent Cloud.

Instructions for using parameters:

1. AgentParams: Each relay task will pull a robot user into the TRTC room to pull the stream. You need to set this robot user through the AgentParams.UserId parameter. This robot ID cannot conflict with the normal user ID in the room, otherwise, the relay task will be abnormally terminated due to the robot user being kicked out of the TRTC room. You can avoid this by adding a special prefix. You can control the automatic termination of the relay task by setting AgentParams.MaxIdleTime. When this parameter is set, the relay task will automatically stop when all participating MixTranscoding anchors continuously leave the TRTC room for more than MaxIdleTime duration. Note: The relay task will not automatically stop when the participating MixTranscoding anchor only stops sending audio and video.

2. WithTranscoding: If you need to mix multiple audio and video streams into one, WithTranscoding must be set to 1.

3. AudioParams: The audio parameters and video parameters of the relay task are set separately. If you want to mix the audio of specified users, you need to explicitly set AudioParams.SubscribeAudioList. If you do not set AudioParams.SubscribeAudioList, the mixing engine will automatically mix the audio of all users in the TRTC room. If you want to mix the audio of all users in the TRTC room except for specified users, you can set the audio blacklist list through AudioParams.UnSubscribeAudioList.

4. VideoParams: If you want to mix user videos, you can set it through VideoParams. If you only want to mix audio, you do not need to set VideoParams. You can set the screen layout mode through VideoParams.LayoutParams.MixLayoutMode, including dynamic layout (1: floating layout (default), 2: screen sharing layout, 3: grid layout) and custom layout. The dynamic layout mode is automatically mixed by the layout engine according to a fixed layout, and there is no need to set VideoParams.LayoutParams.MixLayoutList. When using the floating layout and screen sharing layout, you can specify the large screen user by setting VideoParams.LayoutParams.MaxVideoUser. The custom layout mode provides you with the ability to layout screens independently, and you can specify the layout position of each user through VideoParams.LayoutParams.MixLayoutList. In each layout parameter, you can specify the layout position for the specified user by setting the UserMediaStream parameter, or you can not set the UserMediaStream, and the layout engine will automatically fill in the order of users entering the TRTC room. In addition, you can set the rendering method (RenderMode) and cropping method (CustomCrop) for each layout position.

5. VideoParams.WaterMarkList: If you want to overlay a watermark on the mixed screen, you can set it through VideoParams.WaterMarkList. It supports image watermarks and text watermarks and supports transparent channels.

6. SingleSubscribeParams: If you want to push a single stream from the TRTC room to the CDN, you can set it using the SingleSubscribeParams parameter. In this case, you need to set the WithTranscoding parameter to 0.

7. PublishCdnParams.N: If you want to push the stream to the CDN, you can set it using the PublishCdnParams.N parameter. It supports pushing to up to 10 CDN addresses at the same time. If the relay address is Tencent Cloud CDN, please set IsTencentCdn explicitly to 1; if you need to relay to a non-Tencent Cloud CDN, please contact Tencent Cloud Technical Support to enable it. Relaying to non-Tencent Cloud will incur relay fees. For fee information, please refer to the official documentation: On-Cloud Relay Billing Overview.

8. FeedBackRoomParams.N: If you want to push the mixed audio and video stream back to the TRTC room, you can set it using the FeedBackRoomParams.N parameter. It supports pushing up to 10 streams back to the TRTC room at the same time. You need to specify the TRTC room number and robot ID (UserId) for the pushback. The robot ID cannot conflict with the normal user ID, otherwise, the relay task will be abnormally terminated due to the robot user being kicked out of the TRTC room. You can avoid this by adding a special prefix.

9. SeiParams: If you want to add SEI information to the mixed audio and video stream, you can set it using the SeiParams parameter. It supports volume layout SEI and overlay relay request SEI. The content of the volume layout SEI is a fixed JSON structure, please see the SEI description in the following section of this chapter. You can set the SEI to follow the keyframe by setting the FollowIdr parameter. The description of the volume layout SEI is as follows:

If your CDN audience needs to recognize the position of the participating MixTranscoding anchors and the volume information of the participating MixTranscoding anchors, you can use the volume layout SEI. The payload content and parameter description of the volume layout SEI are as follows:

{ "app_data":"", "canvas":{ "w":1080, "h":960 }, "regions":[ { "uid":"65949987242835883c", "zorder":2, "volume":45, "x":270, "y":480, "w":540, "h":480 }, { "uid":"659c9d8d242b328d31", "zorder":2, "volume":0, "x":0, "y":0, "w":540, "h":480 }, { "uid":"64989a82272b308c", "zorder":2, "volume":91, "x":540, "y":0, "w":540, "h":480 } ], "ver":"1.0", "ts":1648544726 }

canvas: This is the width and height of the VideoEncode setting in the MixTranscoding signaling, that is, the width and height of the entire canvas of the MixTranscoding output.

regions: Contains the real mixed user ID and the corresponding sub-screen position. If the participating MixTranscoding user does not enter the TRTC room or does not turn on the video uplink, the regions will not include the user.

uid: Represents the user ID participating in MixTranscoding.

zorder: The layer of the participating MixTranscoding userid in the MixTranscoding output.

x/y: The coordinates of the sub-screen of the participating MixTranscoding userid on the canvas.

w/h: The size of the sub-screen of the participating MixTranscoding userid.

volume: Represents the volume of the MixTranscoding user, with a value range of 0-100. The larger the value, the greater the volume of the user participating in MixTranscoding.

ts: The server local second-level timestamp for outputting SEI.

ver: can be ignored.

Usage Precautions:

1. When using the Mixed Relay Interface, you need to call the Start Relay Task Interface (StartPublishCdnStream) first to get the Task ID from the response. Then, use the Task ID to update the relay task (UpdatePublishCdnStream) and stop the relay task (StopPublishCdnStream).

2. The Relay API does not support initiating Automatic Bypass Tasks configured in the TRTC Console, nor does it support Custom Stream ID bypass tasks set in the TRTC SDK room entry interface.

3. To ensure the stability of the relay link, the same relay task does not support switching between Audio only, Audio and Video, and Video only.

4. To ensure the stability of the relay link, updating video parameters (codec) and audio parameters (codec, Sample rate, bitrate, and number of channels) is not supported during the Update Video process.

5. When initiating a single stream bypass task, filling in both Audio Parameters and Video Parameters means Audio and Video bypass. If only Audio Parameters are filled in, it means Audio only bypass, and switching from Audio only to Audio and Video is not supported during the task progress. For Audio and Video bypass, the Width, Height, Fps, BitRate, and Gop in Video Parameters must be filled in according to the real upstream parameters.

6. The SequenceNumber parameter must be carried in the update request to prevent request disorder. Customers must ensure that the SequenceNumber parameter increases when updating the same task, otherwise, the mix task update will fail.

7. When calling the API, choose the region according to the following instructions: If the Application ID is 1400xxx, the region can be Beijing, Shanghai, Guangzhou, or Hong Kong. If your CDN audience is mainly overseas, please choose Hong Kong. If the Application ID is 200xxx or 400xxx, please choose Singapore.

8. Streams pushed back to the TRTC room will not participate in the mixing of other push back room tasks. If one of the following conditions is met, it can participate in the mixing of other relay CDN tasks: (1) The push stream robot is specified to participate in the mixing in the video parameters of the relay CDN task; (2) The push stream robot is specified to participate in the mixing in the audio parameters of the relay CDN task through the whitelist method; (3) The room number of the mix user participating in the relay CDN task is completely different from the room number of the mix user corresponding to the push back robot.

9. You can create a relay task before the anchor enters the room. When the relay task is finished, you need to call the stop interface actively. If you do not call the Stop Relay Task Interface, Tencent Cloud will automatically stop the mix relay task when all users participating in the mix have no data uploaded for a period of time exceeding the timeout (AgentParams.MaxIdleTime) set when starting the relay task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) StartPublishCdnStreamWithContext 

func (c *Client) StartPublishCdnStreamWithContext(ctx context.Context, request *StartPublishCdnStreamRequest) (response *StartPublishCdnStreamResponse, err error)

StartPublishCdnStream In a TRTC room, there may be multiple audio and video streams concurrently active. You can use the MixTranscoding API to notify Tencent Cloud server to mix multiple video screens from the same room or multiple rooms together, and specify the position of each screen, while mixing multiple audio streams together. The final result is a single audio and video stream, which can be used for recording and live viewing. It also supports pushing this mixed audio and video stream back to the TRTC room.

The Cloud API MixTranscoding feature includes three interfaces:

1. StartPublishCdnStream: Start a MixTranscoding task. This interface will initiate a new MixTranscoding task. After the task is successfully started, a unique TaskId will be returned under the sdkappid dimension. You need to save this TaskId, as it will be required for updating and stopping the task later.

2. UpdatePublishCdnStream: Update the specified MixTranscoding task, including updating the video screen layout, updating the mixing list, updating the list of CDN addresses to be relayed, and updating the list of rooms to be pushed back.

3. StopPublishCdnStream: Stop the specified MixTranscoding task.

You can achieve the following goals through this set of interfaces:

1. Set the final video and audio quality, including video resolution, video frame rate, video bitrate, and audio quality.

2. Set the layout position of each screen. You only need to set it once. When you specify the MixTranscoding user to enter the room and send audio and video, the layout engine will automatically mix the user's screen to the specified layout position. You can also use the update interface to adjust the layout position.

3. Set multiple CDN relay target addresses. A single relay task can support up to 10 CDN relay addresses at the same time.

4. Set multiple room pushback lists. A single relay task can support up to 10 TRTC rooms for mixed stream pushback.

The following layout templates are currently supported. Dynamic layout templates (floating template, grid template, screen sharing template) only support a single TRTC room, while custom templates support mixing audio and video streams from multiple TRTC rooms. The specific descriptions are as follows:

1. Floating template: The video screen of the first user entering the room will fill the entire screen, and the video screens of other users will be arranged horizontally from the bottom left corner, displaying as small screens, with up to 4 rows and 4 screens per row. The small screens float above the large screen. It supports up to 1 large screen and 15 small screens. If the user only sends audio, it does not occupy the layout configuration by default, but it can also be set. Each sub-screen is rendered by default using the center cropping method, and the rendering method of the sub-screen can also be set uniformly.

2. Grid template: The video screens of all users are of the same size, evenly dividing the entire screen. The more people there are, the smaller the size of each user's screen. It supports up to 16 screens. If the user only sends audio, it does not occupy the layout configuration by default, but it can also be set. Each sub-screen is rendered by default using the center cropping method, and the rendering method of the sub-screen can also be set uniformly.

3. Screen sharing template: Suitable for video conference and online education scenarios. The screen sharing (or the main speaker's camera) always occupies the large screen position on the left side of the screen. You need to explicitly set the MixTranscoding user information that occupies the large screen. Other users are arranged vertically on the right side, with up to two columns and 8 small screens per column. It supports up to 1 large screen and 15 small screens. If the uplink resolution aspect ratio is different from the screen output aspect ratio, the large screen on the left side will be scaled to maintain content integrity, while the small screens on the right side will be cropped. The rendering method of the sub-screen can also be set uniformly.

4. Custom layout template: Allows you to actively set the layout position according to your business needs. Each preset layout position supports named settings (named settings require specifying the room number and username) and unnamed settings. When a sub-screen is named, the position is reserved for the user, and the user will automatically occupy the position when entering the room and sending audio and video data. Other users will not occupy this position. When the preset layout position is not named, the layout engine will automatically fill in the order of entering the room. When the preset positions are full, no other users' screens and sounds will be mixed. Each sub-screen position supports setting placeholder images (BackgroundImageUrl). When the user does not enter the room or only sends audio data, the screen at this position can display the corresponding placeholder image.

When using the relay API, you may incur the following costs depending on the usage characteristics:

For MCU MixTranscoding fees, please refer to the documentation: Billing of MixTranscoding and Relay to CDN | Tencent Cloud.

For non-Tencent Cloud CDN relay fees, please refer to the documentation: Billing of MixTranscoding and Relay to CDN | Tencent Cloud.

Instructions for using parameters:

1. AgentParams: Each relay task will pull a robot user into the TRTC room to pull the stream. You need to set this robot user through the AgentParams.UserId parameter. This robot ID cannot conflict with the normal user ID in the room, otherwise, the relay task will be abnormally terminated due to the robot user being kicked out of the TRTC room. You can avoid this by adding a special prefix. You can control the automatic termination of the relay task by setting AgentParams.MaxIdleTime. When this parameter is set, the relay task will automatically stop when all participating MixTranscoding anchors continuously leave the TRTC room for more than MaxIdleTime duration. Note: The relay task will not automatically stop when the participating MixTranscoding anchor only stops sending audio and video.

2. WithTranscoding: If you need to mix multiple audio and video streams into one, WithTranscoding must be set to 1.

3. AudioParams: The audio parameters and video parameters of the relay task are set separately. If you want to mix the audio of specified users, you need to explicitly set AudioParams.SubscribeAudioList. If you do not set AudioParams.SubscribeAudioList, the mixing engine will automatically mix the audio of all users in the TRTC room. If you want to mix the audio of all users in the TRTC room except for specified users, you can set the audio blacklist list through AudioParams.UnSubscribeAudioList.

4. VideoParams: If you want to mix user videos, you can set it through VideoParams. If you only want to mix audio, you do not need to set VideoParams. You can set the screen layout mode through VideoParams.LayoutParams.MixLayoutMode, including dynamic layout (1: floating layout (default), 2: screen sharing layout, 3: grid layout) and custom layout. The dynamic layout mode is automatically mixed by the layout engine according to a fixed layout, and there is no need to set VideoParams.LayoutParams.MixLayoutList. When using the floating layout and screen sharing layout, you can specify the large screen user by setting VideoParams.LayoutParams.MaxVideoUser. The custom layout mode provides you with the ability to layout screens independently, and you can specify the layout position of each user through VideoParams.LayoutParams.MixLayoutList. In each layout parameter, you can specify the layout position for the specified user by setting the UserMediaStream parameter, or you can not set the UserMediaStream, and the layout engine will automatically fill in the order of users entering the TRTC room. In addition, you can set the rendering method (RenderMode) and cropping method (CustomCrop) for each layout position.

5. VideoParams.WaterMarkList: If you want to overlay a watermark on the mixed screen, you can set it through VideoParams.WaterMarkList. It supports image watermarks and text watermarks and supports transparent channels.

6. SingleSubscribeParams: If you want to push a single stream from the TRTC room to the CDN, you can set it using the SingleSubscribeParams parameter. In this case, you need to set the WithTranscoding parameter to 0.

7. PublishCdnParams.N: If you want to push the stream to the CDN, you can set it using the PublishCdnParams.N parameter. It supports pushing to up to 10 CDN addresses at the same time. If the relay address is Tencent Cloud CDN, please set IsTencentCdn explicitly to 1; if you need to relay to a non-Tencent Cloud CDN, please contact Tencent Cloud Technical Support to enable it. Relaying to non-Tencent Cloud will incur relay fees. For fee information, please refer to the official documentation: On-Cloud Relay Billing Overview.

8. FeedBackRoomParams.N: If you want to push the mixed audio and video stream back to the TRTC room, you can set it using the FeedBackRoomParams.N parameter. It supports pushing up to 10 streams back to the TRTC room at the same time. You need to specify the TRTC room number and robot ID (UserId) for the pushback. The robot ID cannot conflict with the normal user ID, otherwise, the relay task will be abnormally terminated due to the robot user being kicked out of the TRTC room. You can avoid this by adding a special prefix.

9. SeiParams: If you want to add SEI information to the mixed audio and video stream, you can set it using the SeiParams parameter. It supports volume layout SEI and overlay relay request SEI. The content of the volume layout SEI is a fixed JSON structure, please see the SEI description in the following section of this chapter. You can set the SEI to follow the keyframe by setting the FollowIdr parameter. The description of the volume layout SEI is as follows:

If your CDN audience needs to recognize the position of the participating MixTranscoding anchors and the volume information of the participating MixTranscoding anchors, you can use the volume layout SEI. The payload content and parameter description of the volume layout SEI are as follows:

{ "app_data":"", "canvas":{ "w":1080, "h":960 }, "regions":[ { "uid":"65949987242835883c", "zorder":2, "volume":45, "x":270, "y":480, "w":540, "h":480 }, { "uid":"659c9d8d242b328d31", "zorder":2, "volume":0, "x":0, "y":0, "w":540, "h":480 }, { "uid":"64989a82272b308c", "zorder":2, "volume":91, "x":540, "y":0, "w":540, "h":480 } ], "ver":"1.0", "ts":1648544726 }

canvas: This is the width and height of the VideoEncode setting in the MixTranscoding signaling, that is, the width and height of the entire canvas of the MixTranscoding output.

regions: Contains the real mixed user ID and the corresponding sub-screen position. If the participating MixTranscoding user does not enter the TRTC room or does not turn on the video uplink, the regions will not include the user.

uid: Represents the user ID participating in MixTranscoding.

zorder: The layer of the participating MixTranscoding userid in the MixTranscoding output.

x/y: The coordinates of the sub-screen of the participating MixTranscoding userid on the canvas.

w/h: The size of the sub-screen of the participating MixTranscoding userid.

volume: Represents the volume of the MixTranscoding user, with a value range of 0-100. The larger the value, the greater the volume of the user participating in MixTranscoding.

ts: The server local second-level timestamp for outputting SEI.

ver: can be ignored.

Usage Precautions:

1. When using the Mixed Relay Interface, you need to call the Start Relay Task Interface (StartPublishCdnStream) first to get the Task ID from the response. Then, use the Task ID to update the relay task (UpdatePublishCdnStream) and stop the relay task (StopPublishCdnStream).

2. The Relay API does not support initiating Automatic Bypass Tasks configured in the TRTC Console, nor does it support Custom Stream ID bypass tasks set in the TRTC SDK room entry interface.

3. To ensure the stability of the relay link, the same relay task does not support switching between Audio only, Audio and Video, and Video only.

4. To ensure the stability of the relay link, updating video parameters (codec) and audio parameters (codec, Sample rate, bitrate, and number of channels) is not supported during the Update Video process.

5. When initiating a single stream bypass task, filling in both Audio Parameters and Video Parameters means Audio and Video bypass. If only Audio Parameters are filled in, it means Audio only bypass, and switching from Audio only to Audio and Video is not supported during the task progress. For Audio and Video bypass, the Width, Height, Fps, BitRate, and Gop in Video Parameters must be filled in according to the real upstream parameters.

6. The SequenceNumber parameter must be carried in the update request to prevent request disorder. Customers must ensure that the SequenceNumber parameter increases when updating the same task, otherwise, the mix task update will fail.

7. When calling the API, choose the region according to the following instructions: If the Application ID is 1400xxx, the region can be Beijing, Shanghai, Guangzhou, or Hong Kong. If your CDN audience is mainly overseas, please choose Hong Kong. If the Application ID is 200xxx or 400xxx, please choose Singapore.

8. Streams pushed back to the TRTC room will not participate in the mixing of other push back room tasks. If one of the following conditions is met, it can participate in the mixing of other relay CDN tasks: (1) The push stream robot is specified to participate in the mixing in the video parameters of the relay CDN task; (2) The push stream robot is specified to participate in the mixing in the audio parameters of the relay CDN task through the whitelist method; (3) The room number of the mix user participating in the relay CDN task is completely different from the room number of the mix user corresponding to the push back robot.

9. You can create a relay task before the anchor enters the room. When the relay task is finished, you need to call the stop interface actively. If you do not call the Stop Relay Task Interface, Tencent Cloud will automatically stop the mix relay task when all users participating in the mix have no data uploaded for a period of time exceeding the timeout (AgentParams.MaxIdleTime) set when starting the relay task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) StartStreamIngest 

func (c *Client) StartStreamIngest(request *StartStreamIngestRequest) (response *StartStreamIngestResponse, err error)

StartStreamIngest Push an online media stream to the TRTC room.

error code that may be returned: 

FAILEDOPERATION_NOTRTMPFUNCTION = "FailedOperation.NotRtmpFunction"
FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency"
FAILEDOPERATION_TASKEXIST = "FailedOperation.TaskExist"
INTERNALERROR_HTTPPARSEFAILED = "InternalError.HttpParseFailed"
INTERNALERROR_INTERNALERROR = "InternalError.InternalError"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STRROOMID = "InvalidParameter.StrRoomId"
INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
INVALIDPARAMETER_USERSIG = "InvalidParameter.UserSig"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection"

func (*Client) StartStreamIngestWithContext 

func (c *Client) StartStreamIngestWithContext(ctx context.Context, request *StartStreamIngestRequest) (response *StartStreamIngestResponse, err error)

StartStreamIngest Push an online media stream to the TRTC room.

error code that may be returned: 

FAILEDOPERATION_NOTRTMPFUNCTION = "FailedOperation.NotRtmpFunction"
FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency"
FAILEDOPERATION_TASKEXIST = "FailedOperation.TaskExist"
INTERNALERROR_HTTPPARSEFAILED = "InternalError.HttpParseFailed"
INTERNALERROR_INTERNALERROR = "InternalError.InternalError"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STRROOMID = "InvalidParameter.StrRoomId"
INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
INVALIDPARAMETER_USERSIG = "InvalidParameter.UserSig"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection"

func (*Client) StopPublishCdnStream 

func (c *Client) StopPublishCdnStream(request *StopPublishCdnStreamRequest) (response *StopPublishCdnStreamResponse, err error)

StopPublishCdnStream This API is used to stop a relaying task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) StopPublishCdnStreamWithContext 

func (c *Client) StopPublishCdnStreamWithContext(ctx context.Context, request *StopPublishCdnStreamRequest) (response *StopPublishCdnStreamResponse, err error)

StopPublishCdnStream This API is used to stop a relaying task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) StopStreamIngest 

func (c *Client) StopStreamIngest(request *StopStreamIngestRequest) (response *StopStreamIngestResponse, err error)

StopStreamIngest Stop a Pull stream Relay task.

error code that may be returned: 

FAILEDOPERATION_TASKFINISHED = "FailedOperation.TaskFinished"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"

func (*Client) StopStreamIngestWithContext 

func (c *Client) StopStreamIngestWithContext(ctx context.Context, request *StopStreamIngestRequest) (response *StopStreamIngestResponse, err error)

StopStreamIngest Stop a Pull stream Relay task.

error code that may be returned: 

FAILEDOPERATION_TASKFINISHED = "FailedOperation.TaskFinished"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"

func (*Client) UpdatePublishCdnStream 

func (c *Client) UpdatePublishCdnStream(request *UpdatePublishCdnStreamRequest) (response *UpdatePublishCdnStreamResponse, err error)

UpdatePublishCdnStream This API is used to change the parameters of a relaying task.

Note: For details about how to use this API, see the `StartPublishCdnStream` document.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpdatePublishCdnStreamWithContext 

func (c *Client) UpdatePublishCdnStreamWithContext(ctx context.Context, request *UpdatePublishCdnStreamRequest) (response *UpdatePublishCdnStreamResponse, err error)

UpdatePublishCdnStream This API is used to change the parameters of a relaying task.

Note: For details about how to use this API, see the `StartPublishCdnStream` document.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

type CloudStorage 

type CloudStorage struct {
	// The cloud storage provider.
	// `0`: Tencent Cloud COS; `1`: AWS storage. Other vendors are not supported currently.
	Vendor *uint64 `json:"Vendor,omitnil,omitempty" name:"Vendor"`

	// The region of cloud storage.
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// The storage bucket.
	Bucket *string `json:"Bucket,omitnil,omitempty" name:"Bucket"`

	// The access_key of the cloud storage account.
	AccessKey *string `json:"AccessKey,omitnil,omitempty" name:"AccessKey"`

	// The secret_key of the cloud storage account.
	SecretKey *string `json:"SecretKey,omitnil,omitempty" name:"SecretKey"`

	// The bucket to save data, which is an array of strings that can contain letters (a-z and A-Z), numbers (0-9), underscores (_), and hyphens (-). For example, if the value of this parameter is `["prefix1", "prefix2"]`, the recording file `xxx.m3u8` will be saved as `prefix1/prefix2/TaskId/xxx.m3u8`.
	FileNamePrefix []*string `json:"FileNamePrefix,omitnil,omitempty" name:"FileNamePrefix"`
}

type CloudVod 

type CloudVod struct {
	// The Tencent Cloud VOD parameters.
	TencentVod *TencentVod `json:"TencentVod,omitnil,omitempty" name:"TencentVod"`
}

type CreateCloudRecordingRequest 

type CreateCloudRecordingRequest struct {
	*tchttp.BaseRequest

	// The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The [room ID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The [user ID](https://www.tencentcloud.com/document/product/647/37714#userid) of the recording robot in the TRTC room, which cannot be identical to the user IDs of anchors in the room or other recording robots. To distinguish this user ID from others, we recommend you include the room ID in the user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The signature (similar to a login password) required for the recording robot to enter the room. Each user ID corresponds to a signature. For information on how to calculate the signature, see [What is UserSig?](https://intl.cloud.tencent.com/document/product/647/38104).
	UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"`

	// The on-cloud recording parameters.
	RecordParams *RecordParams `json:"RecordParams,omitnil,omitempty" name:"RecordParams"`

	// The storage information of the recording file. Currently, you can save recording files to Tencent Cloud VOD or COS.
	StorageParams *StorageParams `json:"StorageParams,omitnil,omitempty" name:"StorageParams"`

	// The type of the TRTC room ID, which must be the same as the ID type of the room whose streams are recorded.
	// 0: String
	// 1: 32-bit integer (default)
	RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"`

	// The stream mixing parameters, which are valid if the mixed-stream recording mode is used.
	MixTranscodeParams *MixTranscodeParams `json:"MixTranscodeParams,omitnil,omitempty" name:"MixTranscodeParams"`

	// The layout parameters, which are valid if the mixed-stream recording mode is used.
	MixLayoutParams *MixLayoutParams `json:"MixLayoutParams,omitnil,omitempty" name:"MixLayoutParams"`

	// The amount of time (in hours) during which API requests can be made after recording starts. Calculation starts when a recording task is started (when the recording task ID is returned). Once the period elapses, the query, modification, and stop recording APIs can no longer be called, but the recording task will continue. The default value is `72` (three days), and the maximum and minimum values allowed are `720` (30 days) and `6` respectively. If you do not set this parameter, the query, modification, and stop recording APIs can be called within 72 hours after recording starts.
	ResourceExpiredHour *uint64 `json:"ResourceExpiredHour,omitnil,omitempty" name:"ResourceExpiredHour"`

	// The permission ticket for a TRTC room. This parameter is required if advanced permission control is enabled in the console, in which case the TRTC backend will verify users’ [PrivateMapKey](https://intl.cloud.tencent.com/document/product/647/32240?from_cn_redirect=1), which include an encrypted room ID and permission bit list. A user providing only `UserSig` and not `PrivateMapKey` will be unable to enter the room.
	PrivateMapKey *string `json:"PrivateMapKey,omitnil,omitempty" name:"PrivateMapKey"`
}

func NewCreateCloudRecordingRequest 

func NewCreateCloudRecordingRequest() (request *CreateCloudRecordingRequest)

func (*CreateCloudRecordingRequest) FromJsonString 

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

func (r *CreateCloudRecordingRequest) ToJsonString() string

type CreateCloudRecordingRequestParams 

type CreateCloudRecordingRequestParams struct {
	// The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The [room ID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The [user ID](https://www.tencentcloud.com/document/product/647/37714#userid) of the recording robot in the TRTC room, which cannot be identical to the user IDs of anchors in the room or other recording robots. To distinguish this user ID from others, we recommend you include the room ID in the user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The signature (similar to a login password) required for the recording robot to enter the room. Each user ID corresponds to a signature. For information on how to calculate the signature, see [What is UserSig?](https://intl.cloud.tencent.com/document/product/647/38104).
	UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"`

	// The on-cloud recording parameters.
	RecordParams *RecordParams `json:"RecordParams,omitnil,omitempty" name:"RecordParams"`

	// The storage information of the recording file. Currently, you can save recording files to Tencent Cloud VOD or COS.
	StorageParams *StorageParams `json:"StorageParams,omitnil,omitempty" name:"StorageParams"`

	// The type of the TRTC room ID, which must be the same as the ID type of the room whose streams are recorded.
	// 0: String
	// 1: 32-bit integer (default)
	RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"`

	// The stream mixing parameters, which are valid if the mixed-stream recording mode is used.
	MixTranscodeParams *MixTranscodeParams `json:"MixTranscodeParams,omitnil,omitempty" name:"MixTranscodeParams"`

	// The layout parameters, which are valid if the mixed-stream recording mode is used.
	MixLayoutParams *MixLayoutParams `json:"MixLayoutParams,omitnil,omitempty" name:"MixLayoutParams"`

	// The amount of time (in hours) during which API requests can be made after recording starts. Calculation starts when a recording task is started (when the recording task ID is returned). Once the period elapses, the query, modification, and stop recording APIs can no longer be called, but the recording task will continue. The default value is `72` (three days), and the maximum and minimum values allowed are `720` (30 days) and `6` respectively. If you do not set this parameter, the query, modification, and stop recording APIs can be called within 72 hours after recording starts.
	ResourceExpiredHour *uint64 `json:"ResourceExpiredHour,omitnil,omitempty" name:"ResourceExpiredHour"`

	// The permission ticket for a TRTC room. This parameter is required if advanced permission control is enabled in the console, in which case the TRTC backend will verify users’ [PrivateMapKey](https://intl.cloud.tencent.com/document/product/647/32240?from_cn_redirect=1), which include an encrypted room ID and permission bit list. A user providing only `UserSig` and not `PrivateMapKey` will be unable to enter the room.
	PrivateMapKey *string `json:"PrivateMapKey,omitnil,omitempty" name:"PrivateMapKey"`
}

Predefined struct for user

type CreateCloudRecordingResponse 

type CreateCloudRecordingResponse struct {
	*tchttp.BaseResponse
	Response *CreateCloudRecordingResponseParams `json:"Response"`
}

func NewCreateCloudRecordingResponse 

func NewCreateCloudRecordingResponse() (response *CreateCloudRecordingResponse)

func (*CreateCloudRecordingResponse) FromJsonString 

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

func (r *CreateCloudRecordingResponse) ToJsonString() string

type CreateCloudRecordingResponseParams 

type CreateCloudRecordingResponseParams struct {
	// The task ID assigned by the recording service, which uniquely identifies a recording process and becomes invalid after a recording task ends. After a recording task starts, if you want to perform other actions on the task, you need to specify the task ID when making API requests.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteCloudRecordingRequest 

type DeleteCloudRecordingRequest struct {
	*tchttp.BaseRequest

	// The `SDKAppID` of the room whose streams are recorded.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The unique ID of the recording task, which is returned after recording starts successfully.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewDeleteCloudRecordingRequest 

func NewDeleteCloudRecordingRequest() (request *DeleteCloudRecordingRequest)

func (*DeleteCloudRecordingRequest) FromJsonString 

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

func (r *DeleteCloudRecordingRequest) ToJsonString() string

type DeleteCloudRecordingRequestParams 

type DeleteCloudRecordingRequestParams struct {
	// The `SDKAppID` of the room whose streams are recorded.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The unique ID of the recording task, which is returned after recording starts successfully.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type DeleteCloudRecordingResponse 

type DeleteCloudRecordingResponse struct {
	*tchttp.BaseResponse
	Response *DeleteCloudRecordingResponseParams `json:"Response"`
}

func NewDeleteCloudRecordingResponse 

func NewDeleteCloudRecordingResponse() (response *DeleteCloudRecordingResponse)

func (*DeleteCloudRecordingResponse) FromJsonString 

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

func (r *DeleteCloudRecordingResponse) ToJsonString() string

type DeleteCloudRecordingResponseParams 

type DeleteCloudRecordingResponseParams struct {
	// The task ID assigned by the recording service, which uniquely identifies a recording process and becomes invalid after a recording task ends.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeCallDetailInfoRequest 

type DescribeCallDetailInfoRequest struct {
	*tchttp.BaseRequest

	// The unique ID of a call, whose format is `SdkAppId_CreateTime`, such as `1400xxxxxx_218695_1590065777`. `createTime` is the UNIX timestamp (seconds) when the room was created. Its value can be obtained using the [DescribeRoomInfo](https://intl.cloud.tencent.com/document/product/647/44050?from_cn_redirect=1) API.
	CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"`

	// The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
	// Note: Only data in the last 14 days can be queried.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`.
	// Note: If `DataType` is not null, the end time and start time cannot be more than one hour apart; if `DataType` is null, the end time and start time cannot be more than four hours apart.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The application ID, such as `1400xxxxxx`.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The users to query. If you do not specify this, the data of six users will be returned.
	UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"`

	// The metrics to query. If you do not specify this, only the user list will be returned. If you pass in `all`, all metrics will be returned.
	// `appCpu`: The CPU utilization of the application.
	// `sysCpu`: The CPU utilization of the system.
	// `aBit`: The upstream/downstream audio bitrate (bps).
	// `aBlock`: The audio stutter duration (ms).
	// `bigvBit`: The upstream/downstream video bitrate (bps).
	// `bigvCapFps`: The frame rate for capturing videos.
	// `bigvEncFps`: The frame rate for sending videos.
	// `bigvDecFps`: The rendering frame rate.
	// `bigvBlock`: The video stutter duration (ms).
	// `aLoss`: The upstream/downstream audio packet loss.
	// `bigvLoss`: The upstream/downstream video packet loss.
	// `bigvWidth`: The upstream/downstream resolution (width).
	// `bigvHeight`: The upstream/downstream resolution (height).
	DataType []*string `json:"DataType,omitnil,omitempty" name:"DataType"`

	// The page number. The default is 0.
	// Note: If `PageNumber` or `PageSize` is not specified, six records will be returned.
	PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"`

	// The number of records per page. The default is `6`.
	// Value range: 1-100.
	// Note: If `DataType` is not null, the length of the array `UserIds` and the value of `PageSize` cannot exceed `6`.
	// If `DataType` is null, the length of the array `UserIds` and the value of `PageSize` cannot exceed `100`.
	PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`
}

func NewDescribeCallDetailInfoRequest 

func NewDescribeCallDetailInfoRequest() (request *DescribeCallDetailInfoRequest)

func (*DescribeCallDetailInfoRequest) FromJsonString 

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

func (r *DescribeCallDetailInfoRequest) ToJsonString() string

type DescribeCallDetailInfoRequestParams 

type DescribeCallDetailInfoRequestParams struct {
	// The unique ID of a call, whose format is `SdkAppId_CreateTime`, such as `1400xxxxxx_218695_1590065777`. `createTime` is the UNIX timestamp (seconds) when the room was created. Its value can be obtained using the [DescribeRoomInfo](https://intl.cloud.tencent.com/document/product/647/44050?from_cn_redirect=1) API.
	CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"`

	// The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
	// Note: Only data in the last 14 days can be queried.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`.
	// Note: If `DataType` is not null, the end time and start time cannot be more than one hour apart; if `DataType` is null, the end time and start time cannot be more than four hours apart.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The application ID, such as `1400xxxxxx`.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The users to query. If you do not specify this, the data of six users will be returned.
	UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"`

	// The metrics to query. If you do not specify this, only the user list will be returned. If you pass in `all`, all metrics will be returned.
	// `appCpu`: The CPU utilization of the application.
	// `sysCpu`: The CPU utilization of the system.
	// `aBit`: The upstream/downstream audio bitrate (bps).
	// `aBlock`: The audio stutter duration (ms).
	// `bigvBit`: The upstream/downstream video bitrate (bps).
	// `bigvCapFps`: The frame rate for capturing videos.
	// `bigvEncFps`: The frame rate for sending videos.
	// `bigvDecFps`: The rendering frame rate.
	// `bigvBlock`: The video stutter duration (ms).
	// `aLoss`: The upstream/downstream audio packet loss.
	// `bigvLoss`: The upstream/downstream video packet loss.
	// `bigvWidth`: The upstream/downstream resolution (width).
	// `bigvHeight`: The upstream/downstream resolution (height).
	DataType []*string `json:"DataType,omitnil,omitempty" name:"DataType"`

	// The page number. The default is 0.
	// Note: If `PageNumber` or `PageSize` is not specified, six records will be returned.
	PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"`

	// The number of records per page. The default is `6`.
	// Value range: 1-100.
	// Note: If `DataType` is not null, the length of the array `UserIds` and the value of `PageSize` cannot exceed `6`.
	// If `DataType` is null, the length of the array `UserIds` and the value of `PageSize` cannot exceed `100`.
	PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`
}

Predefined struct for user

type DescribeCallDetailInfoResponse 

type DescribeCallDetailInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeCallDetailInfoResponseParams `json:"Response"`
}

func NewDescribeCallDetailInfoResponse 

func NewDescribeCallDetailInfoResponse() (response *DescribeCallDetailInfoResponse)

func (*DescribeCallDetailInfoResponse) FromJsonString 

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

func (r *DescribeCallDetailInfoResponse) ToJsonString() string

type DescribeCallDetailInfoResponseParams 

type DescribeCallDetailInfoResponseParams struct {
	// The number of records returned.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The user information.
	// Note: This field may return null, indicating that no valid values can be obtained.
	UserList []*UserInformation `json:"UserList,omitnil,omitempty" name:"UserList"`

	// The call quality data.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Data []*QualityData `json:"Data,omitnil,omitempty" name:"Data"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeCloudRecordingRequest 

type DescribeCloudRecordingRequest struct {
	*tchttp.BaseRequest

	// The `SDKAppID` of the room whose streams are recorded.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The unique ID of the recording task, which is returned after recording starts successfully.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewDescribeCloudRecordingRequest 

func NewDescribeCloudRecordingRequest() (request *DescribeCloudRecordingRequest)

func (*DescribeCloudRecordingRequest) FromJsonString 

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

func (r *DescribeCloudRecordingRequest) ToJsonString() string

type DescribeCloudRecordingRequestParams 

type DescribeCloudRecordingRequestParams struct {
	// The `SDKAppID` of the room whose streams are recorded.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The unique ID of the recording task, which is returned after recording starts successfully.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type DescribeCloudRecordingResponse 

type DescribeCloudRecordingResponse struct {
	*tchttp.BaseResponse
	Response *DescribeCloudRecordingResponseParams `json:"Response"`
}

func NewDescribeCloudRecordingResponse 

func NewDescribeCloudRecordingResponse() (response *DescribeCloudRecordingResponse)

func (*DescribeCloudRecordingResponse) FromJsonString 

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

func (r *DescribeCloudRecordingResponse) ToJsonString() string

type DescribeCloudRecordingResponseParams 

type DescribeCloudRecordingResponseParams struct {
	// The unique ID of the recording task.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// The status of the on-cloud recording task.
	// Idle: The task is idle.
	// InProgress: The task is in progress.
	// Exited: The task is being ended.
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// The information of the recording files.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	StorageFileList []*StorageFile `json:"StorageFileList,omitnil,omitempty" name:"StorageFileList"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeMixTranscodingUsageRequest 

type DescribeMixTranscodingUsageRequest struct {
	*tchttp.BaseRequest

	// The start date in the format of YYYY-MM-DD.
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end date in the format of YYYY-MM-DD.
	// The period queried per request cannot be longer than 31 days.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The `SDKAppID` of the TRTC application to which the target room belongs. If you do not specify this parameter, the usage statistics of all TRTC applications under the current account will be returned.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDescribeMixTranscodingUsageRequest 

func NewDescribeMixTranscodingUsageRequest() (request *DescribeMixTranscodingUsageRequest)

func (*DescribeMixTranscodingUsageRequest) FromJsonString 

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

func (r *DescribeMixTranscodingUsageRequest) ToJsonString() string

type DescribeMixTranscodingUsageRequestParams 

type DescribeMixTranscodingUsageRequestParams struct {
	// The start date in the format of YYYY-MM-DD.
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end date in the format of YYYY-MM-DD.
	// The period queried per request cannot be longer than 31 days.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The `SDKAppID` of the TRTC application to which the target room belongs. If you do not specify this parameter, the usage statistics of all TRTC applications under the current account will be returned.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DescribeMixTranscodingUsageResponse 

type DescribeMixTranscodingUsageResponse struct {
	*tchttp.BaseResponse
	Response *DescribeMixTranscodingUsageResponseParams `json:"Response"`
}

func NewDescribeMixTranscodingUsageResponse 

func NewDescribeMixTranscodingUsageResponse() (response *DescribeMixTranscodingUsageResponse)

func (*DescribeMixTranscodingUsageResponse) FromJsonString 

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

func (r *DescribeMixTranscodingUsageResponse) ToJsonString() string

type DescribeMixTranscodingUsageResponseParams 

type DescribeMixTranscodingUsageResponseParams struct {
	// The usage type. Each element of this parameter corresponds to an element of `UsageValue` in the order they are listed.
	UsageKey []*string `json:"UsageKey,omitnil,omitempty" name:"UsageKey"`

	// The usage data in each time unit.
	UsageList []*TrtcUsage `json:"UsageList,omitnil,omitempty" name:"UsageList"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRecordingUsageRequest 

type DescribeRecordingUsageRequest struct {
	*tchttp.BaseRequest

	// The start date in the format of YYYY-MM-DD.
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end date in the format of YYYY-MM-DD.
	// The period queried per request cannot be longer than 31 days.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// Whether to query single-stream or mixed-stream recording. Valid values: `single`, `multi`.
	MixType *string `json:"MixType,omitnil,omitempty" name:"MixType"`

	// The `SDKAppID` of the TRTC application to which the target room belongs. If you do not specify this parameter, the usage statistics of all TRTC applications under the current account will be returned.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDescribeRecordingUsageRequest 

func NewDescribeRecordingUsageRequest() (request *DescribeRecordingUsageRequest)

func (*DescribeRecordingUsageRequest) FromJsonString 

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

func (r *DescribeRecordingUsageRequest) ToJsonString() string

type DescribeRecordingUsageRequestParams 

type DescribeRecordingUsageRequestParams struct {
	// The start date in the format of YYYY-MM-DD.
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end date in the format of YYYY-MM-DD.
	// The period queried per request cannot be longer than 31 days.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// Whether to query single-stream or mixed-stream recording. Valid values: `single`, `multi`.
	MixType *string `json:"MixType,omitnil,omitempty" name:"MixType"`

	// The `SDKAppID` of the TRTC application to which the target room belongs. If you do not specify this parameter, the usage statistics of all TRTC applications under the current account will be returned.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DescribeRecordingUsageResponse 

type DescribeRecordingUsageResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRecordingUsageResponseParams `json:"Response"`
}

func NewDescribeRecordingUsageResponse 

func NewDescribeRecordingUsageResponse() (response *DescribeRecordingUsageResponse)

func (*DescribeRecordingUsageResponse) FromJsonString 

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

func (r *DescribeRecordingUsageResponse) ToJsonString() string

type DescribeRecordingUsageResponseParams 

type DescribeRecordingUsageResponseParams struct {
	// The usage type. Each element of this parameter corresponds to an element of `UsageValue` in the order they are listed.
	UsageKey []*string `json:"UsageKey,omitnil,omitempty" name:"UsageKey"`

	// The usage data in each time unit.
	UsageList []*TrtcUsage `json:"UsageList,omitnil,omitempty" name:"UsageList"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRelayUsageRequest 

type DescribeRelayUsageRequest struct {
	*tchttp.BaseRequest

	// The start date in the format of YYYY-MM-DD.
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end date in the format of YYYY-MM-DD.
	// The period queried per request cannot be longer than 31 days.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The `SDKAppID` of the TRTC application to which the target room belongs. If you do not specify this parameter, the usage statistics of all TRTC applications under the current account will be returned.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDescribeRelayUsageRequest 

func NewDescribeRelayUsageRequest() (request *DescribeRelayUsageRequest)

func (*DescribeRelayUsageRequest) FromJsonString 

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

func (r *DescribeRelayUsageRequest) ToJsonString() string

type DescribeRelayUsageRequestParams 

type DescribeRelayUsageRequestParams struct {
	// The start date in the format of YYYY-MM-DD.
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end date in the format of YYYY-MM-DD.
	// The period queried per request cannot be longer than 31 days.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The `SDKAppID` of the TRTC application to which the target room belongs. If you do not specify this parameter, the usage statistics of all TRTC applications under the current account will be returned.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DescribeRelayUsageResponse 

type DescribeRelayUsageResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRelayUsageResponseParams `json:"Response"`
}

func NewDescribeRelayUsageResponse 

func NewDescribeRelayUsageResponse() (response *DescribeRelayUsageResponse)

func (*DescribeRelayUsageResponse) FromJsonString 

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

func (r *DescribeRelayUsageResponse) ToJsonString() string

type DescribeRelayUsageResponseParams 

type DescribeRelayUsageResponseParams struct {
	// The usage type. Each element of this parameter corresponds to an element of `UsageValue` in the order they are listed.
	UsageKey []*string `json:"UsageKey,omitnil,omitempty" name:"UsageKey"`

	// The usage data in each time unit.
	UsageList []*TrtcUsage `json:"UsageList,omitnil,omitempty" name:"UsageList"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRoomInfoRequest 

type DescribeRoomInfoRequest struct {
	*tchttp.BaseRequest

	// The application ID, such as `1400xxxxxx`.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
	// Note: Only data in the last 14 days can be queried.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`.
	// Note: The end and start time cannot be more than 24 hours apart.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The room ID, such as `223`.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The page number. The default is 0.
	// Note: If `PageNumber` or `PageSize` is not specified, 10 records will be returned.
	PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"`

	// The number of records per page. The default is `10`.
	// Value range: 1-100.
	PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`
}

func NewDescribeRoomInfoRequest 

func NewDescribeRoomInfoRequest() (request *DescribeRoomInfoRequest)

func (*DescribeRoomInfoRequest) FromJsonString 

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

func (r *DescribeRoomInfoRequest) ToJsonString() string

type DescribeRoomInfoRequestParams 

type DescribeRoomInfoRequestParams struct {
	// The application ID, such as `1400xxxxxx`.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
	// Note: Only data in the last 14 days can be queried.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`.
	// Note: The end and start time cannot be more than 24 hours apart.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The room ID, such as `223`.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The page number. The default is 0.
	// Note: If `PageNumber` or `PageSize` is not specified, 10 records will be returned.
	PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"`

	// The number of records per page. The default is `10`.
	// Value range: 1-100.
	PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`
}

Predefined struct for user

type DescribeRoomInfoResponse 

type DescribeRoomInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRoomInfoResponseParams `json:"Response"`
}

func NewDescribeRoomInfoResponse 

func NewDescribeRoomInfoResponse() (response *DescribeRoomInfoResponse)

func (*DescribeRoomInfoResponse) FromJsonString 

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

func (r *DescribeRoomInfoResponse) ToJsonString() string

type DescribeRoomInfoResponseParams 

type DescribeRoomInfoResponseParams struct {
	// The number of records returned.
	Total *int64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The room information.
	RoomList []*RoomState `json:"RoomList,omitnil,omitempty" name:"RoomList"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeScaleInfoRequest 

type DescribeScaleInfoRequest struct {
	*tchttp.BaseRequest

	// The application ID, such as `1400xxxxxx`.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
	// Note: Only data in the last 14 days can be queried.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`. The end time and start time should preferably be more than 24 hours apart.
	// Note: Data is collected on a daily basis. To query the data of a day, make sure the end time is later than 00:00 on that day. Otherwise, no data will be returned. For example, to query the data on the 20th, the end time must be later than 00:00 on the 20th.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`
}

func NewDescribeScaleInfoRequest 

func NewDescribeScaleInfoRequest() (request *DescribeScaleInfoRequest)

func (*DescribeScaleInfoRequest) FromJsonString 

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

func (r *DescribeScaleInfoRequest) ToJsonString() string

type DescribeScaleInfoRequestParams 

type DescribeScaleInfoRequestParams struct {
	// The application ID, such as `1400xxxxxx`.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
	// Note: Only data in the last 14 days can be queried.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`. The end time and start time should preferably be more than 24 hours apart.
	// Note: Data is collected on a daily basis. To query the data of a day, make sure the end time is later than 00:00 on that day. Otherwise, no data will be returned. For example, to query the data on the 20th, the end time must be later than 00:00 on the 20th.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`
}

Predefined struct for user

type DescribeScaleInfoResponse 

type DescribeScaleInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeScaleInfoResponseParams `json:"Response"`
}

func NewDescribeScaleInfoResponse 

func NewDescribeScaleInfoResponse() (response *DescribeScaleInfoResponse)

func (*DescribeScaleInfoResponse) FromJsonString 

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

func (r *DescribeScaleInfoResponse) ToJsonString() string

type DescribeScaleInfoResponseParams 

type DescribeScaleInfoResponseParams struct {
	// The number of records returned.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The returned data.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ScaleList []*ScaleInfomation `json:"ScaleList,omitnil,omitempty" name:"ScaleList"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeStreamIngestRequest 

type DescribeStreamIngestRequest struct {
	*tchttp.BaseRequest

	// The SDKAppId of TRTC should be the same as the SDKAppId corresponding to the task room.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The unique Id of the task, will return after successfully starting the task.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewDescribeStreamIngestRequest 

func NewDescribeStreamIngestRequest() (request *DescribeStreamIngestRequest)

func (*DescribeStreamIngestRequest) FromJsonString 

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

func (r *DescribeStreamIngestRequest) ToJsonString() string

type DescribeStreamIngestRequestParams 

type DescribeStreamIngestRequestParams struct {
	// The SDKAppId of TRTC should be the same as the SDKAppId corresponding to the task room.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The unique Id of the task, will return after successfully starting the task.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type DescribeStreamIngestResponse 

type DescribeStreamIngestResponse struct {
	*tchttp.BaseResponse
	Response *DescribeStreamIngestResponseParams `json:"Response"`
}

func NewDescribeStreamIngestResponse 

func NewDescribeStreamIngestResponse() (response *DescribeStreamIngestResponse)

func (*DescribeStreamIngestResponse) FromJsonString 

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

func (r *DescribeStreamIngestResponse) ToJsonString() string

type DescribeStreamIngestResponseParams 

type DescribeStreamIngestResponseParams struct {
	// Task status information. InProgress: Indicates that the current task is in progress. NotExist: Indicates that the current task does not exist. Example value: InProgress
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeTRTCMarketQualityDataRequest 

type DescribeTRTCMarketQualityDataRequest struct {
	*tchttp.BaseRequest

	// User SDKAppId (e.g., 1400xxxxxx)
	SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Query start time, format is YYYY-MM-DD. (The query time range depends on the monitoring dashboard function version, the premium edition can query up to 30 days)
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// Query end time, format is YYYY-MM-DD.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The granularity of the returned data, which can be set to the following values:
	// d: by day. This returns data for the entire UTC day of the query time range.
	// h: by hour. This returns data for the entire UTC hour of the query time range.
	Period *string `json:"Period,omitnil,omitempty" name:"Period"`
}

func NewDescribeTRTCMarketQualityDataRequest 

func NewDescribeTRTCMarketQualityDataRequest() (request *DescribeTRTCMarketQualityDataRequest)

func (*DescribeTRTCMarketQualityDataRequest) FromJsonString 

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

func (r *DescribeTRTCMarketQualityDataRequest) ToJsonString() string

type DescribeTRTCMarketQualityDataRequestParams 

type DescribeTRTCMarketQualityDataRequestParams struct {
	// User SDKAppId (e.g., 1400xxxxxx)
	SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Query start time, format is YYYY-MM-DD. (The query time range depends on the monitoring dashboard function version, the premium edition can query up to 30 days)
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// Query end time, format is YYYY-MM-DD.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The granularity of the returned data, which can be set to the following values:
	// d: by day. This returns data for the entire UTC day of the query time range.
	// h: by hour. This returns data for the entire UTC hour of the query time range.
	Period *string `json:"Period,omitnil,omitempty" name:"Period"`
}

Predefined struct for user

type DescribeTRTCMarketQualityDataResponse 

type DescribeTRTCMarketQualityDataResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTRTCMarketQualityDataResponseParams `json:"Response"`
}

func NewDescribeTRTCMarketQualityDataResponse 

func NewDescribeTRTCMarketQualityDataResponse() (response *DescribeTRTCMarketQualityDataResponse)

func (*DescribeTRTCMarketQualityDataResponse) FromJsonString 

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

func (r *DescribeTRTCMarketQualityDataResponse) ToJsonString() string

type DescribeTRTCMarketQualityDataResponseParams 

type DescribeTRTCMarketQualityDataResponseParams struct {
	// TRTC Data Dashboard output parameters
	Data *TRTCDataResult `json:"Data,omitnil,omitempty" name:"Data"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeTRTCMarketScaleDataRequest 

type DescribeTRTCMarketScaleDataRequest struct {
	*tchttp.BaseRequest

	// User SDKAppId
	SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Query start time, format is YYYY-MM-DD. (The query time range depends on the monitoring dashboard function version, the premium edition can query up to 60 days)
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// Query end time, format is YYYY-MM-DD.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The granularity of the returned data, which can be set to the following values:
	//  d: by day. This returns data for the entire UTC day of the query time range.
	//  h: by hour. This returns data for the entire UTC hour of the query time range.
	Period *string `json:"Period,omitnil,omitempty" name:"Period"`
}

func NewDescribeTRTCMarketScaleDataRequest 

func NewDescribeTRTCMarketScaleDataRequest() (request *DescribeTRTCMarketScaleDataRequest)

func (*DescribeTRTCMarketScaleDataRequest) FromJsonString 

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

func (r *DescribeTRTCMarketScaleDataRequest) ToJsonString() string

type DescribeTRTCMarketScaleDataRequestParams 

type DescribeTRTCMarketScaleDataRequestParams struct {
	// User SDKAppId
	SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Query start time, format is YYYY-MM-DD. (The query time range depends on the monitoring dashboard function version, the premium edition can query up to 60 days)
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// Query end time, format is YYYY-MM-DD.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The granularity of the returned data, which can be set to the following values:
	//  d: by day. This returns data for the entire UTC day of the query time range.
	//  h: by hour. This returns data for the entire UTC hour of the query time range.
	Period *string `json:"Period,omitnil,omitempty" name:"Period"`
}

Predefined struct for user

type DescribeTRTCMarketScaleDataResponse 

type DescribeTRTCMarketScaleDataResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTRTCMarketScaleDataResponseParams `json:"Response"`
}

func NewDescribeTRTCMarketScaleDataResponse 

func NewDescribeTRTCMarketScaleDataResponse() (response *DescribeTRTCMarketScaleDataResponse)

func (*DescribeTRTCMarketScaleDataResponse) FromJsonString 

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

func (r *DescribeTRTCMarketScaleDataResponse) ToJsonString() string

type DescribeTRTCMarketScaleDataResponseParams 

type DescribeTRTCMarketScaleDataResponseParams struct {
	// TRTC Data Dashboard output parameters
	Data *TRTCDataResult `json:"Data,omitnil,omitempty" name:"Data"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeTRTCRealTimeQualityDataRequest 

type DescribeTRTCRealTimeQualityDataRequest struct {
	*tchttp.BaseRequest

	// User SDKAppId (e.g., 1400xxxxxx)
	SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Start time, unix timestamp, Unit: seconds (Query time range depends on the monitoring dashboard function version, standard edition can query the last 3 hours, premium edition can query the last 12 hours)
	StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// End time, unix timestamp, Unit: seconds
	EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

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

func NewDescribeTRTCRealTimeQualityDataRequest 

func NewDescribeTRTCRealTimeQualityDataRequest() (request *DescribeTRTCRealTimeQualityDataRequest)

func (*DescribeTRTCRealTimeQualityDataRequest) FromJsonString 

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

func (r *DescribeTRTCRealTimeQualityDataRequest) ToJsonString() string

type DescribeTRTCRealTimeQualityDataRequestParams 

type DescribeTRTCRealTimeQualityDataRequestParams struct {
	// User SDKAppId (e.g., 1400xxxxxx)
	SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Start time, unix timestamp, Unit: seconds (Query time range depends on the monitoring dashboard function version, standard edition can query the last 3 hours, premium edition can query the last 12 hours)
	StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// End time, unix timestamp, Unit: seconds
	EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

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

Predefined struct for user

type DescribeTRTCRealTimeQualityDataResponse 

type DescribeTRTCRealTimeQualityDataResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTRTCRealTimeQualityDataResponseParams `json:"Response"`
}

func NewDescribeTRTCRealTimeQualityDataResponse 

func NewDescribeTRTCRealTimeQualityDataResponse() (response *DescribeTRTCRealTimeQualityDataResponse)

func (*DescribeTRTCRealTimeQualityDataResponse) FromJsonString 

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

func (r *DescribeTRTCRealTimeQualityDataResponse) ToJsonString() string

type DescribeTRTCRealTimeQualityDataResponseParams 

type DescribeTRTCRealTimeQualityDataResponseParams struct {
	// TRTC Real- Time Monitoring output parameters
	Data *TRTCDataResult `json:"Data,omitnil,omitempty" name:"Data"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeTRTCRealTimeScaleDataRequest 

type DescribeTRTCRealTimeScaleDataRequest struct {
	*tchttp.BaseRequest

	// User SDKAppId (e.g., 1400xxxxxx)
	SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Start time, unix timestamp, Unit: seconds (Query time range depends on the function version of the monitoring dashboard, premium edition can query up to 1 hours)
	StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// End time, unix timestamp, Unit: seconds
	EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

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

func NewDescribeTRTCRealTimeScaleDataRequest 

func NewDescribeTRTCRealTimeScaleDataRequest() (request *DescribeTRTCRealTimeScaleDataRequest)

func (*DescribeTRTCRealTimeScaleDataRequest) FromJsonString 

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

func (r *DescribeTRTCRealTimeScaleDataRequest) ToJsonString() string

type DescribeTRTCRealTimeScaleDataRequestParams 

type DescribeTRTCRealTimeScaleDataRequestParams struct {
	// User SDKAppId (e.g., 1400xxxxxx)
	SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Start time, unix timestamp, Unit: seconds (Query time range depends on the function version of the monitoring dashboard, premium edition can query up to 1 hours)
	StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// End time, unix timestamp, Unit: seconds
	EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

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

Predefined struct for user

type DescribeTRTCRealTimeScaleDataResponse 

type DescribeTRTCRealTimeScaleDataResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTRTCRealTimeScaleDataResponseParams `json:"Response"`
}

func NewDescribeTRTCRealTimeScaleDataResponse 

func NewDescribeTRTCRealTimeScaleDataResponse() (response *DescribeTRTCRealTimeScaleDataResponse)

func (*DescribeTRTCRealTimeScaleDataResponse) FromJsonString 

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

func (r *DescribeTRTCRealTimeScaleDataResponse) ToJsonString() string

type DescribeTRTCRealTimeScaleDataResponseParams 

type DescribeTRTCRealTimeScaleDataResponseParams struct {
	// TRTC Real- Time Monitoring
	//  output parameter
	Data *TRTCDataResult `json:"Data,omitnil,omitempty" name:"Data"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeTrtcRoomUsageRequest 

type DescribeTrtcRoomUsageRequest struct {
	*tchttp.BaseRequest

	// The `SDKAppID` of the room.
	SdkAppid *uint64 `json:"SdkAppid,omitnil,omitempty" name:"SdkAppid"`

	// The start time in the format of `YYYY-MM-DD HH:MM` (accurate to the minute).
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time in the format of `YYYY-MM-DD HH:MM`. The start and end time cannot be more than 24 hours apart.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`
}

func NewDescribeTrtcRoomUsageRequest 

func NewDescribeTrtcRoomUsageRequest() (request *DescribeTrtcRoomUsageRequest)

func (*DescribeTrtcRoomUsageRequest) FromJsonString 

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

func (r *DescribeTrtcRoomUsageRequest) ToJsonString() string

type DescribeTrtcRoomUsageRequestParams 

type DescribeTrtcRoomUsageRequestParams struct {
	// The `SDKAppID` of the room.
	SdkAppid *uint64 `json:"SdkAppid,omitnil,omitempty" name:"SdkAppid"`

	// The start time in the format of `YYYY-MM-DD HH:MM` (accurate to the minute).
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time in the format of `YYYY-MM-DD HH:MM`. The start and end time cannot be more than 24 hours apart.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`
}

Predefined struct for user

type DescribeTrtcRoomUsageResponse 

type DescribeTrtcRoomUsageResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTrtcRoomUsageResponseParams `json:"Response"`
}

func NewDescribeTrtcRoomUsageResponse 

func NewDescribeTrtcRoomUsageResponse() (response *DescribeTrtcRoomUsageResponse)

func (*DescribeTrtcRoomUsageResponse) FromJsonString 

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

func (r *DescribeTrtcRoomUsageResponse) ToJsonString() string

type DescribeTrtcRoomUsageResponseParams 

type DescribeTrtcRoomUsageResponseParams struct {
	// The usage data grouped by room, in CSV format.
	Data *string `json:"Data,omitnil,omitempty" name:"Data"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeTrtcUsageRequest 

type DescribeTrtcUsageRequest struct {
	*tchttp.BaseRequest

	// The start date in the format of YYYY-MM-DD.
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end date in the format of YYYY-MM-DD.
	// The period queried per request cannot be longer than 31 days.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The `SDKAppID` of the TRTC application to which the target room belongs. If you do not specify this parameter, the usage statistics of all TRTC applications under the current account will be returned.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDescribeTrtcUsageRequest 

func NewDescribeTrtcUsageRequest() (request *DescribeTrtcUsageRequest)

func (*DescribeTrtcUsageRequest) FromJsonString 

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

func (r *DescribeTrtcUsageRequest) ToJsonString() string

type DescribeTrtcUsageRequestParams 

type DescribeTrtcUsageRequestParams struct {
	// The start date in the format of YYYY-MM-DD.
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end date in the format of YYYY-MM-DD.
	// The period queried per request cannot be longer than 31 days.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The `SDKAppID` of the TRTC application to which the target room belongs. If you do not specify this parameter, the usage statistics of all TRTC applications under the current account will be returned.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DescribeTrtcUsageResponse 

type DescribeTrtcUsageResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTrtcUsageResponseParams `json:"Response"`
}

func NewDescribeTrtcUsageResponse 

func NewDescribeTrtcUsageResponse() (response *DescribeTrtcUsageResponse)

func (*DescribeTrtcUsageResponse) FromJsonString 

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

func (r *DescribeTrtcUsageResponse) ToJsonString() string

type DescribeTrtcUsageResponseParams 

type DescribeTrtcUsageResponseParams struct {
	// The usage type. Each element of this parameter corresponds to an element of `UsageValue` in the order they are listed.
	UsageKey []*string `json:"UsageKey,omitnil,omitempty" name:"UsageKey"`

	// The usage data in each time unit.
	UsageList []*TrtcUsage `json:"UsageList,omitnil,omitempty" name:"UsageList"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUnusualEventRequest 

type DescribeUnusualEventRequest struct {
	*tchttp.BaseRequest

	// The application ID, such as `1400xxxxxx`.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
	// Note: Only data in the last 14 days can be queried.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`. The end time and start time cannot be more than one hour apart.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The room ID. Up to 20 random abnormal user experiences of the specified room will be returned.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

func NewDescribeUnusualEventRequest 

func NewDescribeUnusualEventRequest() (request *DescribeUnusualEventRequest)

func (*DescribeUnusualEventRequest) FromJsonString 

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

func (r *DescribeUnusualEventRequest) ToJsonString() string

type DescribeUnusualEventRequestParams 

type DescribeUnusualEventRequestParams struct {
	// The application ID, such as `1400xxxxxx`.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
	// Note: Only data in the last 14 days can be queried.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`. The end time and start time cannot be more than one hour apart.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The room ID. Up to 20 random abnormal user experiences of the specified room will be returned.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

Predefined struct for user

type DescribeUnusualEventResponse 

type DescribeUnusualEventResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUnusualEventResponseParams `json:"Response"`
}

func NewDescribeUnusualEventResponse 

func NewDescribeUnusualEventResponse() (response *DescribeUnusualEventResponse)

func (*DescribeUnusualEventResponse) FromJsonString 

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

func (r *DescribeUnusualEventResponse) ToJsonString() string

type DescribeUnusualEventResponseParams 

type DescribeUnusualEventResponseParams struct {
	// The number of records returned.
	// Value range: 0-20.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The information of the abnormal user experiences.
	AbnormalExperienceList []*AbnormalExperience `json:"AbnormalExperienceList,omitnil,omitempty" name:"AbnormalExperienceList"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUserEventRequest 

type DescribeUserEventRequest struct {
	*tchttp.BaseRequest

	// The unique ID of a call, whose format is `SdkAppId_CreateTime`, such as `1400xxxxxx_218695_1590065777`. `createTime` is the UNIX timestamp (seconds) when the room was created. Its value can be obtained using the [DescribeRoomInfo](https://intl.cloud.tencent.com/document/product/647/44050?from_cn_redirect=1) API.
	CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"`

	// The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
	// Note: Only data in the last 14 days can be queried.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`.
	// Note: If you pass in an end time later than the room end time, the room end time will be used.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The room ID, such as `223`.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The application ID, such as `1400xxxxxx`.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDescribeUserEventRequest 

func NewDescribeUserEventRequest() (request *DescribeUserEventRequest)

func (*DescribeUserEventRequest) FromJsonString 

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

func (r *DescribeUserEventRequest) ToJsonString() string

type DescribeUserEventRequestParams 

type DescribeUserEventRequestParams struct {
	// The unique ID of a call, whose format is `SdkAppId_CreateTime`, such as `1400xxxxxx_218695_1590065777`. `createTime` is the UNIX timestamp (seconds) when the room was created. Its value can be obtained using the [DescribeRoomInfo](https://intl.cloud.tencent.com/document/product/647/44050?from_cn_redirect=1) API.
	CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"`

	// The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
	// Note: Only data in the last 14 days can be queried.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`.
	// Note: If you pass in an end time later than the room end time, the room end time will be used.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The room ID, such as `223`.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The application ID, such as `1400xxxxxx`.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DescribeUserEventResponse 

type DescribeUserEventResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUserEventResponseParams `json:"Response"`
}

func NewDescribeUserEventResponse 

func NewDescribeUserEventResponse() (response *DescribeUserEventResponse)

func (*DescribeUserEventResponse) FromJsonString 

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

func (r *DescribeUserEventResponse) ToJsonString() string

type DescribeUserEventResponseParams 

type DescribeUserEventResponseParams struct {
	// The event list. An empty array will be returned if no data is obtained.
	Data []*EventList `json:"Data,omitnil,omitempty" name:"Data"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUserInfoRequest 

type DescribeUserInfoRequest struct {
	*tchttp.BaseRequest

	// The unique ID of a call, whose format is `SdkAppId_CreateTime`, such as `1400xxxxxx_218695_1590065777`. `createTime` is the UNIX timestamp (seconds) when the room was created. Its value can be obtained using the [DescribeRoomInfo](https://intl.cloud.tencent.com/document/product/647/44050?from_cn_redirect=1) API.
	CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"`

	// The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
	// Note: Only data in the last 14 days can be queried.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`.
	// Note: The end and start time cannot be more than four hours apart.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The application ID, such as `1400xxxxxx`.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The users to query. If you do not specify this, the information of six users will be returned.
	// Array length: 1-100.
	UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"`

	// The page number. The default is 0.
	// Note: If `PageNumber` or `PageSize` is not specified, six records will be returned.
	PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"`

	// The number of records per page. The default is `6`.
	// Array length: 1-100.
	PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`
}

func NewDescribeUserInfoRequest 

func NewDescribeUserInfoRequest() (request *DescribeUserInfoRequest)

func (*DescribeUserInfoRequest) FromJsonString 

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

func (r *DescribeUserInfoRequest) ToJsonString() string

type DescribeUserInfoRequestParams 

type DescribeUserInfoRequestParams struct {
	// The unique ID of a call, whose format is `SdkAppId_CreateTime`, such as `1400xxxxxx_218695_1590065777`. `createTime` is the UNIX timestamp (seconds) when the room was created. Its value can be obtained using the [DescribeRoomInfo](https://intl.cloud.tencent.com/document/product/647/44050?from_cn_redirect=1) API.
	CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"`

	// The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
	// Note: Only data in the last 14 days can be queried.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`.
	// Note: The end and start time cannot be more than four hours apart.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The application ID, such as `1400xxxxxx`.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The users to query. If you do not specify this, the information of six users will be returned.
	// Array length: 1-100.
	UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"`

	// The page number. The default is 0.
	// Note: If `PageNumber` or `PageSize` is not specified, six records will be returned.
	PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"`

	// The number of records per page. The default is `6`.
	// Array length: 1-100.
	PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`
}

Predefined struct for user

type DescribeUserInfoResponse 

type DescribeUserInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUserInfoResponseParams `json:"Response"`
}

func NewDescribeUserInfoResponse 

func NewDescribeUserInfoResponse() (response *DescribeUserInfoResponse)

func (*DescribeUserInfoResponse) FromJsonString 

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

func (r *DescribeUserInfoResponse) ToJsonString() string

type DescribeUserInfoResponseParams 

type DescribeUserInfoResponseParams struct {
	// The number of records returned.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The user information.
	// Note: This field may return null, indicating that no valid values can be obtained.
	UserList []*UserInformation `json:"UserList,omitnil,omitempty" name:"UserList"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DismissRoomByStrRoomIdRequest 

type DismissRoomByStrRoomIdRequest struct {
	*tchttp.BaseRequest

	// `SDKAppId` of TRTC
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

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

func NewDismissRoomByStrRoomIdRequest 

func NewDismissRoomByStrRoomIdRequest() (request *DismissRoomByStrRoomIdRequest)

func (*DismissRoomByStrRoomIdRequest) FromJsonString 

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

func (r *DismissRoomByStrRoomIdRequest) ToJsonString() string

type DismissRoomByStrRoomIdRequestParams 

type DismissRoomByStrRoomIdRequestParams struct {
	// `SDKAppId` of TRTC
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

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

Predefined struct for user

type DismissRoomByStrRoomIdResponse 

type DismissRoomByStrRoomIdResponse struct {
	*tchttp.BaseResponse
	Response *DismissRoomByStrRoomIdResponseParams `json:"Response"`
}

func NewDismissRoomByStrRoomIdResponse 

func NewDismissRoomByStrRoomIdResponse() (response *DismissRoomByStrRoomIdResponse)

func (*DismissRoomByStrRoomIdResponse) FromJsonString 

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

func (r *DismissRoomByStrRoomIdResponse) ToJsonString() string

type DismissRoomByStrRoomIdResponseParams 

type DismissRoomByStrRoomIdResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DismissRoomRequest 

type DismissRoomRequest struct {
	*tchttp.BaseRequest

	// `SDKAppId` of TRTC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Room number.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

func NewDismissRoomRequest 

func NewDismissRoomRequest() (request *DismissRoomRequest)

func (*DismissRoomRequest) FromJsonString 

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

func (r *DismissRoomRequest) ToJsonString() string

type DismissRoomRequestParams 

type DismissRoomRequestParams struct {
	// `SDKAppId` of TRTC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Room number.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

Predefined struct for user

type DismissRoomResponse 

type DismissRoomResponse struct {
	*tchttp.BaseResponse
	Response *DismissRoomResponseParams `json:"Response"`
}

func NewDismissRoomResponse 

func NewDismissRoomResponse() (response *DismissRoomResponse)

func (*DismissRoomResponse) FromJsonString 

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

func (r *DismissRoomResponse) ToJsonString() string

type DismissRoomResponseParams 

type DismissRoomResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EventList 

type EventList struct {
	// The event information.
	Content []*EventMessage `json:"Content,omitnil,omitempty" name:"Content"`

	// The user ID of the sender.
	PeerId *string `json:"PeerId,omitnil,omitempty" name:"PeerId"`
}

type EventMessage 

type EventMessage struct {
	// The video stream type. Valid values:
	// `0`: A non-video event
	// `2`: The big video
	// `3`: The small video
	// `7`: A relayed video
	Type *uint64 `json:"Type,omitnil,omitempty" name:"Type"`

	// The event reporting time in the format of UNIX timestamp (milliseconds), such as `1589891188801`.
	Time *uint64 `json:"Time,omitnil,omitempty" name:"Time"`

	// The event ID. Events are classified into SDK events and WebRTC events. For more information, see https://www.tencentcloud.com/document/product/647/37906?has_map=1
	EventId *uint64 `json:"EventId,omitnil,omitempty" name:"EventId"`

	// The first event parameter, such as the video width.
	ParamOne *int64 `json:"ParamOne,omitnil,omitempty" name:"ParamOne"`

	// The second event parameter, such as the video height.
	ParamTwo *int64 `json:"ParamTwo,omitnil,omitempty" name:"ParamTwo"`
}

type MaxVideoUser 

type MaxVideoUser struct {
	// The stream information.
	UserMediaStream *UserMediaStream `json:"UserMediaStream,omitnil,omitempty" name:"UserMediaStream"`
}

type McuAudioParams 

type McuAudioParams struct {
	// The audio encoding parameters.
	AudioEncode *AudioEncode `json:"AudioEncode,omitnil,omitempty" name:"AudioEncode"`

	// The audio mix allowlist. For the `StartPublishCdnStream` API, if you do not pass this parameter or leave it empty, the audios of all anchors will be mixed. For the `UpdatePublishCdnStream` API, if you do not pass this parameter, no changes will be made to the current allowlist; if you pass in an empty string, the audios of all anchors will be mixed.
	// In cases where `SubscribeAudioList` and `UnSubscribeAudioList` are used at the same time, you need to specify both parameters. If you pass neither `SubscribeAudioList` nor `UnSubscribeAudioList`, no changes will be made. If a user is included in both parameters, the user’s audio will not be mixed.
	SubscribeAudioList []*McuUserInfoParams `json:"SubscribeAudioList,omitnil,omitempty" name:"SubscribeAudioList"`

	// The audio mix blocklist. If you do not pass this parameter or leave it empty, there won’t be a blocklist. For the `UpdatePublishCdnStream` API, if you do not pass this parameter, no changes will be made to the current blocklist; if you pass in an empty string, the blocklist will be reset.
	// In cases where `SubscribeAudioList` and `UnSubscribeAudioList` are used at the same time, you need to specify both parameters. If you pass neither `SubscribeAudioList` nor `UnSubscribeAudioList`, no changes will be made. If a user is included in both parameters, the user’s audio will not be mixed.
	UnSubscribeAudioList []*McuUserInfoParams `json:"UnSubscribeAudioList,omitnil,omitempty" name:"UnSubscribeAudioList"`
}

type McuCustomCrop 

type McuCustomCrop struct {
	// The horizontal offset (pixels) of the starting point for cropping. This parameter must be greater than 0.
	LocationX *uint64 `json:"LocationX,omitnil,omitempty" name:"LocationX"`

	// The vertical offset (pixels) of the starting point for cropping. This parameter must be greater than 0.
	LocationY *uint64 `json:"LocationY,omitnil,omitempty" name:"LocationY"`

	// The video width (pixels) after cropping. The sum of this parameter and `LocationX` cannot be greater than 10000.
	Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"`

	// The video height (pixels) after cropping. The sum of this parameter and `LocationY` cannot be greater than 10000.
	Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"`
}

type McuFeedBackRoomParams 

type McuFeedBackRoomParams struct {
	// The room ID.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The ID type of the room to which streams are relayed. `0` indicates integer, and `1` indicates string.
	RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"`

	// The [user ID](https://www.tencentcloud.com/document/product/647/37714) of the relaying robot in the TRTC room, which cannot be the same as a user ID already in use. We recommend you include the room ID in this user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The signature (similar to login password) required for the relaying robot to enter the room. For information on how to calculate the signature, see [What is UserSig?](https://www.tencentcloud.com/document/product/647/38104).
	UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"`
}

type McuLayout 

type McuLayout struct {
	// The information of the stream that is displayed. If you do not pass this parameter, TRTC will display the videos of anchors in the room according to their room entry sequence.
	UserMediaStream *UserMediaStream `json:"UserMediaStream,omitnil,omitempty" name:"UserMediaStream"`

	// The video width (pixels). If you do not pass this parameter, 0 will be used.
	ImageWidth *uint64 `json:"ImageWidth,omitnil,omitempty" name:"ImageWidth"`

	// The video height (pixels). If you do not pass this parameter, 0 will be used.
	ImageHeight *uint64 `json:"ImageHeight,omitnil,omitempty" name:"ImageHeight"`

	// The horizontal offset (pixels) of the video. The sum of `LocationX` and `ImageWidth` cannot exceed the width of the canvas. If you do not pass this parameter, 0 will be used.
	LocationX *uint64 `json:"LocationX,omitnil,omitempty" name:"LocationX"`

	// The vertical offset of the video. The sum of `LocationY` and `ImageHeight` cannot exceed the height of the canvas. If you do not pass this parameter, 0 will be used.
	LocationY *uint64 `json:"LocationY,omitnil,omitempty" name:"LocationY"`

	// The image layer of the video. If you do not pass this parameter, 0 will be used.
	ZOrder *uint64 `json:"ZOrder,omitnil,omitempty" name:"ZOrder"`

	// The rendering mode of the video. 0 (the video is scaled and the excess parts are cropped), 1 (the video is scaled), 2 (the video is scaled and the blank spaces are filled with black bars). If you do not pass this parameter, 0 will be used.
	RenderMode *uint64 `json:"RenderMode,omitnil,omitempty" name:"RenderMode"`

	// (Not supported yet) The background color of a video. Below are the values for some commonly used colors:
	// Red: `0xcc0033`
	// Yellow: `0xcc9900`
	// Green: `0xcccc33`
	// Blue: `0x99CCFF`
	// Black: `0x000000`
	// White: `0xFFFFFF`
	// Grey: `0x999999`
	BackGroundColor *string `json:"BackGroundColor,omitnil,omitempty" name:"BackGroundColor"`

	// The URL of the background image for the video. This parameter allows you to specify an image to display when the user’s camera is turned off or before the user enters the room. If the dimensions of the image specified are different from those of the video window, the image will be stretched to fit the space. This parameter has a higher priority than `BackGroundColor`.
	BackgroundImageUrl *string `json:"BackgroundImageUrl,omitnil,omitempty" name:"BackgroundImageUrl"`

	// Custom cropping.
	CustomCrop *McuCustomCrop `json:"CustomCrop,omitnil,omitempty" name:"CustomCrop"`

	// The display mode of the sub-background image during output: 0 for cropping, 1 for scaling and displaying the background, 2 for scaling and displaying the black background, 3 for proportional scaling. If not filled in, the default is 3.
	BackgroundRenderMode *uint64 `json:"BackgroundRenderMode,omitnil,omitempty" name:"BackgroundRenderMode"`
}

type McuLayoutParams 

type McuLayoutParams struct {
	// The layout mode. Valid values: 1 (floating), 2 (screen sharing), 3 (grid), 4 (custom). Floating, screen sharing, and grid are dynamic layouts. Custom layouts are static layouts.
	MixLayoutMode *uint64 `json:"MixLayoutMode,omitnil,omitempty" name:"MixLayoutMode"`

	// Whether to display users who publish only audio. 0: No; 1: Yes. This parameter is valid only if a dynamic layout is used. If you do not pass this parameter, 0 will be used.
	PureAudioHoldPlaceMode *uint64 `json:"PureAudioHoldPlaceMode,omitnil,omitempty" name:"PureAudioHoldPlaceMode"`

	// The details of a custom layout.
	MixLayoutList []*McuLayout `json:"MixLayoutList,omitnil,omitempty" name:"MixLayoutList"`

	// The information of the large video in screen sharing or floating layout mode.
	MaxVideoUser *MaxVideoUser `json:"MaxVideoUser,omitnil,omitempty" name:"MaxVideoUser"`

	// The image fill mode. This parameter is valid if the layout mode is screen sharing, floating, or grid. `0`: The image will be cropped. `1`: The image will be scaled. `2`: The image will be scaled and there may be black bars.
	RenderMode *uint64 `json:"RenderMode,omitnil,omitempty" name:"RenderMode"`
}

type McuLayoutVolume 

type McuLayoutVolume struct {
	// The application data, which will be embedded in the `app_data` field of the custom SEI. It must be shorter than 4,096 characters.
	AppData *string `json:"AppData,omitnil,omitempty" name:"AppData"`

	// The payload type of the SEI message. The default is 100. Value range: 100-254 (244 is used internally by Tencent Cloud for timestamps).
	PayloadType *uint64 `json:"PayloadType,omitnil,omitempty" name:"PayloadType"`

	// The SEI sending interval (milliseconds). The default value is 1000.
	Interval *uint64 `json:"Interval,omitnil,omitempty" name:"Interval"`

	// Valid values: `1`: SEI is guaranteed when keyframes are sent; `0` (default): SEI is not guaranteed when keyframes are sent.
	FollowIdr *uint64 `json:"FollowIdr,omitnil,omitempty" name:"FollowIdr"`
}

type McuPassThrough 

type McuPassThrough struct {
	// The payload of the pass-through SEI.
	PayloadContent *string `json:"PayloadContent,omitnil,omitempty" name:"PayloadContent"`

	// The payload type of the SEI message. Value range: 5 and 100-254 (244 is used internally by Tencent Cloud for timestamps).
	PayloadType *uint64 `json:"PayloadType,omitnil,omitempty" name:"PayloadType"`

	// This parameter is required only if `PayloadType` is 5. It must be a 32-character hexadecimal string. If `PayloadType` is not 5, this parameter will be ignored.
	PayloadUuid *string `json:"PayloadUuid,omitnil,omitempty" name:"PayloadUuid"`

	// The SEI sending interval (milliseconds). The default value is 1000.
	Interval *uint64 `json:"Interval,omitnil,omitempty" name:"Interval"`

	// Valid values: `1`: SEI is guaranteed when keyframes are sent; `0` (default): SEI is not guaranteed when keyframes are sent.
	FollowIdr *uint64 `json:"FollowIdr,omitnil,omitempty" name:"FollowIdr"`
}

type McuPublishCdnParam 

type McuPublishCdnParam struct {
	// The URLs of the CDNs to relay to.
	PublishCdnUrl *string `json:"PublishCdnUrl,omitnil,omitempty" name:"PublishCdnUrl"`

	// Whether to relay to Tencent Cloud’s CDN. `0`: Third-party CDN; `1` (default): Tencent Cloud’s CDN. Relaying to a third-party CDN will incur fees. To avoid unexpected charges, we recommend you pass in a specific value. For details, see the API document.
	IsTencentCdn *uint64 `json:"IsTencentCdn,omitnil,omitempty" name:"IsTencentCdn"`
}

type McuSeiParams 

type McuSeiParams struct {
	// The audio volume layout SEI.
	LayoutVolume *McuLayoutVolume `json:"LayoutVolume,omitnil,omitempty" name:"LayoutVolume"`

	// The pass-through SEI.
	PassThrough *McuPassThrough `json:"PassThrough,omitnil,omitempty" name:"PassThrough"`
}

type McuUserInfoParams 

type McuUserInfoParams struct {
	// The user information.
	UserInfo *MixUserInfo `json:"UserInfo,omitnil,omitempty" name:"UserInfo"`
}

type McuVideoParams 

type McuVideoParams struct {
	// The video encoding parameters.
	VideoEncode *VideoEncode `json:"VideoEncode,omitnil,omitempty" name:"VideoEncode"`

	// The layout parameters.
	LayoutParams *McuLayoutParams `json:"LayoutParams,omitnil,omitempty" name:"LayoutParams"`

	// The canvas color. Below are the values for some common colors:
	// Red: 0xcc0033
	// Yellow: 0xcc9900
	// Green: 0xcccc33
	// Blue: 0x99CCFF
	// Black: 0x000000
	// White: 0xFFFFFF
	// Grey: 0x999999
	BackGroundColor *string `json:"BackGroundColor,omitnil,omitempty" name:"BackGroundColor"`

	// The URL of the background image for the canvas. This parameter has a higher priority than `BackGroundColor`.
	BackgroundImageUrl *string `json:"BackgroundImageUrl,omitnil,omitempty" name:"BackgroundImageUrl"`

	// The watermark information for the mixed stream.
	WaterMarkList []*McuWaterMarkParams `json:"WaterMarkList,omitnil,omitempty" name:"WaterMarkList"`

	// Background image display mode during output: 0 for crop, 1 for scale and display with black background, 2 for proportional scaling. The backend default is proportional scaling.
	BackgroundRenderMode *uint64 `json:"BackgroundRenderMode,omitnil,omitempty" name:"BackgroundRenderMode"`
}

type McuWaterMarkImage 

type McuWaterMarkImage struct {
	// The URL of the watermark image, which must be in PNG, JPG, or JPEG format and cannot exceed 5 MB.
	WaterMarkUrl *string `json:"WaterMarkUrl,omitnil,omitempty" name:"WaterMarkUrl"`

	// The watermark width (pixels).
	WaterMarkWidth *uint64 `json:"WaterMarkWidth,omitnil,omitempty" name:"WaterMarkWidth"`

	// The watermark height (pixels).
	WaterMarkHeight *uint64 `json:"WaterMarkHeight,omitnil,omitempty" name:"WaterMarkHeight"`

	// The horizontal offset (pixels) of the watermark.
	LocationX *uint64 `json:"LocationX,omitnil,omitempty" name:"LocationX"`

	// The vertical offset (pixels) of the watermark.
	LocationY *uint64 `json:"LocationY,omitnil,omitempty" name:"LocationY"`

	// The image layer of the watermark. If you do not pass this parameter, 0 will be used.
	ZOrder *uint64 `json:"ZOrder,omitnil,omitempty" name:"ZOrder"`
}

type McuWaterMarkParams 

type McuWaterMarkParams struct {
	// The watermark type. Valid values: `0` (default): Image; `1`: Text.
	WaterMarkType *uint64 `json:"WaterMarkType,omitnil,omitempty" name:"WaterMarkType"`

	// The watermark image information. This parameter is required if `WaterMarkType` is 0.
	WaterMarkImage *McuWaterMarkImage `json:"WaterMarkImage,omitnil,omitempty" name:"WaterMarkImage"`

	// The text watermark configuration. This parameter is required if `WaterMarkType` is `1`.
	WaterMarkText *McuWaterMarkText `json:"WaterMarkText,omitnil,omitempty" name:"WaterMarkText"`
}

type McuWaterMarkText 

type McuWaterMarkText struct {
	// The text.
	Text *string `json:"Text,omitnil,omitempty" name:"Text"`

	// The watermark width (pixels).
	WaterMarkWidth *uint64 `json:"WaterMarkWidth,omitnil,omitempty" name:"WaterMarkWidth"`

	// The watermark height (pixels).
	WaterMarkHeight *uint64 `json:"WaterMarkHeight,omitnil,omitempty" name:"WaterMarkHeight"`

	// The horizontal offset (pixels) of the watermark.
	LocationX *uint64 `json:"LocationX,omitnil,omitempty" name:"LocationX"`

	// The vertical offset (pixels) of the watermark.
	LocationY *uint64 `json:"LocationY,omitnil,omitempty" name:"LocationY"`

	// The font size.
	FontSize *uint64 `json:"FontSize,omitnil,omitempty" name:"FontSize"`

	// The text color. The default color is white. Values for some commonly used colors: Red: `0xcc0033`; yellow: `0xcc9900`; green: `0xcccc33`; blue: `0x99CCFF`; black: `0x000000`; white: `0xFFFFFF`; gray: `0x999999`.
	FontColor *string `json:"FontColor,omitnil,omitempty" name:"FontColor"`

	// The text fill color. If you do not specify this parameter, the fill color will be transparent. Values for some commonly used colors: Red: `0xcc0033`; yellow: `0xcc9900`; green: `0xcccc33`; blue: `0x99CCFF`; black: `0x000000`; white: `0xFFFFFF`; gray: `0x999999`.
	BackGroundColor *string `json:"BackGroundColor,omitnil,omitempty" name:"BackGroundColor"`
}

type MixLayout 

type MixLayout struct {
	// The Y axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas height.
	Top *uint64 `json:"Top,omitnil,omitempty" name:"Top"`

	// The X axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas width.
	Left *uint64 `json:"Left,omitnil,omitempty" name:"Left"`

	// The relative width of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Left` cannot exceed the canvas width.
	Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"`

	// The relative height of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Top` cannot exceed the canvas height.
	Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"`

	// The user ID (string) of the anchor whose video is shown in the window. If you do not set this parameter, anchors’ videos will be shown in their room entry sequence.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The degree of transparency of the canvas. Value range: [0, 255]. 0 means fully opaque, and 255 means fully transparent.
	Alpha *uint64 `json:"Alpha,omitnil,omitempty" name:"Alpha"`

	// 0: Stretch. In this mode, the image is stretched to fill the space available. The whole image is visible after scaling. However, if the original aspect ratio is different from the target, the image may be distorted.
	//
	// 1: Crop (default). In this mode, if the original aspect ratio is different from the target, the image will be cropped according to the target before being stretched to fill the space available. The image will not be distorted.
	//
	// 2: Blank. This mode stretches the image while keeping its original aspect ratio. If the original aspect ratio is different from the target, there may be blank spaces to the top and bottom or to the left and right of the window.
	//
	// 3: Smart stretch. This mode is similar to the crop mode, except that it restricts cropping to 20% of the image’s width or height at most.
	RenderMode *uint64 `json:"RenderMode,omitnil,omitempty" name:"RenderMode"`

	// The type of the stream subscribed to.
	// 0: Primary stream (default)
	// 1: Substream
	MediaId *uint64 `json:"MediaId,omitnil,omitempty" name:"MediaId"`

	// The image layer. 0 is the default value and means the bottommost layer.
	ImageLayer *uint64 `json:"ImageLayer,omitnil,omitempty" name:"ImageLayer"`

	// The URL of the background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of `RenderMode`.
	SubBackgroundImage *string `json:"SubBackgroundImage,omitnil,omitempty" name:"SubBackgroundImage"`
}

type MixLayoutParams 

type MixLayoutParams struct {
	// Layout mode:
	// 1: Floating
	// 2: Screen sharing
	// 3: Grid (default)
	// 4: Custom
	//
	// Floating: By default, the video of the first anchor (you can also specify an anchor) who enters the room is scaled to fill the screen. When other anchors enter the room, their videos appear smaller and are superimposed over the large video from left to right starting from the bottom of the canvas according to their room entry sequence. If the total number of videos is 17 or less, there will be four windows in each row (4 x 4); if it is greater than 17, there will be five windows in each row (5 x 5). Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window.
	//
	// Screen sharing: The video of a specified anchor occupies a larger part of the canvas on the left side (if you do not specify an anchor, the left window will display the canvas background). The videos of other anchors are smaller and are positioned on the right side. If the total number of videos is 17 or less, the small videos are positioned from top to bottom in up to two columns on the right side, with eight videos per column at most. If there are more than 17 videos, the additional videos are positioned at the bottom of the canvas from left to right. Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window.
	//
	// Grid: The videos of anchors are scaled and positioned automatically according to the total number of anchors in a room. Each video has the same size. Up to 25 videos can be displayed.
	//
	// Custom: Specify the layout of videos by using the `MixLayoutList` parameter.
	MixLayoutMode *uint64 `json:"MixLayoutMode,omitnil,omitempty" name:"MixLayoutMode"`

	// The custom layout details. This parameter is valid if `MixLayoutMode` is set to `4`. Up to 25 videos can be displayed.
	MixLayoutList []*MixLayout `json:"MixLayoutList,omitnil,omitempty" name:"MixLayoutList"`

	// The background color, which is a hexadecimal value (starting with "#", followed by the color value) converted from an 8-bit RGB value. For example, the RGB value of orange is `R:255 G:165 B:0`, and its hexadecimal value is `#FFA500`. The default color is black.
	BackGroundColor *string `json:"BackGroundColor,omitnil,omitempty" name:"BackGroundColor"`

	// The user whose video is displayed in the big window. This parameter is valid if `MixLayoutMode` is set to `1` (floating) or `2` (screen sharing). If it is left empty, the first anchor entering the room is displayed in the big window in the floating mode and the canvas background is displayed in the screen sharing mode.
	MaxResolutionUserId *string `json:"MaxResolutionUserId,omitnil,omitempty" name:"MaxResolutionUserId"`

	// The stream type.
	// 0: Primary stream (default)
	// 1: Substream (screen sharing stream)
	// This parameter specifies the type of the stream displayed in the big window. If it appears in `MixLayoutList`, it indicates the type of the stream of a specified user.
	MediaId *uint64 `json:"MediaId,omitnil,omitempty" name:"MediaId"`

	// The URL of the background image, which cannot contain Chinese characters. The image must be in JPG or PNG format and cannot be larger than 5 MB.
	BackgroundImageUrl *string `json:"BackgroundImageUrl,omitnil,omitempty" name:"BackgroundImageUrl"`

	// `1` means to use placeholders, and `0` (default) means to not use placeholders. If this parameter is set to `1`, when a user is not publishing video, a placeholder image will be displayed in the window reserved for the user.
	PlaceHolderMode *uint64 `json:"PlaceHolderMode,omitnil,omitempty" name:"PlaceHolderMode"`

	// The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is defined the same as `RenderMode` in `MixLayoufList`.
	BackgroundImageRenderMode *uint64 `json:"BackgroundImageRenderMode,omitnil,omitempty" name:"BackgroundImageRenderMode"`

	// The URL of the background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of `RenderMode`.
	DefaultSubBackgroundImage *string `json:"DefaultSubBackgroundImage,omitnil,omitempty" name:"DefaultSubBackgroundImage"`

	// The watermark layout. Up to 25 watermarks are supported.
	WaterMarkList []*WaterMark `json:"WaterMarkList,omitnil,omitempty" name:"WaterMarkList"`

	// The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is invalid if a custom layout is used. It is defined the same as `RenderMode` in `MixLayoufList`.
	RenderMode *uint64 `json:"RenderMode,omitnil,omitempty" name:"RenderMode"`

	// This parameter is valid only if the screen sharing layout is used. If you set it to `1`, the large video window will appear on the right and the small window on the left. The default value is `0`.
	MaxResolutionUserAlign *uint64 `json:"MaxResolutionUserAlign,omitnil,omitempty" name:"MaxResolutionUserAlign"`
}

type MixTranscodeParams 

type MixTranscodeParams struct {
	// The video transcoding parameters for recording. If you set this parameter, you must specify all its fields. If you do not set it, the default will be used.
	VideoParams *VideoParams `json:"VideoParams,omitnil,omitempty" name:"VideoParams"`

	// The audio transcoding parameters for recording. If you set this parameter, you must specify all its fields. If you do not set it, the default will be used.
	AudioParams *AudioParams `json:"AudioParams,omitnil,omitempty" name:"AudioParams"`
}

type MixUserInfo 

type MixUserInfo struct {
	// User ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// If a dynamic layout is used, the value of this parameter should be the ID of the main room. If a custom layout is used, the value of this parameter should be the same as the room ID in `MixLayoutList`.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The type of the `RoomId` parameter. 0: integer; 1: string.
	RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"`
}

type ModifyCloudRecordingRequest 

type ModifyCloudRecordingRequest struct {
	*tchttp.BaseRequest

	// The `SDKAppID` of the room whose streams are recorded.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The unique ID of the recording task, which is returned after recording starts successfully.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// The new stream mixing layout to use.
	MixLayoutParams *MixLayoutParams `json:"MixLayoutParams,omitnil,omitempty" name:"MixLayoutParams"`

	// The allowlist/blocklist for stream subscription.
	SubscribeStreamUserIds *SubscribeStreamUserIds `json:"SubscribeStreamUserIds,omitnil,omitempty" name:"SubscribeStreamUserIds"`
}

func NewModifyCloudRecordingRequest 

func NewModifyCloudRecordingRequest() (request *ModifyCloudRecordingRequest)

func (*ModifyCloudRecordingRequest) FromJsonString 

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

func (r *ModifyCloudRecordingRequest) ToJsonString() string

type ModifyCloudRecordingRequestParams 

type ModifyCloudRecordingRequestParams struct {
	// The `SDKAppID` of the room whose streams are recorded.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The unique ID of the recording task, which is returned after recording starts successfully.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// The new stream mixing layout to use.
	MixLayoutParams *MixLayoutParams `json:"MixLayoutParams,omitnil,omitempty" name:"MixLayoutParams"`

	// The allowlist/blocklist for stream subscription.
	SubscribeStreamUserIds *SubscribeStreamUserIds `json:"SubscribeStreamUserIds,omitnil,omitempty" name:"SubscribeStreamUserIds"`
}

Predefined struct for user

type ModifyCloudRecordingResponse 

type ModifyCloudRecordingResponse struct {
	*tchttp.BaseResponse
	Response *ModifyCloudRecordingResponseParams `json:"Response"`
}

func NewModifyCloudRecordingResponse 

func NewModifyCloudRecordingResponse() (response *ModifyCloudRecordingResponse)

func (*ModifyCloudRecordingResponse) FromJsonString 

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

func (r *ModifyCloudRecordingResponse) ToJsonString() string

type ModifyCloudRecordingResponseParams 

type ModifyCloudRecordingResponseParams struct {
	// The task ID assigned by the recording service, which uniquely identifies a recording process and becomes invalid after a recording task ends.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type QualityData 

type QualityData struct {
	// The quality data.
	Content []*TimeValue `json:"Content,omitnil,omitempty" name:"Content"`

	// The user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The remote user ID. An empty string indicates that the data is upstream data.
	// Note: This field may return null, indicating that no valid values can be obtained.
	PeerId *string `json:"PeerId,omitnil,omitempty" name:"PeerId"`

	// The data type.
	DataType *string `json:"DataType,omitnil,omitempty" name:"DataType"`
}

type RecordParams 

type RecordParams struct {
	// The recording mode.
	// 1: Single-stream recording. Records the audio and video of each subscribed user (`UserId`) in a room and saves the recording files to the cloud.
	// 2: Mixed-stream recording. Mixes the audios and videos of subscribed users (`UserId`) in a room, records the mixed stream, and saves the recording files to the cloud.
	RecordMode *uint64 `json:"RecordMode,omitnil,omitempty" name:"RecordMode"`

	// The time period (seconds) to wait to automatically stop recording after there are no anchors (users who publish streams) in a room. Value range: 5-86400 (max 24 hours). Default value: 30.
	MaxIdleTime *uint64 `json:"MaxIdleTime,omitnil,omitempty" name:"MaxIdleTime"`

	// The media type of the streams to record.
	// 0: Audio and video streams (default)
	// 1: Audio streams only
	// 2: Video streams only
	StreamType *uint64 `json:"StreamType,omitnil,omitempty" name:"StreamType"`

	// The allowlist/blocklist for stream subscription.
	SubscribeStreamUserIds *SubscribeStreamUserIds `json:"SubscribeStreamUserIds,omitnil,omitempty" name:"SubscribeStreamUserIds"`

	// The output format. `0` (default): HLS; `1`: HLS + MP4; `2`: HLS + AAC;  `3` : MP4,  `4` : AAC. This parameter is invalid if you save recording files to VOD. To specify the format of files saved to VOD, use `MediaType` of `TencentVod`.
	OutputFormat *uint64 `json:"OutputFormat,omitnil,omitempty" name:"OutputFormat"`

	// Whether to merge the audio and video of a user in the single-stream recording mode. 0 (default): Do not mix the audio and video; 1: Mix the audio and video into one TS file. You don’t need to specify this parameter for mixed-stream recording, which merges audios and videos by default.
	AvMerge *uint64 `json:"AvMerge,omitnil,omitempty" name:"AvMerge"`

	// The maximum file duration allowed (minutes). If the output format is AAC or MP4, and the maximum file duration is exceeded, the file will be segmented. Value range: 1-1440. Default value: 1440 (24 hours). The maximum file size allowed is 2 GB. If the file size exceeds 2 GB, or the file duration exceeds 24 hours, the file will also be segmented.
	// This parameter is invalid if the output format is HLS.
	MaxMediaFileDuration *uint64 `json:"MaxMediaFileDuration,omitnil,omitempty" name:"MaxMediaFileDuration"`

	// The type of stream to record. `0` (default): The primary stream and substream; `1`: The primary stream; `2`: The substream.
	MediaId *uint64 `json:"MediaId,omitnil,omitempty" name:"MediaId"`
}

type RemoveUserByStrRoomIdRequest 

type RemoveUserByStrRoomIdRequest struct {
	*tchttp.BaseRequest

	// `SDKAppId` of TRTC
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

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

	// List of up to 10 users to be removed
	UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"`
}

func NewRemoveUserByStrRoomIdRequest 

func NewRemoveUserByStrRoomIdRequest() (request *RemoveUserByStrRoomIdRequest)

func (*RemoveUserByStrRoomIdRequest) FromJsonString 

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

func (r *RemoveUserByStrRoomIdRequest) ToJsonString() string

type RemoveUserByStrRoomIdRequestParams 

type RemoveUserByStrRoomIdRequestParams struct {
	// `SDKAppId` of TRTC
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

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

	// List of up to 10 users to be removed
	UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"`
}

Predefined struct for user

type RemoveUserByStrRoomIdResponse 

type RemoveUserByStrRoomIdResponse struct {
	*tchttp.BaseResponse
	Response *RemoveUserByStrRoomIdResponseParams `json:"Response"`
}

func NewRemoveUserByStrRoomIdResponse 

func NewRemoveUserByStrRoomIdResponse() (response *RemoveUserByStrRoomIdResponse)

func (*RemoveUserByStrRoomIdResponse) FromJsonString 

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

func (r *RemoveUserByStrRoomIdResponse) ToJsonString() string

type RemoveUserByStrRoomIdResponseParams 

type RemoveUserByStrRoomIdResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type RemoveUserRequest 

type RemoveUserRequest struct {
	*tchttp.BaseRequest

	// `SDKAppId` of TRTC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Room number.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// List of up to 10 users to be removed.
	UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"`
}

func NewRemoveUserRequest 

func NewRemoveUserRequest() (request *RemoveUserRequest)

func (*RemoveUserRequest) FromJsonString 

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

func (r *RemoveUserRequest) ToJsonString() string

type RemoveUserRequestParams 

type RemoveUserRequestParams struct {
	// `SDKAppId` of TRTC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Room number.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// List of up to 10 users to be removed.
	UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"`
}

Predefined struct for user

type RemoveUserResponse 

type RemoveUserResponse struct {
	*tchttp.BaseResponse
	Response *RemoveUserResponseParams `json:"Response"`
}

func NewRemoveUserResponse 

func NewRemoveUserResponse() (response *RemoveUserResponse)

func (*RemoveUserResponse) FromJsonString 

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

func (r *RemoveUserResponse) ToJsonString() string

type RemoveUserResponseParams 

type RemoveUserResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type RoomState 

type RoomState struct {
	// The call ID, which uniquely identifies a call.
	CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"`

	// The room ID.
	RoomString *string `json:"RoomString,omitnil,omitempty" name:"RoomString"`

	// The room creation time.
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// The room termination time.
	DestroyTime *uint64 `json:"DestroyTime,omitnil,omitempty" name:"DestroyTime"`

	// Whether the room is terminated.
	IsFinished *bool `json:"IsFinished,omitnil,omitempty" name:"IsFinished"`

	// The user ID of the room creator.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

type RowValues 

type RowValues struct {
	// Data value
	RowValue []*int64 `json:"RowValue,omitnil,omitempty" name:"RowValue"`
}

type ScaleInfomation 

type ScaleInfomation struct {
	// Start time for each day
	Time *uint64 `json:"Time,omitnil,omitempty" name:"Time"`

	// The number of users. If a user enters a room multiple times, it will be counted as one user.
	// Note: This field may return null, indicating that no valid values can be obtained.
	UserNumber *uint64 `json:"UserNumber,omitnil,omitempty" name:"UserNumber"`

	// The number of room entries. Every time a user enters a room, it will be counted as one room entry.
	// Note: This field may return null, indicating that no valid values can be obtained.
	UserCount *uint64 `json:"UserCount,omitnil,omitempty" name:"UserCount"`

	// The total number of rooms of the application on a day.
	// Note: This field may return null, indicating that no valid values can be obtained.
	RoomNumbers *uint64 `json:"RoomNumbers,omitnil,omitempty" name:"RoomNumbers"`
}

type SeriesInfos 

type SeriesInfos struct {
	// Data columns
	Columns []*string `json:"Columns,omitnil,omitempty" name:"Columns"`

	// Data values
	Values []*RowValues `json:"Values,omitnil,omitempty" name:"Values"`
}

type SetUserBlockedByStrRoomIdRequest 

type SetUserBlockedByStrRoomIdRequest struct {
	*tchttp.BaseRequest

	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The room ID (string).
	StrRoomId *string `json:"StrRoomId,omitnil,omitempty" name:"StrRoomId"`

	// The user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Whether to disable the user’s audio and video. 0: Enable; 1: Disable.
	IsMute *uint64 `json:"IsMute,omitnil,omitempty" name:"IsMute"`
}

func NewSetUserBlockedByStrRoomIdRequest 

func NewSetUserBlockedByStrRoomIdRequest() (request *SetUserBlockedByStrRoomIdRequest)

func (*SetUserBlockedByStrRoomIdRequest) FromJsonString 

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

func (r *SetUserBlockedByStrRoomIdRequest) ToJsonString() string

type SetUserBlockedByStrRoomIdRequestParams 

type SetUserBlockedByStrRoomIdRequestParams struct {
	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The room ID (string).
	StrRoomId *string `json:"StrRoomId,omitnil,omitempty" name:"StrRoomId"`

	// The user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Whether to disable the user’s audio and video. 0: Enable; 1: Disable.
	IsMute *uint64 `json:"IsMute,omitnil,omitempty" name:"IsMute"`
}

Predefined struct for user

type SetUserBlockedByStrRoomIdResponse 

type SetUserBlockedByStrRoomIdResponse struct {
	*tchttp.BaseResponse
	Response *SetUserBlockedByStrRoomIdResponseParams `json:"Response"`
}

func NewSetUserBlockedByStrRoomIdResponse 

func NewSetUserBlockedByStrRoomIdResponse() (response *SetUserBlockedByStrRoomIdResponse)

func (*SetUserBlockedByStrRoomIdResponse) FromJsonString 

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

func (r *SetUserBlockedByStrRoomIdResponse) ToJsonString() string

type SetUserBlockedByStrRoomIdResponseParams 

type SetUserBlockedByStrRoomIdResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type SetUserBlockedRequest 

type SetUserBlockedRequest struct {
	*tchttp.BaseRequest

	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The room ID (number).
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Whether to disable the user’s audio and video. 0: Enable; 1: Disable.
	IsMute *uint64 `json:"IsMute,omitnil,omitempty" name:"IsMute"`
}

func NewSetUserBlockedRequest 

func NewSetUserBlockedRequest() (request *SetUserBlockedRequest)

func (*SetUserBlockedRequest) FromJsonString 

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

func (r *SetUserBlockedRequest) ToJsonString() string

type SetUserBlockedRequestParams 

type SetUserBlockedRequestParams struct {
	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The room ID (number).
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Whether to disable the user’s audio and video. 0: Enable; 1: Disable.
	IsMute *uint64 `json:"IsMute,omitnil,omitempty" name:"IsMute"`
}

Predefined struct for user

type SetUserBlockedResponse 

type SetUserBlockedResponse struct {
	*tchttp.BaseResponse
	Response *SetUserBlockedResponseParams `json:"Response"`
}

func NewSetUserBlockedResponse 

func NewSetUserBlockedResponse() (response *SetUserBlockedResponse)

func (*SetUserBlockedResponse) FromJsonString 

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

func (r *SetUserBlockedResponse) ToJsonString() string

type SetUserBlockedResponseParams 

type SetUserBlockedResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type SingleSubscribeParams 

type SingleSubscribeParams struct {
	// The stream information.
	UserMediaStream *UserMediaStream `json:"UserMediaStream,omitnil,omitempty" name:"UserMediaStream"`
}

type StartPublishCdnStreamRequest 

type StartPublishCdnStreamRequest struct {
	*tchttp.BaseRequest

	// The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The ID of the room whose streams are relayed (the main room).
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The type of the `RoomId` parameter, which must be the same as the ID type of the room whose streams are relayed. 0: integer; 1: string.
	RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"`

	// The information of the relaying robot in the room.
	AgentParams *AgentParams `json:"AgentParams,omitnil,omitempty" name:"AgentParams"`

	// Whether to transcode the streams. `0`: No. `1`: Yes. This parameter determines whether transcoding fees are charged. If it is `0`, streams will only be relayed, and no transcoding fees will be incurred. If it is `1`, streams will be transcoded before being relayed, and transcoding fees will be incurred.
	WithTranscoding *uint64 `json:"WithTranscoding,omitnil,omitempty" name:"WithTranscoding"`

	// The audio encoding parameters. Because audio is always transcoded (no fees are incurred), this parameter is required when you start a relay task.
	AudioParams *McuAudioParams `json:"AudioParams,omitnil,omitempty" name:"AudioParams"`

	// The video encoding parameters for relaying. If you do not pass this parameter, only audio will be relayed.
	VideoParams *McuVideoParams `json:"VideoParams,omitnil,omitempty" name:"VideoParams"`

	// The information of a single stream relayed. When you relay a single stream, set `WithTranscoding` to 0.
	SingleSubscribeParams *SingleSubscribeParams `json:"SingleSubscribeParams,omitnil,omitempty" name:"SingleSubscribeParams"`

	// The information of the CDNs to relay to. You need to specify at least one between this parameter and `FeedBackRoomParams.N`.
	PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"`

	// The stream mixing SEI parameters.
	SeiParams *McuSeiParams `json:"SeiParams,omitnil,omitempty" name:"SeiParams"`

	// The information of the room to which streams are relayed. Between this parameter and `PublishCdnParams`, you must specify at least one. Please note that relaying to a TRTC room is only supported in some SDK versions. For details, please contact technical support.
	FeedBackRoomParams []*McuFeedBackRoomParams `json:"FeedBackRoomParams,omitnil,omitempty" name:"FeedBackRoomParams"`
}

func NewStartPublishCdnStreamRequest 

func NewStartPublishCdnStreamRequest() (request *StartPublishCdnStreamRequest)

func (*StartPublishCdnStreamRequest) FromJsonString 

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

func (r *StartPublishCdnStreamRequest) ToJsonString() string

type StartPublishCdnStreamRequestParams 

type StartPublishCdnStreamRequestParams struct {
	// The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The ID of the room whose streams are relayed (the main room).
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The type of the `RoomId` parameter, which must be the same as the ID type of the room whose streams are relayed. 0: integer; 1: string.
	RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"`

	// The information of the relaying robot in the room.
	AgentParams *AgentParams `json:"AgentParams,omitnil,omitempty" name:"AgentParams"`

	// Whether to transcode the streams. `0`: No. `1`: Yes. This parameter determines whether transcoding fees are charged. If it is `0`, streams will only be relayed, and no transcoding fees will be incurred. If it is `1`, streams will be transcoded before being relayed, and transcoding fees will be incurred.
	WithTranscoding *uint64 `json:"WithTranscoding,omitnil,omitempty" name:"WithTranscoding"`

	// The audio encoding parameters. Because audio is always transcoded (no fees are incurred), this parameter is required when you start a relay task.
	AudioParams *McuAudioParams `json:"AudioParams,omitnil,omitempty" name:"AudioParams"`

	// The video encoding parameters for relaying. If you do not pass this parameter, only audio will be relayed.
	VideoParams *McuVideoParams `json:"VideoParams,omitnil,omitempty" name:"VideoParams"`

	// The information of a single stream relayed. When you relay a single stream, set `WithTranscoding` to 0.
	SingleSubscribeParams *SingleSubscribeParams `json:"SingleSubscribeParams,omitnil,omitempty" name:"SingleSubscribeParams"`

	// The information of the CDNs to relay to. You need to specify at least one between this parameter and `FeedBackRoomParams.N`.
	PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"`

	// The stream mixing SEI parameters.
	SeiParams *McuSeiParams `json:"SeiParams,omitnil,omitempty" name:"SeiParams"`

	// The information of the room to which streams are relayed. Between this parameter and `PublishCdnParams`, you must specify at least one. Please note that relaying to a TRTC room is only supported in some SDK versions. For details, please contact technical support.
	FeedBackRoomParams []*McuFeedBackRoomParams `json:"FeedBackRoomParams,omitnil,omitempty" name:"FeedBackRoomParams"`
}

Predefined struct for user

type StartPublishCdnStreamResponse 

type StartPublishCdnStreamResponse struct {
	*tchttp.BaseResponse
	Response *StartPublishCdnStreamResponseParams `json:"Response"`
}

func NewStartPublishCdnStreamResponse 

func NewStartPublishCdnStreamResponse() (response *StartPublishCdnStreamResponse)

func (*StartPublishCdnStreamResponse) FromJsonString 

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

func (r *StartPublishCdnStreamResponse) ToJsonString() string

type StartPublishCdnStreamResponseParams 

type StartPublishCdnStreamResponseParams struct {
	// The task ID, which is generated by the Tencent Cloud server. You need to pass in the task ID when making a request to update or stop a relaying task.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StartStreamIngestRequest 

type StartStreamIngestRequest struct {
	*tchttp.BaseRequest

	// TRTC's [SdkAppId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#sdkappid), the same as the SdkAppId corresponding to the Record room.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// TRTC's [RoomId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#roomid), the RoomId corresponding to the Record TRTC room.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Type of TRTC RoomId. 【*Note】Must be the same as the RoomId type corresponding to the Record room: 0: String type RoomId 1: 32-bit Integer type RoomId (default)
	RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"`

	// UserId of the Pull stream Relay Robot, used to enter the room and initiate the Pull stream Relay Task.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// UserSig corresponding to the Pull stream Relay Robot UserId, i.e., UserId and UserSig are equivalent to the Robot's Login password for entering the room. For the specific Calculation method, please refer to the TRTC [UserSig](https://intl.cloud.tencent.com/document/product/647/45910?from_cn_redirect=1#UserSig) Scheme.
	UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"`

	//
	// Source URL. Example value: https://a.b/test.mp4
	SourceUrl []*string `json:"SourceUrl,omitnil,omitempty" name:"SourceUrl"`

	// TRTC room permission Encryption ticket, only needed when advanced permission control is enabled in the Console. After enabling advanced permission control in the TRTC Console, TRTC's backend service system will verify a so-called [PrivateMapKey] 'Permission ticket', which contains an encrypted RoomId and an encrypted 'Permission bit list'. Since PrivateMapKey contains RoomId, providing only UserSig without PrivateMapKey does not allow entry into the specified room.
	PrivateMapKey *string `json:"PrivateMapKey,omitnil,omitempty" name:"PrivateMapKey"`

	// Video Codec Parameters. Optional, if not filled, Keep original stream Parameters.
	VideoEncodeParams *VideoEncodeParams `json:"VideoEncodeParams,omitnil,omitempty" name:"VideoEncodeParams"`

	// Audio Codec Parameters. Optional, if not filled, Keep original stream Parameters.
	AudioEncodeParams *AudioEncodeParams `json:"AudioEncodeParams,omitnil,omitempty" name:"AudioEncodeParams"`
}

func NewStartStreamIngestRequest 

func NewStartStreamIngestRequest() (request *StartStreamIngestRequest)

func (*StartStreamIngestRequest) FromJsonString 

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

func (r *StartStreamIngestRequest) ToJsonString() string

type StartStreamIngestRequestParams 

type StartStreamIngestRequestParams struct {
	// TRTC's [SdkAppId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#sdkappid), the same as the SdkAppId corresponding to the Record room.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// TRTC's [RoomId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#roomid), the RoomId corresponding to the Record TRTC room.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Type of TRTC RoomId. 【*Note】Must be the same as the RoomId type corresponding to the Record room: 0: String type RoomId 1: 32-bit Integer type RoomId (default)
	RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"`

	// UserId of the Pull stream Relay Robot, used to enter the room and initiate the Pull stream Relay Task.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// UserSig corresponding to the Pull stream Relay Robot UserId, i.e., UserId and UserSig are equivalent to the Robot's Login password for entering the room. For the specific Calculation method, please refer to the TRTC [UserSig](https://intl.cloud.tencent.com/document/product/647/45910?from_cn_redirect=1#UserSig) Scheme.
	UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"`

	//
	// Source URL. Example value: https://a.b/test.mp4
	SourceUrl []*string `json:"SourceUrl,omitnil,omitempty" name:"SourceUrl"`

	// TRTC room permission Encryption ticket, only needed when advanced permission control is enabled in the Console. After enabling advanced permission control in the TRTC Console, TRTC's backend service system will verify a so-called [PrivateMapKey] 'Permission ticket', which contains an encrypted RoomId and an encrypted 'Permission bit list'. Since PrivateMapKey contains RoomId, providing only UserSig without PrivateMapKey does not allow entry into the specified room.
	PrivateMapKey *string `json:"PrivateMapKey,omitnil,omitempty" name:"PrivateMapKey"`

	// Video Codec Parameters. Optional, if not filled, Keep original stream Parameters.
	VideoEncodeParams *VideoEncodeParams `json:"VideoEncodeParams,omitnil,omitempty" name:"VideoEncodeParams"`

	// Audio Codec Parameters. Optional, if not filled, Keep original stream Parameters.
	AudioEncodeParams *AudioEncodeParams `json:"AudioEncodeParams,omitnil,omitempty" name:"AudioEncodeParams"`
}

Predefined struct for user

type StartStreamIngestResponse 

type StartStreamIngestResponse struct {
	*tchttp.BaseResponse
	Response *StartStreamIngestResponseParams `json:"Response"`
}

func NewStartStreamIngestResponse 

func NewStartStreamIngestResponse() (response *StartStreamIngestResponse)

func (*StartStreamIngestResponse) FromJsonString 

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

func (r *StartStreamIngestResponse) ToJsonString() string

type StartStreamIngestResponseParams 

type StartStreamIngestResponseParams struct {
	// The Task ID of the Pull stream Relay. The Task ID is a unique identifier for a Pull stream Relay lifecycle process, and it loses its meaning when the task ends. The Task ID needs to be saved by the business as a parameter for the next operation on this task.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StopPublishCdnStreamRequest 

type StopPublishCdnStreamRequest struct {
	*tchttp.BaseRequest

	// The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The task ID.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewStopPublishCdnStreamRequest 

func NewStopPublishCdnStreamRequest() (request *StopPublishCdnStreamRequest)

func (*StopPublishCdnStreamRequest) FromJsonString 

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

func (r *StopPublishCdnStreamRequest) ToJsonString() string

type StopPublishCdnStreamRequestParams 

type StopPublishCdnStreamRequestParams struct {
	// The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The task ID.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type StopPublishCdnStreamResponse 

type StopPublishCdnStreamResponse struct {
	*tchttp.BaseResponse
	Response *StopPublishCdnStreamResponseParams `json:"Response"`
}

func NewStopPublishCdnStreamResponse 

func NewStopPublishCdnStreamResponse() (response *StopPublishCdnStreamResponse)

func (*StopPublishCdnStreamResponse) FromJsonString 

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

func (r *StopPublishCdnStreamResponse) ToJsonString() string

type StopPublishCdnStreamResponseParams 

type StopPublishCdnStreamResponseParams struct {
	// The task ID.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StopStreamIngestRequest 

type StopStreamIngestRequest struct {
	*tchttp.BaseRequest

	// The SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the task's room.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The unique Task ID, which will be returned after the task is successfully started.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewStopStreamIngestRequest 

func NewStopStreamIngestRequest() (request *StopStreamIngestRequest)

func (*StopStreamIngestRequest) FromJsonString 

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

func (r *StopStreamIngestRequest) ToJsonString() string

type StopStreamIngestRequestParams 

type StopStreamIngestRequestParams struct {
	// The SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the task's room.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The unique Task ID, which will be returned after the task is successfully started.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type StopStreamIngestResponse 

type StopStreamIngestResponse struct {
	*tchttp.BaseResponse
	Response *StopStreamIngestResponseParams `json:"Response"`
}

func NewStopStreamIngestResponse 

func NewStopStreamIngestResponse() (response *StopStreamIngestResponse)

func (*StopStreamIngestResponse) FromJsonString 

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

func (r *StopStreamIngestResponse) ToJsonString() string

type StopStreamIngestResponseParams 

type StopStreamIngestResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StorageFile 

type StorageFile struct {
	// The user whose stream is recorded into the file. In the mixed-stream recording mode, this parameter will be empty.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

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

	// The type of the media recorded.
	// video
	// audio
	// audio_video
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	TrackType *string `json:"TrackType,omitnil,omitempty" name:"TrackType"`

	// The start time (Unix timestamp) of the recording file.
	BeginTimeStamp *uint64 `json:"BeginTimeStamp,omitnil,omitempty" name:"BeginTimeStamp"`
}

type StorageParams 

type StorageParams struct {
	// The account information for third-party storage. Please note that if you save files to COS, a recording-to-COS fee will be incurred. For details, see the document "Billing of On-Cloud Recording". If you save files to VOD, there won't be such a fee.
	CloudStorage *CloudStorage `json:"CloudStorage,omitnil,omitempty" name:"CloudStorage"`

	// The account information for VOD storage.
	CloudVod *CloudVod `json:"CloudVod,omitnil,omitempty" name:"CloudVod"`
}

type SubscribeStreamUserIds 

type SubscribeStreamUserIds struct {
	// The allowlist for audio subscription. For example, `["1", "2", "3"]` means to only subscribe to the audios of users 1, 2, and 3, and ["1.*$"] means to only subscribe to the audios of users whose ID prefix is `1`. If this parameter is left empty, the audios of all anchors in the room will be received. The array can contain at most 32 elements.
	SubscribeAudioUserIds []*string `json:"SubscribeAudioUserIds,omitnil,omitempty" name:"SubscribeAudioUserIds"`

	// The blocklist for audio subscription. For example, `["1", "2", "3"]` means to not subscribe to the audios of users 1, 2, and 3, and `["1.*$"]` means to not subscribe to users whose ID prefix is `1`. If this parameter is left empty, the audios of all anchors in the room will be received. The array can contain at most 32 elements.
	UnSubscribeAudioUserIds []*string `json:"UnSubscribeAudioUserIds,omitnil,omitempty" name:"UnSubscribeAudioUserIds"`

	// The allowlist for video subscription. For example, `["1", "2", "3"]` means to only subscribe to the videos of users 1, 2, and 3, and `["1.*$"]` means to only subscribe to the videos of users whose ID prefix is `1`. If this parameter is left empty, the videos of all anchors in the room will be received. The array can contain at most 32 elements.
	SubscribeVideoUserIds []*string `json:"SubscribeVideoUserIds,omitnil,omitempty" name:"SubscribeVideoUserIds"`

	// The blocklist for video subscription. For example, `["1", "2", "3"]` means to not subscribe to the videos of users 1, 2, and 3, and `["1.*$"]` means to not subscribe to the videos of users whose ID prefix is `1`. If this parameter is left empty, the videos of all anchors in the room will be received. The array can contain at most 32 elements.
	UnSubscribeVideoUserIds []*string `json:"UnSubscribeVideoUserIds,omitnil,omitempty" name:"UnSubscribeVideoUserIds"`
}

type TRTCDataResult 

type TRTCDataResult struct {
	// StatementID value, fixed at 0 for Monitoring Dashboard.
	StatementID *int64 `json:"StatementID,omitnil,omitempty" name:"StatementID"`

	// Query result data, returned in Columns-Values format.
	Series []*SeriesInfos `json:"Series,omitnil,omitempty" name:"Series"`

	// Total value, fixed at 1 for Monitoring Dashboard.
	Total *int64 `json:"Total,omitnil,omitempty" name:"Total"`
}

type TencentVod 

type TencentVod struct {
	// The operation to perform on the media uploaded. The value of this parameter is the name of a task flow template. You can create a custom task flow template in Tencent Cloud VOD.
	Procedure *string `json:"Procedure,omitnil,omitempty" name:"Procedure"`

	// The expiration time of the media file, which is a time period (seconds) from the current time. For example, `86400` means to save the media file for one day. To save the file permanently, set this parameter to `0`.
	ExpireTime *uint64 `json:"ExpireTime,omitnil,omitempty" name:"ExpireTime"`

	// The storage region. Set this parameter if you have special requirements on the storage region.
	StorageRegion *string `json:"StorageRegion,omitnil,omitempty" name:"StorageRegion"`

	// The category ID, which is returned after you create a category by calling an API. You can use categories to manage media files.
	// The default value is `0`, which means others.
	ClassId *uint64 `json:"ClassId,omitnil,omitempty" name:"ClassId"`

	// The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.
	SubAppId *uint64 `json:"SubAppId,omitnil,omitempty" name:"SubAppId"`

	// The task flow context, which is passed through after the task is completed.
	SessionContext *string `json:"SessionContext,omitnil,omitempty" name:"SessionContext"`

	// The upload context, which is passed through after upload is completed.
	SourceContext *string `json:"SourceContext,omitnil,omitempty" name:"SourceContext"`

	// The format of recording files uploaded to VOD. `0` (default): MP4; `1`: HLS; `2`: AAC (valid only if `StreamType` is `1`); `3`: HLS+MP4; `4`: HLS+AAC.
	MediaType *uint64 `json:"MediaType,omitnil,omitempty" name:"MediaType"`

	// The custom prefix of recording files. This parameter is valid only if recording files are uploaded to VOD. It can contain letters, numbers, underscores, and hyphens and cannot exceed 64 bytes. This prefix and the automatically generated filename are connected with `__UserId_u_`.
	UserDefineRecordId *string `json:"UserDefineRecordId,omitnil,omitempty" name:"UserDefineRecordId"`
}

type TimeValue 

type TimeValue struct {
	// The UNIX timestamp (seconds), such as `1590065877`.
	Time *uint64 `json:"Time,omitnil,omitempty" name:"Time"`

	// The metric value. For example, if the video capturing frame rate (`bigvCapFps`) at the time `1590065877` is `0`, the value of this parameter will be `0`.
	Value *float64 `json:"Value,omitnil,omitempty" name:"Value"`
}

type TrtcUsage 

type TrtcUsage struct {
	// The time point in the format of `YYYY-MM-DD HH:mm:ss`. If more than one day is queried, `HH:mm:ss` is `00:00:00`.
	TimeKey *string `json:"TimeKey,omitnil,omitempty" name:"TimeKey"`

	// The usage (minutes). Each element of this parameter corresponds to an element of `UsageKey` in the order they are listed.
	UsageValue []*float64 `json:"UsageValue,omitnil,omitempty" name:"UsageValue"`
}

type UpdatePublishCdnStreamRequest 

type UpdatePublishCdnStreamRequest struct {
	*tchttp.BaseRequest

	// The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The task ID.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// The sequence of a request. This parameter ensures the requests to change the parameters of the same relaying task are in the correct order. It increases each time a new request is made.
	SequenceNumber *uint64 `json:"SequenceNumber,omitnil,omitempty" name:"SequenceNumber"`

	// Whether to transcode the streams. 0: No; 1: Yes.
	WithTranscoding *uint64 `json:"WithTranscoding,omitnil,omitempty" name:"WithTranscoding"`

	// Pass this parameter to change the users whose audios are mixed. If you do not pass this parameter, no changes will be made.
	AudioParams *McuAudioParams `json:"AudioParams,omitnil,omitempty" name:"AudioParams"`

	// Pass this parameter to change video parameters other than the codec, including the video layout, background image, background color, and watermark information. This parameter is valid only if streams are transcoded. If you do not pass it, no changes will be made.
	VideoParams *McuVideoParams `json:"VideoParams,omitnil,omitempty" name:"VideoParams"`

	// Pass this parameter to change the single stream that is relayed. This parameter is valid only if streams are not transcoded. If you do not pass this parameter, no changes will be made.
	SingleSubscribeParams *SingleSubscribeParams `json:"SingleSubscribeParams,omitnil,omitempty" name:"SingleSubscribeParams"`

	// Pass this parameter to change the CDNs to relay to. If you do not pass this parameter, no changes will be made.
	PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"`

	// The stream mixing SEI parameters.
	SeiParams *McuSeiParams `json:"SeiParams,omitnil,omitempty" name:"SeiParams"`

	// The information of the room to which streams are relayed.
	FeedBackRoomParams []*McuFeedBackRoomParams `json:"FeedBackRoomParams,omitnil,omitempty" name:"FeedBackRoomParams"`
}

func NewUpdatePublishCdnStreamRequest 

func NewUpdatePublishCdnStreamRequest() (request *UpdatePublishCdnStreamRequest)

func (*UpdatePublishCdnStreamRequest) FromJsonString 

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

func (r *UpdatePublishCdnStreamRequest) ToJsonString() string

type UpdatePublishCdnStreamRequestParams 

type UpdatePublishCdnStreamRequestParams struct {
	// The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The task ID.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// The sequence of a request. This parameter ensures the requests to change the parameters of the same relaying task are in the correct order. It increases each time a new request is made.
	SequenceNumber *uint64 `json:"SequenceNumber,omitnil,omitempty" name:"SequenceNumber"`

	// Whether to transcode the streams. 0: No; 1: Yes.
	WithTranscoding *uint64 `json:"WithTranscoding,omitnil,omitempty" name:"WithTranscoding"`

	// Pass this parameter to change the users whose audios are mixed. If you do not pass this parameter, no changes will be made.
	AudioParams *McuAudioParams `json:"AudioParams,omitnil,omitempty" name:"AudioParams"`

	// Pass this parameter to change video parameters other than the codec, including the video layout, background image, background color, and watermark information. This parameter is valid only if streams are transcoded. If you do not pass it, no changes will be made.
	VideoParams *McuVideoParams `json:"VideoParams,omitnil,omitempty" name:"VideoParams"`

	// Pass this parameter to change the single stream that is relayed. This parameter is valid only if streams are not transcoded. If you do not pass this parameter, no changes will be made.
	SingleSubscribeParams *SingleSubscribeParams `json:"SingleSubscribeParams,omitnil,omitempty" name:"SingleSubscribeParams"`

	// Pass this parameter to change the CDNs to relay to. If you do not pass this parameter, no changes will be made.
	PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"`

	// The stream mixing SEI parameters.
	SeiParams *McuSeiParams `json:"SeiParams,omitnil,omitempty" name:"SeiParams"`

	// The information of the room to which streams are relayed.
	FeedBackRoomParams []*McuFeedBackRoomParams `json:"FeedBackRoomParams,omitnil,omitempty" name:"FeedBackRoomParams"`
}

Predefined struct for user

type UpdatePublishCdnStreamResponse 

type UpdatePublishCdnStreamResponse struct {
	*tchttp.BaseResponse
	Response *UpdatePublishCdnStreamResponseParams `json:"Response"`
}

func NewUpdatePublishCdnStreamResponse 

func NewUpdatePublishCdnStreamResponse() (response *UpdatePublishCdnStreamResponse)

func (*UpdatePublishCdnStreamResponse) FromJsonString 

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

func (r *UpdatePublishCdnStreamResponse) ToJsonString() string

type UpdatePublishCdnStreamResponseParams 

type UpdatePublishCdnStreamResponseParams struct {
	// The task ID.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UserInformation 

type UserInformation struct {
	// The room ID.
	RoomStr *string `json:"RoomStr,omitnil,omitempty" name:"RoomStr"`

	// The user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The time when the user entered the room.
	JoinTs *uint64 `json:"JoinTs,omitnil,omitempty" name:"JoinTs"`

	// The time when the user left the room. If the user is still in the room, the current time will be returned.
	LeaveTs *uint64 `json:"LeaveTs,omitnil,omitempty" name:"LeaveTs"`

	// The device type.
	DeviceType *string `json:"DeviceType,omitnil,omitempty" name:"DeviceType"`

	// The SDK version number.
	SdkVersion *string `json:"SdkVersion,omitnil,omitempty" name:"SdkVersion"`

	// The client IP address.
	ClientIp *string `json:"ClientIp,omitnil,omitempty" name:"ClientIp"`

	// Whether a user has left the room.
	Finished *bool `json:"Finished,omitnil,omitempty" name:"Finished"`
}

type UserMediaStream 

type UserMediaStream struct {
	// The user information.
	UserInfo *MixUserInfo `json:"UserInfo,omitnil,omitempty" name:"UserInfo"`

	// The stream type. 0: Camera; 1: Screen sharing. If you do not pass this parameter, 0 will be used.
	StreamType *uint64 `json:"StreamType,omitnil,omitempty" name:"StreamType"`
}

type VideoEncode 

type VideoEncode struct {
	// The width of the output stream (pixels). This parameter is required if audio and video are relayed. Value range: [0, 1920].
	Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"`

	// The height of the output stream (pixels). This parameter is required if audio and video are relayed. Value range: [0, 1080].
	Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"`

	// The frame rate (fps) of the output stream. This parameter is required if audio and video are relayed. Value range: [0, 60].
	Fps *uint64 `json:"Fps,omitnil,omitempty" name:"Fps"`

	// The bitrate (Kbps) of the output stream. This parameter is required if audio and video are relayed. Value range: [0, 10000].
	BitRate *uint64 `json:"BitRate,omitnil,omitempty" name:"BitRate"`

	// The GOP (seconds) of the output stream. This parameter is required if audio and video are relayed. Value range: [1, 5].
	Gop *uint64 `json:"Gop,omitnil,omitempty" name:"Gop"`
}

type VideoEncodeParams 

type VideoEncodeParams struct {
	// Width. Value range [0,1920], unit is pixel value.
	Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"`

	// Height. Value range [0,1080], unit is pixel value.
	Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"`

	// Frame Rate. Value range [1,60], indicating that the frame rate can be selected from 1 to 60fps.
	Fps *uint64 `json:"Fps,omitnil,omitempty" name:"Fps"`

	// Bitrate. Value range [1,10000], unit is kbps.
	BitRate *uint64 `json:"BitRate,omitnil,omitempty" name:"BitRate"`

	// Gop. Value range [1,2], unit is second.
	Gop *uint64 `json:"Gop,omitnil,omitempty" name:"Gop"`
}

type VideoParams 

type VideoParams struct {
	// The video width in pixels. The value of this parameter cannot be larger than 1920, and the result of multiplying `Width` and `Height` cannot exceed 1920 x 1080. The default value is `360`.
	Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"`

	// The video height in pixels. The value of this parameter cannot be larger than 1920, and the result of multiplying `Width` and `Height` cannot exceed 1920 x 1080. The default value is `640`.
	Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"`

	// The video frame rate. Value range: [1, 60]. Default: 15.
	Fps *uint64 `json:"Fps,omitnil,omitempty" name:"Fps"`

	// The video bitrate (bps). Value range: [64000, 8192000]. Default: 550000.
	BitRate *uint64 `json:"BitRate,omitnil,omitempty" name:"BitRate"`

	// The keyframe interval (seconds). Default value: 10.
	Gop *uint64 `json:"Gop,omitnil,omitempty" name:"Gop"`
}

type WaterMark 

type WaterMark struct {
	// The watermark type. 0 (default): image; 1: text (not supported yet).
	WaterMarkType *uint64 `json:"WaterMarkType,omitnil,omitempty" name:"WaterMarkType"`

	// The information of watermark images. This parameter is required if the watermark type is image.
	WaterMarkImage *WaterMarkImage `json:"WaterMarkImage,omitnil,omitempty" name:"WaterMarkImage"`

	// The information of the text watermark. This parameter is required if `WaterMarkType` is `1`.
	WaterMarkChar *WaterMarkChar `json:"WaterMarkChar,omitnil,omitempty" name:"WaterMarkChar"`

	// The information of the timestamp watermark. This parameter is required if `WaterMarkType` is `2`.
	WaterMarkTimestamp *WaterMarkTimestamp `json:"WaterMarkTimestamp,omitnil,omitempty" name:"WaterMarkTimestamp"`
}

type WaterMarkChar 

type WaterMarkChar struct {
	// The Y coordinate of the text watermark from the top left.
	Top *uint64 `json:"Top,omitnil,omitempty" name:"Top"`

	// The X coordinate of the text watermark from the top left.
	Left *uint64 `json:"Left,omitnil,omitempty" name:"Left"`

	// The watermark width (pixels).
	Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"`

	// The watermark height (pixels).
	Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"`

	// The text.
	Chars *string `json:"Chars,omitnil,omitempty" name:"Chars"`

	// The font size (pixels). The default value is `14`.
	FontSize *uint64 `json:"FontSize,omitnil,omitempty" name:"FontSize"`

	// The text color. The default color is white.
	FontColor *string `json:"FontColor,omitnil,omitempty" name:"FontColor"`

	// The background color. If this parameter is empty, the background will be transparent (default).
	BackGroundColor *string `json:"BackGroundColor,omitnil,omitempty" name:"BackGroundColor"`
}

type WaterMarkImage 

type WaterMarkImage struct {
	// The download URLs of the watermark images, which must be in JPG or PNG format and cannot be larger than 5 MB.
	WaterMarkUrl *string `json:"WaterMarkUrl,omitnil,omitempty" name:"WaterMarkUrl"`

	// The Y axis of the image's top-left corner. Value range: [0, 2560]. The value cannot be larger than the canvas height.
	Top *uint64 `json:"Top,omitnil,omitempty" name:"Top"`

	// The X axis of the image’s top-left corner. Value range: [0, 2560]. The value cannot be larger than the canvas width.
	Left *uint64 `json:"Left,omitnil,omitempty" name:"Left"`

	// The relative width of the image. Value range: [0, 2560]. The sum of the values of this parameter and `Left` cannot exceed the canvas width.
	Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"`

	// The relative height of the image. Value range: [0, 2560]. The sum of the values of this parameter and `Top` cannot exceed the canvas height.
	Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"`
}

type WaterMarkTimestamp 

type WaterMarkTimestamp struct {
	// The position of the timestamp watermark. Valid values: `0` (top left), `1` (top right), `2` (bottom left), `3` (bottom right), `4` (top center), `5` (bottom center), `6` (center).
	Pos *uint64 `json:"Pos,omitnil,omitempty" name:"Pos"`

	// The time zone. The default is UTC+8.
	TimeZone *uint64 `json:"TimeZone,omitnil,omitempty" name:"TimeZone"`
}

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.