v20190919

package
v3.0.952+incompatible Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source 
const (

	//
	AUTHFAILURE = "AuthFailure"

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// Service already activated.
	FAILEDOPERATION_ALREADYENABLED = "FailedOperation.AlreadyEnabled"

	// Invalid COS bucket. The bucket does not exist or is not authorized.
	FAILEDOPERATION_COSBUCKETINVALID = "FailedOperation.CosBucketInvalid"

	// Failed to download the document. To correct this, check whether the URL in the request parameter is correct. If you are using another file storage service, check the upload bandwidth of the file storage service. The document transcoding service supports downloading with a maximum duration of 1 minute. If the download fails, the transcoding request will also fail.
	FAILEDOPERATION_FILEDOWNLOADFAIL = "FailedOperation.FileDownloadFail"

	// The document format is invalid. Read-only or encrypted documents cannot be transcoded.
	FAILEDOPERATION_FILEFORMATERROR = "FailedOperation.FileFormatError"

	// Failed to open the document. To correct this, check whether the document for transcoding is encrypted or encounters other format issues.
	FAILEDOPERATION_FILEOPENFAIL = "FailedOperation.FileOpenFail"

	// Failed to upload the transcoding result. To correct this, try again later.
	FAILEDOPERATION_FILEUPLOADFAIL = "FailedOperation.FileUploadFail"

	// Failed to obtain a temporary key.
	FAILEDOPERATION_GETCREDENTIALFAIL = "FailedOperation.GetCredentialFail"

	// Failed to record. For more information, see the error description.
	FAILEDOPERATION_RECORD = "FailedOperation.Record"

	// Failed to transcode. For more information, see the error description or contact our customer service.
	FAILEDOPERATION_TRANSCODE = "FailedOperation.Transcode"

	// The transcoding service encountered an internal error. Please try again later or contact our customer service.
	FAILEDOPERATION_TRANSCODESERVERERROR = "FailedOperation.TranscodeServerError"

	// Whiteboard push failed. For more information, see the error description.
	FAILEDOPERATION_WHITEBOARDPUSH = "FailedOperation.WhiteboardPush"

	// Internal error.
	INTERNALERROR = "InternalError"

	// A parameter error occurred.
	INVALIDPARAMETER = "InvalidParameter"

	// Whiteboard application already exists.
	INVALIDPARAMETER_APPLICATIONALREADYEXISTS = "InvalidParameter.ApplicationAlreadyExists"

	// The parameter type does not match.
	INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"

	// The callback address format is invalid.
	INVALIDPARAMETER_CALLBACKADDRESSFORMATERROR = "InvalidParameter.CallbackAddressFormatError"

	// CDN domain name not found.
	INVALIDPARAMETER_CDNDOMAINNOTFOUND = "InvalidParameter.CdnDomainNotFound"

	// The document extension is not supported.
	INVALIDPARAMETER_FILEFORMATUNSUPPORTED = "InvalidParameter.FileFormatUnsupported"

	// The specified special feature does not exist.
	INVALIDPARAMETER_INVALIDEXTRA = "InvalidParameter.InvalidExtra"

	// Unsupported configuration task type.
	INVALIDPARAMETER_INVALIDTASKTYPE = "InvalidParameter.InvalidTaskType"

	// The format of the real-time recording parameter is invalid.
	INVALIDPARAMETER_RECORDPARAMETER = "InvalidParameter.RecordParameter"

	// The SdkAppId does not exist or is invalid.
	INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"

	// The task to query does not exist.
	INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"

	// Parsing failed due to an invalid time format.
	INVALIDPARAMETER_TIMEFORMAT = "InvalidParameter.TimeFormat"

	// The document transcoding parameter format is invalid.
	INVALIDPARAMETER_TRANSCODEPARAMETER = "InvalidParameter.TranscodeParameter"

	// JSON parsing failed, which may be due to parameter type mismatch.
	INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

	// The document download URL format is invalid. To correct this, check the URL in the request parameter.
	INVALIDPARAMETER_URLFORMATERROR = "InvalidParameter.UrlFormatError"

	// The number of concurrent transcoding or recording tasks exceeds the limit. For more information, see the error description or try again later.
	LIMITEXCEEDED_TASKCONCURRENCY = "LimitExceeded.TaskConcurrency"

	// The number of pages exceeds the limit. Transcoding a file with more than 500 pages is currently unsupported. If you do need this feature, contact our customer service.
	LIMITEXCEEDED_TRANSCODEPAGESLIMITATION = "LimitExceeded.TranscodePagesLimitation"

	// Too many requests.
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

	// The recording user account for real-time recording has started another recording task.
	RESOURCEINUSE_RECORDUSERID = "ResourceInUse.RecordUserId"

	// The resource is unavailable.
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// TIW is not enabled.
	RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"

	// The account is in arrears or the TIW service has expired.
	RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"

	// Unauthorized operation.
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// The SdkAppId does not exist or does not match the current Tencent Cloud account.
	UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

	// Unknown parameter error.
	UNKNOWNPARAMETER = "UnknownParameter"

	// Unsupported operation.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"

	// The specified operation cannot be performed for pending tasks in this state. For example, you cannot resume recording for a recording task.
	UNSUPPORTEDOPERATION_INVALIDTASKSTATUS = "UnsupportedOperation.InvalidTaskStatus"

	// The task is completed, and therefore the specified operation cannot be performed.
	UNSUPPORTEDOPERATION_TASKHASALREADYSTOPPED = "UnsupportedOperation.TaskHasAlreadyStopped"
)
View Source 
const APIVersion = "2019-09-19"

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplicationItem 

type ApplicationItem struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

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

	// Creation time.
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// Tag list.
	TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
}

type ApplyTiwTrialRequest 

type ApplyTiwTrialRequest struct {
	*tchttp.BaseRequest
}

func NewApplyTiwTrialRequest 

func NewApplyTiwTrialRequest() (request *ApplyTiwTrialRequest)

func (*ApplyTiwTrialRequest) FromJsonString 

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

func (r *ApplyTiwTrialRequest) ToJsonString() string

type ApplyTiwTrialRequestParams 

type ApplyTiwTrialRequestParams struct {
}

Predefined struct for user

type ApplyTiwTrialResponse 

type ApplyTiwTrialResponse struct {
	*tchttp.BaseResponse
	Response *ApplyTiwTrialResponseParams `json:"Response"`
}

func NewApplyTiwTrialResponse 

func NewApplyTiwTrialResponse() (response *ApplyTiwTrialResponse)

func (*ApplyTiwTrialResponse) FromJsonString 

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

func (r *ApplyTiwTrialResponse) ToJsonString() string

type ApplyTiwTrialResponseParams 

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

Predefined struct for user

type AuthParam 

type AuthParam struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

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

	// Signature corresponding to the user ID.
	UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"`
}

type Canvas 

type Canvas struct {
	// Width and height of the mixed stream canvas
	LayoutParams *LayoutParams `json:"LayoutParams,omitnil,omitempty" name:"LayoutParams"`

	// Background color, which is black by default. Its format is RGB. for example, "#FF0000" for the red color.
	BackgroundColor *string `json:"BackgroundColor,omitnil,omitempty" name:"BackgroundColor"`
}

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

func (c *Client) ApplyTiwTrial(request *ApplyTiwTrialRequest) (response *ApplyTiwTrialResponse, err error)

ApplyTiwTrial This API is used to apply for a Tencent Interactive Whiteboard trial (15-day by default).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_ALREADYENABLED = "FailedOperation.AlreadyEnabled"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) ApplyTiwTrialWithContext 

func (c *Client) ApplyTiwTrialWithContext(ctx context.Context, request *ApplyTiwTrialRequest) (response *ApplyTiwTrialResponse, err error)

ApplyTiwTrial This API is used to apply for a Tencent Interactive Whiteboard trial (15-day by default).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_ALREADYENABLED = "FailedOperation.AlreadyEnabled"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) CreateApplication 

func (c *Client) CreateApplication(request *CreateApplicationRequest) (response *CreateApplicationResponse, err error)

CreateApplication This API is used to create a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATIONALREADYEXISTS = "InvalidParameter.ApplicationAlreadyExists"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) CreateApplicationWithContext 

func (c *Client) CreateApplicationWithContext(ctx context.Context, request *CreateApplicationRequest) (response *CreateApplicationResponse, err error)

CreateApplication This API is used to create a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATIONALREADYEXISTS = "InvalidParameter.ApplicationAlreadyExists"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) CreateSnapshotTask 

func (c *Client) CreateSnapshotTask(request *CreateSnapshotTaskRequest) (response *CreateSnapshotTaskResponse, err error)

CreateSnapshotTask This API is used to create a whiteboard snapshot task. If a callback URL is provided, the whiteboard snapshot result is sent to the callback URL after the task is complete.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) CreateSnapshotTaskWithContext 

func (c *Client) CreateSnapshotTaskWithContext(ctx context.Context, request *CreateSnapshotTaskRequest) (response *CreateSnapshotTaskResponse, err error)

CreateSnapshotTask This API is used to create a whiteboard snapshot task. If a callback URL is provided, the whiteboard snapshot result is sent to the callback URL after the task is complete.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) CreateTranscode 

func (c *Client) CreateTranscode(request *CreateTranscodeRequest) (response *CreateTranscodeResponse, err error)

CreateTranscode This API is used to create a document transcoding task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_TRANSCODE = "FailedOperation.Transcode"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_FILEFORMATUNSUPPORTED = "InvalidParameter.FileFormatUnsupported"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_TRANSCODEPARAMETER = "InvalidParameter.TranscodeParameter"
LIMITEXCEEDED_TASKCONCURRENCY = "LimitExceeded.TaskConcurrency"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) CreateTranscodeWithContext 

func (c *Client) CreateTranscodeWithContext(ctx context.Context, request *CreateTranscodeRequest) (response *CreateTranscodeResponse, err error)

CreateTranscode This API is used to create a document transcoding task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_TRANSCODE = "FailedOperation.Transcode"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_FILEFORMATUNSUPPORTED = "InvalidParameter.FileFormatUnsupported"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_TRANSCODEPARAMETER = "InvalidParameter.TranscodeParameter"
LIMITEXCEEDED_TASKCONCURRENCY = "LimitExceeded.TaskConcurrency"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) CreateVideoGenerationTask 

func (c *Client) CreateVideoGenerationTask(request *CreateVideoGenerationTaskRequest) (response *CreateVideoGenerationTaskResponse, err error)

CreateVideoGenerationTask This API is used to create a recording video generation task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_INVALIDEXTRA = "InvalidParameter.InvalidExtra"
INVALIDPARAMETER_RECORDPARAMETER = "InvalidParameter.RecordParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
LIMITEXCEEDED_TASKCONCURRENCY = "LimitExceeded.TaskConcurrency"
RESOURCEINUSE_RECORDUSERID = "ResourceInUse.RecordUserId"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) CreateVideoGenerationTaskWithContext 

func (c *Client) CreateVideoGenerationTaskWithContext(ctx context.Context, request *CreateVideoGenerationTaskRequest) (response *CreateVideoGenerationTaskResponse, err error)

CreateVideoGenerationTask This API is used to create a recording video generation task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_INVALIDEXTRA = "InvalidParameter.InvalidExtra"
INVALIDPARAMETER_RECORDPARAMETER = "InvalidParameter.RecordParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
LIMITEXCEEDED_TASKCONCURRENCY = "LimitExceeded.TaskConcurrency"
RESOURCEINUSE_RECORDUSERID = "ResourceInUse.RecordUserId"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeAPIService 

func (c *Client) DescribeAPIService(request *DescribeAPIServiceRequest) (response *DescribeAPIServiceResponse, err error)

DescribeAPIService This API is used to query the information about other cloud products by using the service role.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) DescribeAPIServiceWithContext 

func (c *Client) DescribeAPIServiceWithContext(ctx context.Context, request *DescribeAPIServiceRequest) (response *DescribeAPIServiceResponse, err error)

DescribeAPIService This API is used to query the information about other cloud products by using the service role.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) DescribeApplicationInfos 

func (c *Client) DescribeApplicationInfos(request *DescribeApplicationInfosRequest) (response *DescribeApplicationInfosResponse, err error)

DescribeApplicationInfos This API is used to query the details of a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeApplicationInfosWithContext 

func (c *Client) DescribeApplicationInfosWithContext(ctx context.Context, request *DescribeApplicationInfosRequest) (response *DescribeApplicationInfosResponse, err error)

DescribeApplicationInfos This API is used to query the details of a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeApplicationUsage 

func (c *Client) DescribeApplicationUsage(request *DescribeApplicationUsageRequest) (response *DescribeApplicationUsageResponse, err error)

DescribeApplicationUsage This API is used to query the subproduct usage of Tencent Interactive Whiteboard.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_TIMEFORMAT = "InvalidParameter.TimeFormat"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeApplicationUsageWithContext 

func (c *Client) DescribeApplicationUsageWithContext(ctx context.Context, request *DescribeApplicationUsageRequest) (response *DescribeApplicationUsageResponse, err error)

DescribeApplicationUsage This API is used to query the subproduct usage of Tencent Interactive Whiteboard.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_TIMEFORMAT = "InvalidParameter.TimeFormat"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeBoardSDKLog 

func (c *Client) DescribeBoardSDKLog(request *DescribeBoardSDKLogRequest) (response *DescribeBoardSDKLogResponse, err error)

DescribeBoardSDKLog This API is used to query the logs of a whiteboard application on a client.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeBoardSDKLogWithContext 

func (c *Client) DescribeBoardSDKLogWithContext(ctx context.Context, request *DescribeBoardSDKLogRequest) (response *DescribeBoardSDKLogResponse, err error)

DescribeBoardSDKLog This API is used to query the logs of a whiteboard application on a client.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeIMApplications 

func (c *Client) DescribeIMApplications(request *DescribeIMApplicationsRequest) (response *DescribeIMApplicationsResponse, err error)

DescribeIMApplications This API is used to query the instant messaging (IM) applications that are available for creating a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeIMApplicationsWithContext 

func (c *Client) DescribeIMApplicationsWithContext(ctx context.Context, request *DescribeIMApplicationsRequest) (response *DescribeIMApplicationsResponse, err error)

DescribeIMApplications This API is used to query the instant messaging (IM) applications that are available for creating a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeOnlineRecord 

func (c *Client) DescribeOnlineRecord(request *DescribeOnlineRecordRequest) (response *DescribeOnlineRecordResponse, err error)

DescribeOnlineRecord This API is used to query the status and result of a real-time recording task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_RECORD = "FailedOperation.Record"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeOnlineRecordCallback 

func (c *Client) DescribeOnlineRecordCallback(request *DescribeOnlineRecordCallbackRequest) (response *DescribeOnlineRecordCallbackResponse, err error)

DescribeOnlineRecordCallback This API is used to query the real-time recording callback address.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeOnlineRecordCallbackWithContext 

func (c *Client) DescribeOnlineRecordCallbackWithContext(ctx context.Context, request *DescribeOnlineRecordCallbackRequest) (response *DescribeOnlineRecordCallbackResponse, err error)

DescribeOnlineRecordCallback This API is used to query the real-time recording callback address.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeOnlineRecordWithContext 

func (c *Client) DescribeOnlineRecordWithContext(ctx context.Context, request *DescribeOnlineRecordRequest) (response *DescribeOnlineRecordResponse, err error)

DescribeOnlineRecord This API is used to query the status and result of a real-time recording task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_RECORD = "FailedOperation.Record"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribePostpaidUsage 

func (c *Client) DescribePostpaidUsage(request *DescribePostpaidUsageRequest) (response *DescribePostpaidUsageResponse, err error)

DescribePostpaidUsage This API is used to query the pay-as-you-go usage of a user.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_TIMEFORMAT = "InvalidParameter.TimeFormat"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribePostpaidUsageWithContext 

func (c *Client) DescribePostpaidUsageWithContext(ctx context.Context, request *DescribePostpaidUsageRequest) (response *DescribePostpaidUsageResponse, err error)

DescribePostpaidUsage This API is used to query the pay-as-you-go usage of a user.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_TIMEFORMAT = "InvalidParameter.TimeFormat"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeQualityMetrics 

func (c *Client) DescribeQualityMetrics(request *DescribeQualityMetricsRequest) (response *DescribeQualityMetricsResponse, err error)

DescribeQualityMetrics This API is used to query the quality data of a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeQualityMetricsWithContext 

func (c *Client) DescribeQualityMetricsWithContext(ctx context.Context, request *DescribeQualityMetricsRequest) (response *DescribeQualityMetricsResponse, err error)

DescribeQualityMetrics This API is used to query the quality data of a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeRecordSearch 

func (c *Client) DescribeRecordSearch(request *DescribeRecordSearchRequest) (response *DescribeRecordSearchResponse, err error)

DescribeRecordSearch This API is used to query real-time recording tasks by room ID.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeRecordSearchWithContext 

func (c *Client) DescribeRecordSearchWithContext(ctx context.Context, request *DescribeRecordSearchRequest) (response *DescribeRecordSearchResponse, err error)

DescribeRecordSearch This API is used to query real-time recording tasks by room ID.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeRoomList 

func (c *Client) DescribeRoomList(request *DescribeRoomListRequest) (response *DescribeRoomListResponse, err error)

DescribeRoomList This API is used to query the rooms of a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeRoomListWithContext 

func (c *Client) DescribeRoomListWithContext(ctx context.Context, request *DescribeRoomListRequest) (response *DescribeRoomListResponse, err error)

DescribeRoomList This API is used to query the rooms of a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeSnapshotTask 

func (c *Client) DescribeSnapshotTask(request *DescribeSnapshotTaskRequest) (response *DescribeSnapshotTaskResponse, err error)

DescribeSnapshotTask This API is used to query the information about a whiteboard snapshot task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeSnapshotTaskWithContext 

func (c *Client) DescribeSnapshotTaskWithContext(ctx context.Context, request *DescribeSnapshotTaskRequest) (response *DescribeSnapshotTaskResponse, err error)

DescribeSnapshotTask This API is used to query the information about a whiteboard snapshot task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeTIWDailyUsage 

func (c *Client) DescribeTIWDailyUsage(request *DescribeTIWDailyUsageRequest) (response *DescribeTIWDailyUsageResponse, err error)

DescribeTIWDailyUsage This API is used to query the daily billable usage of a whiteboard application.

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

2. Due to statistics delays and other reasons, you cannot query the usage data of the current day. You can query today's usage after 7:00 tomorrow.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_TRANSCODEPARAMETER = "InvalidParameter.TranscodeParameter"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeTIWDailyUsageWithContext 

func (c *Client) DescribeTIWDailyUsageWithContext(ctx context.Context, request *DescribeTIWDailyUsageRequest) (response *DescribeTIWDailyUsageResponse, err error)

DescribeTIWDailyUsage This API is used to query the daily billable usage of a whiteboard application.

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

2. Due to statistics delays and other reasons, you cannot query the usage data of the current day. You can query today's usage after 7:00 tomorrow.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_TRANSCODEPARAMETER = "InvalidParameter.TranscodeParameter"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeTIWRoomDailyUsage 

func (c *Client) DescribeTIWRoomDailyUsage(request *DescribeTIWRoomDailyUsageRequest) (response *DescribeTIWRoomDailyUsageResponse, err error)

DescribeTIWRoomDailyUsage This API is used to query the daily billable usage by each room of a whiteboard application.

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

2. Due to statistics delays and other reasons, you cannot query the usage data of the current day. You can query today's usage after 7:00 tomorrow.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_TRANSCODEPARAMETER = "InvalidParameter.TranscodeParameter"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeTIWRoomDailyUsageWithContext 

func (c *Client) DescribeTIWRoomDailyUsageWithContext(ctx context.Context, request *DescribeTIWRoomDailyUsageRequest) (response *DescribeTIWRoomDailyUsageResponse, err error)

DescribeTIWRoomDailyUsage This API is used to query the daily billable usage by each room of a whiteboard application.

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

2. Due to statistics delays and other reasons, you cannot query the usage data of the current day. You can query today's usage after 7:00 tomorrow.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_TRANSCODEPARAMETER = "InvalidParameter.TranscodeParameter"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeTranscode 

func (c *Client) DescribeTranscode(request *DescribeTranscodeRequest) (response *DescribeTranscodeResponse, err error)

DescribeTranscode This API is used to query the progress and result of a document transcoding task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_FILEDOWNLOADFAIL = "FailedOperation.FileDownloadFail"
FAILEDOPERATION_FILEFORMATERROR = "FailedOperation.FileFormatError"
FAILEDOPERATION_FILEOPENFAIL = "FailedOperation.FileOpenFail"
FAILEDOPERATION_FILEUPLOADFAIL = "FailedOperation.FileUploadFail"
FAILEDOPERATION_TRANSCODE = "FailedOperation.Transcode"
FAILEDOPERATION_TRANSCODESERVERERROR = "FailedOperation.TranscodeServerError"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_FILEFORMATUNSUPPORTED = "InvalidParameter.FileFormatUnsupported"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
INVALIDPARAMETER_TRANSCODEPARAMETER = "InvalidParameter.TranscodeParameter"
INVALIDPARAMETER_URLFORMATERROR = "InvalidParameter.UrlFormatError"
LIMITEXCEEDED_TRANSCODEPAGESLIMITATION = "LimitExceeded.TranscodePagesLimitation"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeTranscodeCallback 

func (c *Client) DescribeTranscodeCallback(request *DescribeTranscodeCallbackRequest) (response *DescribeTranscodeCallbackResponse, err error)

DescribeTranscodeCallback This API is used to query the document transcoding callback address.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeTranscodeCallbackWithContext 

func (c *Client) DescribeTranscodeCallbackWithContext(ctx context.Context, request *DescribeTranscodeCallbackRequest) (response *DescribeTranscodeCallbackResponse, err error)

DescribeTranscodeCallback This API is used to query the document transcoding callback address.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeTranscodeSearch 

func (c *Client) DescribeTranscodeSearch(request *DescribeTranscodeSearchRequest) (response *DescribeTranscodeSearchResponse, err error)

DescribeTranscodeSearch This API is used to query transcoding tasks by document name.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeTranscodeSearchWithContext 

func (c *Client) DescribeTranscodeSearchWithContext(ctx context.Context, request *DescribeTranscodeSearchRequest) (response *DescribeTranscodeSearchResponse, err error)

DescribeTranscodeSearch This API is used to query transcoding tasks by document name.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeTranscodeWithContext 

func (c *Client) DescribeTranscodeWithContext(ctx context.Context, request *DescribeTranscodeRequest) (response *DescribeTranscodeResponse, err error)

DescribeTranscode This API is used to query the progress and result of a document transcoding task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_FILEDOWNLOADFAIL = "FailedOperation.FileDownloadFail"
FAILEDOPERATION_FILEFORMATERROR = "FailedOperation.FileFormatError"
FAILEDOPERATION_FILEOPENFAIL = "FailedOperation.FileOpenFail"
FAILEDOPERATION_FILEUPLOADFAIL = "FailedOperation.FileUploadFail"
FAILEDOPERATION_TRANSCODE = "FailedOperation.Transcode"
FAILEDOPERATION_TRANSCODESERVERERROR = "FailedOperation.TranscodeServerError"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_FILEFORMATUNSUPPORTED = "InvalidParameter.FileFormatUnsupported"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
INVALIDPARAMETER_TRANSCODEPARAMETER = "InvalidParameter.TranscodeParameter"
INVALIDPARAMETER_URLFORMATERROR = "InvalidParameter.UrlFormatError"
LIMITEXCEEDED_TRANSCODEPAGESLIMITATION = "LimitExceeded.TranscodePagesLimitation"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeUsageSummary 

func (c *Client) DescribeUsageSummary(request *DescribeUsageSummaryRequest) (response *DescribeUsageSummaryResponse, err error)

DescribeUsageSummary This API is used to query the summary of subproduct usage within a specified period of time.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_TIMEFORMAT = "InvalidParameter.TimeFormat"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeUsageSummaryWithContext 

func (c *Client) DescribeUsageSummaryWithContext(ctx context.Context, request *DescribeUsageSummaryRequest) (response *DescribeUsageSummaryResponse, err error)

DescribeUsageSummary This API is used to query the summary of subproduct usage within a specified period of time.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_TIMEFORMAT = "InvalidParameter.TimeFormat"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeUserList 

func (c *Client) DescribeUserList(request *DescribeUserListRequest) (response *DescribeUserListResponse, err error)

DescribeUserList This API is used to query the users of a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeUserListWithContext 

func (c *Client) DescribeUserListWithContext(ctx context.Context, request *DescribeUserListRequest) (response *DescribeUserListResponse, err error)

DescribeUserList This API is used to query the users of a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeUserResources 

func (c *Client) DescribeUserResources(request *DescribeUserResourcesRequest) (response *DescribeUserResourcesResponse, err error)

DescribeUserResources This API is used to query user resources.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeUserResourcesWithContext 

func (c *Client) DescribeUserResourcesWithContext(ctx context.Context, request *DescribeUserResourcesRequest) (response *DescribeUserResourcesResponse, err error)

DescribeUserResources This API is used to query user resources.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeUserStatus 

func (c *Client) DescribeUserStatus(request *DescribeUserStatusRequest) (response *DescribeUserStatusResponse, err error)

DescribeUserStatus This API is used to query the Tencent Interactive Whiteboard service status of a user, including the activation status and validity period.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_ALREADYENABLED = "FailedOperation.AlreadyEnabled"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeUserStatusWithContext 

func (c *Client) DescribeUserStatusWithContext(ctx context.Context, request *DescribeUserStatusRequest) (response *DescribeUserStatusResponse, err error)

DescribeUserStatus This API is used to query the Tencent Interactive Whiteboard service status of a user, including the activation status and validity period.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_ALREADYENABLED = "FailedOperation.AlreadyEnabled"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) DescribeVideoGenerationTask 

func (c *Client) DescribeVideoGenerationTask(request *DescribeVideoGenerationTaskRequest) (response *DescribeVideoGenerationTaskResponse, err error)

DescribeVideoGenerationTask This API is used to query the status and result of a recording video generation task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_RECORD = "FailedOperation.Record"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeVideoGenerationTaskCallback 

func (c *Client) DescribeVideoGenerationTaskCallback(request *DescribeVideoGenerationTaskCallbackRequest) (response *DescribeVideoGenerationTaskCallbackResponse, err error)

DescribeVideoGenerationTaskCallback This API is used to query the callback URL for recording video generation.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeVideoGenerationTaskCallbackWithContext 

func (c *Client) DescribeVideoGenerationTaskCallbackWithContext(ctx context.Context, request *DescribeVideoGenerationTaskCallbackRequest) (response *DescribeVideoGenerationTaskCallbackResponse, err error)

DescribeVideoGenerationTaskCallback This API is used to query the callback URL for recording video generation.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeVideoGenerationTaskWithContext 

func (c *Client) DescribeVideoGenerationTaskWithContext(ctx context.Context, request *DescribeVideoGenerationTaskRequest) (response *DescribeVideoGenerationTaskResponse, err error)

DescribeVideoGenerationTask This API is used to query the status and result of a recording video generation task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_RECORD = "FailedOperation.Record"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeWhiteboardApplicationConfig 

func (c *Client) DescribeWhiteboardApplicationConfig(request *DescribeWhiteboardApplicationConfigRequest) (response *DescribeWhiteboardApplicationConfigResponse, err error)

DescribeWhiteboardApplicationConfig This API is used to query the task-related configurations of a whiteboard application, including the bucket and callback URL.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_INVALIDTASKTYPE = "InvalidParameter.InvalidTaskType"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeWhiteboardApplicationConfigWithContext 

func (c *Client) DescribeWhiteboardApplicationConfigWithContext(ctx context.Context, request *DescribeWhiteboardApplicationConfigRequest) (response *DescribeWhiteboardApplicationConfigResponse, err error)

DescribeWhiteboardApplicationConfig This API is used to query the task-related configurations of a whiteboard application, including the bucket and callback URL.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_INVALIDTASKTYPE = "InvalidParameter.InvalidTaskType"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeWhiteboardBucketConfig 

func (c *Client) DescribeWhiteboardBucketConfig(request *DescribeWhiteboardBucketConfigRequest) (response *DescribeWhiteboardBucketConfigResponse, err error)

DescribeWhiteboardBucketConfig This API is used to query the bucket configurations for document transcoding and real-time recording.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_INVALIDTASKTYPE = "InvalidParameter.InvalidTaskType"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeWhiteboardBucketConfigWithContext 

func (c *Client) DescribeWhiteboardBucketConfigWithContext(ctx context.Context, request *DescribeWhiteboardBucketConfigRequest) (response *DescribeWhiteboardBucketConfigResponse, err error)

DescribeWhiteboardBucketConfig This API is used to query the bucket configurations for document transcoding and real-time recording.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_INVALIDTASKTYPE = "InvalidParameter.InvalidTaskType"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeWhiteboardPush 

func (c *Client) DescribeWhiteboardPush(request *DescribeWhiteboardPushRequest) (response *DescribeWhiteboardPushResponse, err error)

DescribeWhiteboardPush This API is used to query the status and result of a whiteboard push task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_WHITEBOARDPUSH = "FailedOperation.WhiteboardPush"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeWhiteboardPushCallback 

func (c *Client) DescribeWhiteboardPushCallback(request *DescribeWhiteboardPushCallbackRequest) (response *DescribeWhiteboardPushCallbackResponse, err error)

DescribeWhiteboardPushCallback This API is used to query the whiteboard push callback URL.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeWhiteboardPushCallbackWithContext 

func (c *Client) DescribeWhiteboardPushCallbackWithContext(ctx context.Context, request *DescribeWhiteboardPushCallbackRequest) (response *DescribeWhiteboardPushCallbackResponse, err error)

DescribeWhiteboardPushCallback This API is used to query the whiteboard push callback URL.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeWhiteboardPushSearch 

func (c *Client) DescribeWhiteboardPushSearch(request *DescribeWhiteboardPushSearchRequest) (response *DescribeWhiteboardPushSearchResponse, err error)

DescribeWhiteboardPushSearch This API is used to query whiteboard push tasks by room ID.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeWhiteboardPushSearchWithContext 

func (c *Client) DescribeWhiteboardPushSearchWithContext(ctx context.Context, request *DescribeWhiteboardPushSearchRequest) (response *DescribeWhiteboardPushSearchResponse, err error)

DescribeWhiteboardPushSearch This API is used to query whiteboard push tasks by room ID.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) DescribeWhiteboardPushWithContext 

func (c *Client) DescribeWhiteboardPushWithContext(ctx context.Context, request *DescribeWhiteboardPushRequest) (response *DescribeWhiteboardPushResponse, err error)

DescribeWhiteboardPush This API is used to query the status and result of a whiteboard push task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_WHITEBOARDPUSH = "FailedOperation.WhiteboardPush"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) ModifyApplication 

func (c *Client) ModifyApplication(request *ModifyApplicationRequest) (response *ModifyApplicationResponse, err error)

ModifyApplication This API is used to modify a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) ModifyApplicationWithContext 

func (c *Client) ModifyApplicationWithContext(ctx context.Context, request *ModifyApplicationRequest) (response *ModifyApplicationResponse, err error)

ModifyApplication This API is used to modify a whiteboard application.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) ModifyAutoRenewFlag 

func (c *Client) ModifyAutoRenewFlag(request *ModifyAutoRenewFlagRequest) (response *ModifyAutoRenewFlagResponse, err error)

ModifyAutoRenewFlag This API is used to set auto-renewal for a Tencent Interactive Whiteboard monthly feature package.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) ModifyAutoRenewFlagWithContext 

func (c *Client) ModifyAutoRenewFlagWithContext(ctx context.Context, request *ModifyAutoRenewFlagRequest) (response *ModifyAutoRenewFlagResponse, err error)

ModifyAutoRenewFlag This API is used to set auto-renewal for a Tencent Interactive Whiteboard monthly feature package.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"

func (*Client) ModifyWhiteboardApplicationConfig 

func (c *Client) ModifyWhiteboardApplicationConfig(request *ModifyWhiteboardApplicationConfigRequest) (response *ModifyWhiteboardApplicationConfigResponse, err error)

ModifyWhiteboardApplicationConfig This API is used to modify the task-related configurations of a whiteboard application, including the bucket and callback URL.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_COSBUCKETINVALID = "FailedOperation.CosBucketInvalid"
FAILEDOPERATION_GETCREDENTIALFAIL = "FailedOperation.GetCredentialFail"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_CALLBACKADDRESSFORMATERROR = "InvalidParameter.CallbackAddressFormatError"
INVALIDPARAMETER_CDNDOMAINNOTFOUND = "InvalidParameter.CdnDomainNotFound"
INVALIDPARAMETER_INVALIDTASKTYPE = "InvalidParameter.InvalidTaskType"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) ModifyWhiteboardApplicationConfigWithContext 

func (c *Client) ModifyWhiteboardApplicationConfigWithContext(ctx context.Context, request *ModifyWhiteboardApplicationConfigRequest) (response *ModifyWhiteboardApplicationConfigResponse, err error)

ModifyWhiteboardApplicationConfig This API is used to modify the task-related configurations of a whiteboard application, including the bucket and callback URL.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_COSBUCKETINVALID = "FailedOperation.CosBucketInvalid"
FAILEDOPERATION_GETCREDENTIALFAIL = "FailedOperation.GetCredentialFail"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_CALLBACKADDRESSFORMATERROR = "InvalidParameter.CallbackAddressFormatError"
INVALIDPARAMETER_CDNDOMAINNOTFOUND = "InvalidParameter.CdnDomainNotFound"
INVALIDPARAMETER_INVALIDTASKTYPE = "InvalidParameter.InvalidTaskType"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_UNMARSHALJSONBODYFAIL = "InvalidParameter.UnmarshalJSONBodyFail"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) ModifyWhiteboardBucketConfig 

func (c *Client) ModifyWhiteboardBucketConfig(request *ModifyWhiteboardBucketConfigRequest) (response *ModifyWhiteboardBucketConfigResponse, err error)

ModifyWhiteboardBucketConfig This API is used to modify the bucket configurations for document transcoding and real-time recording.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_COSBUCKETINVALID = "FailedOperation.CosBucketInvalid"
FAILEDOPERATION_GETCREDENTIALFAIL = "FailedOperation.GetCredentialFail"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_CDNDOMAINNOTFOUND = "InvalidParameter.CdnDomainNotFound"
INVALIDPARAMETER_INVALIDTASKTYPE = "InvalidParameter.InvalidTaskType"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) ModifyWhiteboardBucketConfigWithContext 

func (c *Client) ModifyWhiteboardBucketConfigWithContext(ctx context.Context, request *ModifyWhiteboardBucketConfigRequest) (response *ModifyWhiteboardBucketConfigResponse, err error)

ModifyWhiteboardBucketConfig This API is used to modify the bucket configurations for document transcoding and real-time recording.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_COSBUCKETINVALID = "FailedOperation.CosBucketInvalid"
FAILEDOPERATION_GETCREDENTIALFAIL = "FailedOperation.GetCredentialFail"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_CDNDOMAINNOTFOUND = "InvalidParameter.CdnDomainNotFound"
INVALIDPARAMETER_INVALIDTASKTYPE = "InvalidParameter.InvalidTaskType"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) PauseOnlineRecord 

func (c *Client) PauseOnlineRecord(request *PauseOnlineRecordRequest) (response *PauseOnlineRecordResponse, err error)

PauseOnlineRecord This API is used to pause real-time recording.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
UNSUPPORTEDOPERATION_INVALIDTASKSTATUS = "UnsupportedOperation.InvalidTaskStatus"
UNSUPPORTEDOPERATION_TASKHASALREADYSTOPPED = "UnsupportedOperation.TaskHasAlreadyStopped"

func (*Client) PauseOnlineRecordWithContext 

func (c *Client) PauseOnlineRecordWithContext(ctx context.Context, request *PauseOnlineRecordRequest) (response *PauseOnlineRecordResponse, err error)

PauseOnlineRecord This API is used to pause real-time recording.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
UNSUPPORTEDOPERATION_INVALIDTASKSTATUS = "UnsupportedOperation.InvalidTaskStatus"
UNSUPPORTEDOPERATION_TASKHASALREADYSTOPPED = "UnsupportedOperation.TaskHasAlreadyStopped"

func (*Client) ResumeOnlineRecord 

func (c *Client) ResumeOnlineRecord(request *ResumeOnlineRecordRequest) (response *ResumeOnlineRecordResponse, err error)

ResumeOnlineRecord This API is used to resume real-time recording.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
UNSUPPORTEDOPERATION_INVALIDTASKSTATUS = "UnsupportedOperation.InvalidTaskStatus"
UNSUPPORTEDOPERATION_TASKHASALREADYSTOPPED = "UnsupportedOperation.TaskHasAlreadyStopped"

func (*Client) ResumeOnlineRecordWithContext 

func (c *Client) ResumeOnlineRecordWithContext(ctx context.Context, request *ResumeOnlineRecordRequest) (response *ResumeOnlineRecordResponse, err error)

ResumeOnlineRecord This API is used to resume real-time recording.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
UNSUPPORTEDOPERATION_INVALIDTASKSTATUS = "UnsupportedOperation.InvalidTaskStatus"
UNSUPPORTEDOPERATION_TASKHASALREADYSTOPPED = "UnsupportedOperation.TaskHasAlreadyStopped"

func (*Client) SetOnlineRecordCallback 

func (c *Client) SetOnlineRecordCallback(request *SetOnlineRecordCallbackRequest) (response *SetOnlineRecordCallbackResponse, err error)

SetOnlineRecordCallback This API is used to set the real-time recording callback address. For the callback format, please [see here](https://www.tencentcloud.com/document/product/1176/55569).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_CALLBACKADDRESSFORMATERROR = "InvalidParameter.CallbackAddressFormatError"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetOnlineRecordCallbackKey 

func (c *Client) SetOnlineRecordCallbackKey(request *SetOnlineRecordCallbackKeyRequest) (response *SetOnlineRecordCallbackKeyResponse, err error)

SetOnlineRecordCallbackKey This API is used to set the callback authentication key for real-time recording. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetOnlineRecordCallbackKeyWithContext 

func (c *Client) SetOnlineRecordCallbackKeyWithContext(ctx context.Context, request *SetOnlineRecordCallbackKeyRequest) (response *SetOnlineRecordCallbackKeyResponse, err error)

SetOnlineRecordCallbackKey This API is used to set the callback authentication key for real-time recording. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetOnlineRecordCallbackWithContext 

func (c *Client) SetOnlineRecordCallbackWithContext(ctx context.Context, request *SetOnlineRecordCallbackRequest) (response *SetOnlineRecordCallbackResponse, err error)

SetOnlineRecordCallback This API is used to set the real-time recording callback address. For the callback format, please [see here](https://www.tencentcloud.com/document/product/1176/55569).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_CALLBACKADDRESSFORMATERROR = "InvalidParameter.CallbackAddressFormatError"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetTranscodeCallback 

func (c *Client) SetTranscodeCallback(request *SetTranscodeCallbackRequest) (response *SetTranscodeCallbackResponse, err error)

SetTranscodeCallback This API is used to set the callback address for document transcoding. For the callback format, please [see here](https://www.tencentcloud.com/document/product/1176/55569).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_CALLBACKADDRESSFORMATERROR = "InvalidParameter.CallbackAddressFormatError"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetTranscodeCallbackKey 

func (c *Client) SetTranscodeCallbackKey(request *SetTranscodeCallbackKeyRequest) (response *SetTranscodeCallbackKeyResponse, err error)

SetTranscodeCallbackKey This API is used to set the callback authentication key for document transcoding. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetTranscodeCallbackKeyWithContext 

func (c *Client) SetTranscodeCallbackKeyWithContext(ctx context.Context, request *SetTranscodeCallbackKeyRequest) (response *SetTranscodeCallbackKeyResponse, err error)

SetTranscodeCallbackKey This API is used to set the callback authentication key for document transcoding. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetTranscodeCallbackWithContext 

func (c *Client) SetTranscodeCallbackWithContext(ctx context.Context, request *SetTranscodeCallbackRequest) (response *SetTranscodeCallbackResponse, err error)

SetTranscodeCallback This API is used to set the callback address for document transcoding. For the callback format, please [see here](https://www.tencentcloud.com/document/product/1176/55569).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_CALLBACKADDRESSFORMATERROR = "InvalidParameter.CallbackAddressFormatError"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetVideoGenerationTaskCallback 

func (c *Client) SetVideoGenerationTaskCallback(request *SetVideoGenerationTaskCallbackRequest) (response *SetVideoGenerationTaskCallbackResponse, err error)

SetVideoGenerationTaskCallback This API is used to set the callback URL for recording video generation.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_CALLBACKADDRESSFORMATERROR = "InvalidParameter.CallbackAddressFormatError"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetVideoGenerationTaskCallbackKey 

func (c *Client) SetVideoGenerationTaskCallbackKey(request *SetVideoGenerationTaskCallbackKeyRequest) (response *SetVideoGenerationTaskCallbackKeyResponse, err error)

SetVideoGenerationTaskCallbackKey This API is used to set the callback authentication key for recording video generation.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetVideoGenerationTaskCallbackKeyWithContext 

func (c *Client) SetVideoGenerationTaskCallbackKeyWithContext(ctx context.Context, request *SetVideoGenerationTaskCallbackKeyRequest) (response *SetVideoGenerationTaskCallbackKeyResponse, err error)

SetVideoGenerationTaskCallbackKey This API is used to set the callback authentication key for recording video generation.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetVideoGenerationTaskCallbackWithContext 

func (c *Client) SetVideoGenerationTaskCallbackWithContext(ctx context.Context, request *SetVideoGenerationTaskCallbackRequest) (response *SetVideoGenerationTaskCallbackResponse, err error)

SetVideoGenerationTaskCallback This API is used to set the callback URL for recording video generation.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_CALLBACKADDRESSFORMATERROR = "InvalidParameter.CallbackAddressFormatError"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetWhiteboardPushCallback 

func (c *Client) SetWhiteboardPushCallback(request *SetWhiteboardPushCallbackRequest) (response *SetWhiteboardPushCallbackResponse, err error)

SetWhiteboardPushCallback This API is used to set the whiteboard push callback URL. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_CALLBACKADDRESSFORMATERROR = "InvalidParameter.CallbackAddressFormatError"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetWhiteboardPushCallbackKey 

func (c *Client) SetWhiteboardPushCallbackKey(request *SetWhiteboardPushCallbackKeyRequest) (response *SetWhiteboardPushCallbackKeyResponse, err error)

SetWhiteboardPushCallbackKey This API is used to set the callback authentication key for whiteboard push. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetWhiteboardPushCallbackKeyWithContext 

func (c *Client) SetWhiteboardPushCallbackKeyWithContext(ctx context.Context, request *SetWhiteboardPushCallbackKeyRequest) (response *SetWhiteboardPushCallbackKeyResponse, err error)

SetWhiteboardPushCallbackKey This API is used to set the callback authentication key for whiteboard push. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) SetWhiteboardPushCallbackWithContext 

func (c *Client) SetWhiteboardPushCallbackWithContext(ctx context.Context, request *SetWhiteboardPushCallbackRequest) (response *SetWhiteboardPushCallbackResponse, err error)

SetWhiteboardPushCallback This API is used to set the whiteboard push callback URL. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_CALLBACKADDRESSFORMATERROR = "InvalidParameter.CallbackAddressFormatError"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) StartOnlineRecord 

func (c *Client) StartOnlineRecord(request *StartOnlineRecordRequest) (response *StartOnlineRecordResponse, err error)

StartOnlineRecord This API is used to start a real-time recording task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_INVALIDEXTRA = "InvalidParameter.InvalidExtra"
INVALIDPARAMETER_RECORDPARAMETER = "InvalidParameter.RecordParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
LIMITEXCEEDED_TASKCONCURRENCY = "LimitExceeded.TaskConcurrency"
RESOURCEINUSE_RECORDUSERID = "ResourceInUse.RecordUserId"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) StartOnlineRecordWithContext 

func (c *Client) StartOnlineRecordWithContext(ctx context.Context, request *StartOnlineRecordRequest) (response *StartOnlineRecordResponse, err error)

StartOnlineRecord This API is used to start a real-time recording task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_INVALIDEXTRA = "InvalidParameter.InvalidExtra"
INVALIDPARAMETER_RECORDPARAMETER = "InvalidParameter.RecordParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
LIMITEXCEEDED_TASKCONCURRENCY = "LimitExceeded.TaskConcurrency"
RESOURCEINUSE_RECORDUSERID = "ResourceInUse.RecordUserId"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) StartWhiteboardPush 

func (c *Client) StartWhiteboardPush(request *StartWhiteboardPushRequest) (response *StartWhiteboardPushResponse, err error)

StartWhiteboardPush This API is used to start a whiteboard push task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_INVALIDEXTRA = "InvalidParameter.InvalidExtra"
INVALIDPARAMETER_RECORDPARAMETER = "InvalidParameter.RecordParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
LIMITEXCEEDED_TASKCONCURRENCY = "LimitExceeded.TaskConcurrency"
RESOURCEINUSE_RECORDUSERID = "ResourceInUse.RecordUserId"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) StartWhiteboardPushWithContext 

func (c *Client) StartWhiteboardPushWithContext(ctx context.Context, request *StartWhiteboardPushRequest) (response *StartWhiteboardPushResponse, err error)

StartWhiteboardPush This API is used to start a whiteboard push task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_INVALIDEXTRA = "InvalidParameter.InvalidExtra"
INVALIDPARAMETER_RECORDPARAMETER = "InvalidParameter.RecordParameter"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
LIMITEXCEEDED_TASKCONCURRENCY = "LimitExceeded.TaskConcurrency"
RESOURCEINUSE_RECORDUSERID = "ResourceInUse.RecordUserId"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) StopOnlineRecord 

func (c *Client) StopOnlineRecord(request *StopOnlineRecordRequest) (response *StopOnlineRecordResponse, err error)

StopOnlineRecord This API is used to stop real-time recording.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
UNSUPPORTEDOPERATION_TASKHASALREADYSTOPPED = "UnsupportedOperation.TaskHasAlreadyStopped"

func (*Client) StopOnlineRecordWithContext 

func (c *Client) StopOnlineRecordWithContext(ctx context.Context, request *StopOnlineRecordRequest) (response *StopOnlineRecordResponse, err error)

StopOnlineRecord This API is used to stop real-time recording.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
UNSUPPORTEDOPERATION_TASKHASALREADYSTOPPED = "UnsupportedOperation.TaskHasAlreadyStopped"

func (*Client) StopWhiteboardPush 

func (c *Client) StopWhiteboardPush(request *StopWhiteboardPushRequest) (response *StopWhiteboardPushResponse, err error)

StopWhiteboardPush This API is used to stop a whiteboard push task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
UNSUPPORTEDOPERATION_TASKHASALREADYSTOPPED = "UnsupportedOperation.TaskHasAlreadyStopped"

func (*Client) StopWhiteboardPushWithContext 

func (c *Client) StopWhiteboardPushWithContext(ctx context.Context, request *StopWhiteboardPushRequest) (response *StopWhiteboardPushResponse, err error)

StopWhiteboardPush This API is used to stop a whiteboard push task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
INVALIDPARAMETER_SDKAPPIDNOTFOUND = "InvalidParameter.SdkAppIdNotFound"
INVALIDPARAMETER_TASKNOTFOUND = "InvalidParameter.TaskNotFound"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
UNSUPPORTEDOPERATION_TASKHASALREADYSTOPPED = "UnsupportedOperation.TaskHasAlreadyStopped"

type Concat 

type Concat struct {
	// Whether to enable the video splicing feature
	// If the video splicing feature is enabled, the real-time recording service will splice multiple video clips resulting from the pause into one video.
	Enabled *bool `json:"Enabled,omitnil,omitempty" name:"Enabled"`

	// Download address of the padding image used during video splicing. If it is not specified, a pure black image is used by default.
	Image *string `json:"Image,omitnil,omitempty" name:"Image"`
}

type CreateApplicationRequest 

type CreateApplicationRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

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

	// SKey required for creating an IM application.
	SKey *string `json:"SKey,omitnil,omitempty" name:"SKey"`

	// TinyId required for creating an IM application.
	TinyId *string `json:"TinyId,omitnil,omitempty" name:"TinyId"`

	// List of tags to be bound.
	TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
}

func NewCreateApplicationRequest 

func NewCreateApplicationRequest() (request *CreateApplicationRequest)

func (*CreateApplicationRequest) FromJsonString 

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

func (r *CreateApplicationRequest) ToJsonString() string

type CreateApplicationRequestParams 

type CreateApplicationRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

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

	// SKey required for creating an IM application.
	SKey *string `json:"SKey,omitnil,omitempty" name:"SKey"`

	// TinyId required for creating an IM application.
	TinyId *string `json:"TinyId,omitnil,omitempty" name:"TinyId"`

	// List of tags to be bound.
	TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
}

Predefined struct for user

type CreateApplicationResponse 

type CreateApplicationResponse struct {
	*tchttp.BaseResponse
	Response *CreateApplicationResponseParams `json:"Response"`
}

func NewCreateApplicationResponse 

func NewCreateApplicationResponse() (response *CreateApplicationResponse)

func (*CreateApplicationResponse) FromJsonString 

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

func (r *CreateApplicationResponse) ToJsonString() string

type CreateApplicationResponseParams 

type CreateApplicationResponseParams struct {
	// AppId of the customer.
	AppId *int64 `json:"AppId,omitnil,omitempty" name:"AppId"`

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

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

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

Predefined struct for user

type CreateSnapshotTaskRequest 

type CreateSnapshotTaskRequest struct {
	*tchttp.BaseRequest

	// Whiteboard parameters.
	Whiteboard *SnapshotWhiteboard `json:"Whiteboard,omitnil,omitempty" name:"Whiteboard"`

	// `SdkAppId` of the whiteboard application.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Whiteboard room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Callback URL to which the whiteboard snapshot result is to be sent.
	CallbackURL *string `json:"CallbackURL,omitnil,omitempty" name:"CallbackURL"`

	// `COS` bucket in which the generated whiteboard snapshot file is to be stored. If you leave this parameter empty, the generated file will be stored in the public bucket and retained for only three days.
	COS *SnapshotCOS `json:"COS,omitnil,omitempty" name:"COS"`

	// Whiteboard snapshot mode. Default value: `AllMarks`. Valid values:
	//
	// `AllMarks`: Full mode. In this mode, a snapshot image is generated based on each whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client.
	//
	// `LatestMarksOnly`: Single-page deduplication mode. In this mode, a snapshot image is generated based only on the latest whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client if the API is called multiple times for the same whiteboard snapshot.
	//
	// **Note: The `LatestMarksOnly` mode takes effect only when the `addSnapshotMark` API is called by using Tencent Interactive Whiteboard SDK v2.6.8 or later. Otherwise, even if this parameter is set to `LatestMarksOnly`, the default `AllMarks` mode is used.**
	SnapshotMode *string `json:"SnapshotMode,omitnil,omitempty" name:"SnapshotMode"`
}

func NewCreateSnapshotTaskRequest 

func NewCreateSnapshotTaskRequest() (request *CreateSnapshotTaskRequest)

func (*CreateSnapshotTaskRequest) FromJsonString 

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

func (r *CreateSnapshotTaskRequest) ToJsonString() string

type CreateSnapshotTaskRequestParams 

type CreateSnapshotTaskRequestParams struct {
	// Whiteboard parameters.
	Whiteboard *SnapshotWhiteboard `json:"Whiteboard,omitnil,omitempty" name:"Whiteboard"`

	// `SdkAppId` of the whiteboard application.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Whiteboard room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Callback URL to which the whiteboard snapshot result is to be sent.
	CallbackURL *string `json:"CallbackURL,omitnil,omitempty" name:"CallbackURL"`

	// `COS` bucket in which the generated whiteboard snapshot file is to be stored. If you leave this parameter empty, the generated file will be stored in the public bucket and retained for only three days.
	COS *SnapshotCOS `json:"COS,omitnil,omitempty" name:"COS"`

	// Whiteboard snapshot mode. Default value: `AllMarks`. Valid values:
	//
	// `AllMarks`: Full mode. In this mode, a snapshot image is generated based on each whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client.
	//
	// `LatestMarksOnly`: Single-page deduplication mode. In this mode, a snapshot image is generated based only on the latest whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client if the API is called multiple times for the same whiteboard snapshot.
	//
	// **Note: The `LatestMarksOnly` mode takes effect only when the `addSnapshotMark` API is called by using Tencent Interactive Whiteboard SDK v2.6.8 or later. Otherwise, even if this parameter is set to `LatestMarksOnly`, the default `AllMarks` mode is used.**
	SnapshotMode *string `json:"SnapshotMode,omitnil,omitempty" name:"SnapshotMode"`
}

Predefined struct for user

type CreateSnapshotTaskResponse 

type CreateSnapshotTaskResponse struct {
	*tchttp.BaseResponse
	Response *CreateSnapshotTaskResponseParams `json:"Response"`
}

func NewCreateSnapshotTaskResponse 

func NewCreateSnapshotTaskResponse() (response *CreateSnapshotTaskResponse)

func (*CreateSnapshotTaskResponse) FromJsonString 

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

func (r *CreateSnapshotTaskResponse) ToJsonString() string

type CreateSnapshotTaskResponseParams 

type CreateSnapshotTaskResponseParams struct {
	// ID of the whiteboard snapshot task. This parameter is returned only if a task is created successfully.
	TaskID *string `json:"TaskID,omitnil,omitempty" name:"TaskID"`

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

Predefined struct for user

type CreateTranscodeRequest 

type CreateTranscodeRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// URL of the transcoded document after URL encoding. URL encoding converts characters into a format that can be transmitted over the Internet. For example, URL encoding can convert the document URL http://example.com/Test.pdf into http://example.com/%E6%B5%8B%E8%AF%95.pdf. To improve the success rate of URL parsing, use URL encoding.
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`

	// Whether the PowerPoint file is static. The default value is False.
	// If IsStaticPPT is False, documents with the .ppt or .pptx extension will be dynamically transcoded to HTML5 pages, and documents with other extensions will be statically transcoded to images. If IsStaticPPT is True, documents with any extensions will be statically transcoded to images.
	IsStaticPPT *bool `json:"IsStaticPPT,omitnil,omitempty" name:"IsStaticPPT"`

	// Note: This parameter is disused. Use the MinScaleResolution parameter to pass in a resolution. For more information, see [CreateTranscode](https://intl.cloud.tencent.com/document/api/1137/40060?from_cn_redirect=1#SDK).
	//
	// Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used.
	//
	// Example: 1280x720. Note that the character between the numbers is the letter x.
	MinResolution *string `json:"MinResolution,omitnil,omitempty" name:"MinResolution"`

	// Resolution of the thumbnail generated for the dynamically transcoded PowerPoint file. If no value or null is specified for it or the resolution format is invalid, no thumbnail will be generated. The resolution format is the same as that of MinResolution.
	//
	// For static transcoding, this parameter does not work.
	ThumbnailResolution *string `json:"ThumbnailResolution,omitnil,omitempty" name:"ThumbnailResolution"`

	// Compression format of the transcoded file. If no value or null is specified for it or the specified format is invalid, no compression file will be generated. Currently, the following compression formats are supported:
	//
	// `zip`: generates a .zip compression package.
	// `tar.gz: generates a .tar.gz compression package.
	CompressFileType *string `json:"CompressFileType,omitnil,omitempty" name:"CompressFileType"`

	// Internal parameter.
	ExtraData *string `json:"ExtraData,omitnil,omitempty" name:"ExtraData"`

	// Document transcoding priority. This parameter takes effect only for PowerPoint dynamic transcoding. Valid values:<br/>
	// - low: Low transcoding priority. The task can transcode at most 500 MB of data or a 2000-page document, with a download timeout no longer than 10 minutes. Due to resource limits, these tasks may have to queue for a long period of time. Consider this before you use this feature.
	// - null: Normal transcoding priority. The task can transcode at most 200 MB of data or a 500-page document, with a download timeout no longer than 2 minutes.
	// <br/>
	// Note: For static transcoding such as PDF transcoding, each task can transcode at most 200 MB of data regardless of the transcoding priority.
	Priority *string `json:"Priority,omitnil,omitempty" name:"Priority"`

	// Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used.
	// Higher resolution brings clearer visual effect, but also means larger size of the transcoded image resources and longer loading time of the transcoded file. Set this parameter appropriately based on your actual scenario.
	//
	// Example: 1280x720. Note that the character between the numbers is the letter x.
	MinScaleResolution *string `json:"MinScaleResolution,omitnil,omitempty" name:"MinScaleResolution"`

	// Specifies whether to enable auto handling of unsupported elements. By default, this feature is disabled.
	//
	// If auto handling is enabled, the following processes are performed:
	// 1. Inkblots: Remove unsupported inkblots, such as those drawn by using WPS.
	// 2. Auto page flip: Clear the auto page clip settings in the PowerPoint file and set the page flip mode to mouse click.
	// 3. Corrupted audio/videos: Remove the references to corrupted audio/videos in the PowerPoint file.
	AutoHandleUnsupportedElement *bool `json:"AutoHandleUnsupportedElement,omitnil,omitempty" name:"AutoHandleUnsupportedElement"`
}

func NewCreateTranscodeRequest 

func NewCreateTranscodeRequest() (request *CreateTranscodeRequest)

func (*CreateTranscodeRequest) FromJsonString 

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

func (r *CreateTranscodeRequest) ToJsonString() string

type CreateTranscodeRequestParams 

type CreateTranscodeRequestParams struct {
	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// URL of the transcoded document after URL encoding. URL encoding converts characters into a format that can be transmitted over the Internet. For example, URL encoding can convert the document URL http://example.com/Test.pdf into http://example.com/%E6%B5%8B%E8%AF%95.pdf. To improve the success rate of URL parsing, use URL encoding.
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`

	// Whether the PowerPoint file is static. The default value is False.
	// If IsStaticPPT is False, documents with the .ppt or .pptx extension will be dynamically transcoded to HTML5 pages, and documents with other extensions will be statically transcoded to images. If IsStaticPPT is True, documents with any extensions will be statically transcoded to images.
	IsStaticPPT *bool `json:"IsStaticPPT,omitnil,omitempty" name:"IsStaticPPT"`

	// Note: This parameter is disused. Use the MinScaleResolution parameter to pass in a resolution. For more information, see [CreateTranscode](https://intl.cloud.tencent.com/document/api/1137/40060?from_cn_redirect=1#SDK).
	//
	// Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used.
	//
	// Example: 1280x720. Note that the character between the numbers is the letter x.
	MinResolution *string `json:"MinResolution,omitnil,omitempty" name:"MinResolution"`

	// Resolution of the thumbnail generated for the dynamically transcoded PowerPoint file. If no value or null is specified for it or the resolution format is invalid, no thumbnail will be generated. The resolution format is the same as that of MinResolution.
	//
	// For static transcoding, this parameter does not work.
	ThumbnailResolution *string `json:"ThumbnailResolution,omitnil,omitempty" name:"ThumbnailResolution"`

	// Compression format of the transcoded file. If no value or null is specified for it or the specified format is invalid, no compression file will be generated. Currently, the following compression formats are supported:
	//
	// `zip`: generates a .zip compression package.
	// `tar.gz: generates a .tar.gz compression package.
	CompressFileType *string `json:"CompressFileType,omitnil,omitempty" name:"CompressFileType"`

	// Internal parameter.
	ExtraData *string `json:"ExtraData,omitnil,omitempty" name:"ExtraData"`

	// Document transcoding priority. This parameter takes effect only for PowerPoint dynamic transcoding. Valid values:<br/>
	// - low: Low transcoding priority. The task can transcode at most 500 MB of data or a 2000-page document, with a download timeout no longer than 10 minutes. Due to resource limits, these tasks may have to queue for a long period of time. Consider this before you use this feature.
	// - null: Normal transcoding priority. The task can transcode at most 200 MB of data or a 500-page document, with a download timeout no longer than 2 minutes.
	// <br/>
	// Note: For static transcoding such as PDF transcoding, each task can transcode at most 200 MB of data regardless of the transcoding priority.
	Priority *string `json:"Priority,omitnil,omitempty" name:"Priority"`

	// Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used.
	// Higher resolution brings clearer visual effect, but also means larger size of the transcoded image resources and longer loading time of the transcoded file. Set this parameter appropriately based on your actual scenario.
	//
	// Example: 1280x720. Note that the character between the numbers is the letter x.
	MinScaleResolution *string `json:"MinScaleResolution,omitnil,omitempty" name:"MinScaleResolution"`

	// Specifies whether to enable auto handling of unsupported elements. By default, this feature is disabled.
	//
	// If auto handling is enabled, the following processes are performed:
	// 1. Inkblots: Remove unsupported inkblots, such as those drawn by using WPS.
	// 2. Auto page flip: Clear the auto page clip settings in the PowerPoint file and set the page flip mode to mouse click.
	// 3. Corrupted audio/videos: Remove the references to corrupted audio/videos in the PowerPoint file.
	AutoHandleUnsupportedElement *bool `json:"AutoHandleUnsupportedElement,omitnil,omitempty" name:"AutoHandleUnsupportedElement"`
}

Predefined struct for user

type CreateTranscodeResponse 

type CreateTranscodeResponse struct {
	*tchttp.BaseResponse
	Response *CreateTranscodeResponseParams `json:"Response"`
}

func NewCreateTranscodeResponse 

func NewCreateTranscodeResponse() (response *CreateTranscodeResponse)

func (*CreateTranscodeResponse) FromJsonString 

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

func (r *CreateTranscodeResponse) ToJsonString() string

type CreateTranscodeResponseParams 

type CreateTranscodeResponseParams struct {
	// Unique ID of the document transcoding task, which is used to query the task progress and transcoding result
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

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

Predefined struct for user

type CreateVideoGenerationTaskRequest 

type CreateVideoGenerationTaskRequest struct {
	*tchttp.BaseRequest

	// ID of the recording task.
	OnlineRecordTaskId *string `json:"OnlineRecordTaskId,omitnil,omitempty" name:"OnlineRecordTaskId"`

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Whiteboard parameters of the recording video generation task, such as the width and height of the whiteboard.
	//
	// This parameter conflicts with the Whiteboard parameter in the API for starting a recording task. If the two Whiteboard parameters are both specified, the Whiteboard parameter in this API takes priority for recording video generation. If the Whiteboard parameter in this API is not specified, the Whiteboard parameter specified in the API for starting a recording task is used for recording video generation.
	Whiteboard *Whiteboard `json:"Whiteboard,omitnil,omitempty" name:"Whiteboard"`

	// Video splicing parameters.
	//
	// This parameter conflicts with the Concat parameter in the API for starting a recording task. If the two Concat parameters are both specified, the Concat parameter in this API takes priority for video splicing. If the Concat parameter in this API is not specified, the Concat parameter specified in the API for starting a recording task is used for video splicing.
	Concat *Concat `json:"Concat,omitnil,omitempty" name:"Concat"`

	// Video stream mixing parameters.
	//
	// This parameter conflicts with the MixStream parameter in the API for starting a recording task. If the two MixStream parameters are both specified, the MixStream parameter in this API takes priority for video stream mixing. If the MixStream parameter in this API is not specified, the MixStream parameter specified in the API for starting a recording task is used for video stream mixing.
	MixStream *MixStream `json:"MixStream,omitnil,omitempty" name:"MixStream"`

	// A group of video generation parameters. It specifies the streams to be generated, whether to disable audio recording for a stream, and whether to record only low-resolution videos, etc.
	//
	// This parameter conflicts with the RecordControl parameter in the API for starting a recording task. If the two RecordControl parameters are both specified, the RecordControl parameter in this API takes priority for video generation control. If the RecordControl parameter in this API is not specified, the RecordControl parameter specified in the API for starting a recording task is used for video generation control.
	RecordControl *RecordControl `json:"RecordControl,omitnil,omitempty" name:"RecordControl"`

	// Internal parameter.
	ExtraData *string `json:"ExtraData,omitnil,omitempty" name:"ExtraData"`
}

func NewCreateVideoGenerationTaskRequest 

func NewCreateVideoGenerationTaskRequest() (request *CreateVideoGenerationTaskRequest)

func (*CreateVideoGenerationTaskRequest) FromJsonString 

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

func (r *CreateVideoGenerationTaskRequest) ToJsonString() string

type CreateVideoGenerationTaskRequestParams 

type CreateVideoGenerationTaskRequestParams struct {
	// ID of the recording task.
	OnlineRecordTaskId *string `json:"OnlineRecordTaskId,omitnil,omitempty" name:"OnlineRecordTaskId"`

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Whiteboard parameters of the recording video generation task, such as the width and height of the whiteboard.
	//
	// This parameter conflicts with the Whiteboard parameter in the API for starting a recording task. If the two Whiteboard parameters are both specified, the Whiteboard parameter in this API takes priority for recording video generation. If the Whiteboard parameter in this API is not specified, the Whiteboard parameter specified in the API for starting a recording task is used for recording video generation.
	Whiteboard *Whiteboard `json:"Whiteboard,omitnil,omitempty" name:"Whiteboard"`

	// Video splicing parameters.
	//
	// This parameter conflicts with the Concat parameter in the API for starting a recording task. If the two Concat parameters are both specified, the Concat parameter in this API takes priority for video splicing. If the Concat parameter in this API is not specified, the Concat parameter specified in the API for starting a recording task is used for video splicing.
	Concat *Concat `json:"Concat,omitnil,omitempty" name:"Concat"`

	// Video stream mixing parameters.
	//
	// This parameter conflicts with the MixStream parameter in the API for starting a recording task. If the two MixStream parameters are both specified, the MixStream parameter in this API takes priority for video stream mixing. If the MixStream parameter in this API is not specified, the MixStream parameter specified in the API for starting a recording task is used for video stream mixing.
	MixStream *MixStream `json:"MixStream,omitnil,omitempty" name:"MixStream"`

	// A group of video generation parameters. It specifies the streams to be generated, whether to disable audio recording for a stream, and whether to record only low-resolution videos, etc.
	//
	// This parameter conflicts with the RecordControl parameter in the API for starting a recording task. If the two RecordControl parameters are both specified, the RecordControl parameter in this API takes priority for video generation control. If the RecordControl parameter in this API is not specified, the RecordControl parameter specified in the API for starting a recording task is used for video generation control.
	RecordControl *RecordControl `json:"RecordControl,omitnil,omitempty" name:"RecordControl"`

	// Internal parameter.
	ExtraData *string `json:"ExtraData,omitnil,omitempty" name:"ExtraData"`
}

Predefined struct for user

type CreateVideoGenerationTaskResponse 

type CreateVideoGenerationTaskResponse struct {
	*tchttp.BaseResponse
	Response *CreateVideoGenerationTaskResponseParams `json:"Response"`
}

func NewCreateVideoGenerationTaskResponse 

func NewCreateVideoGenerationTaskResponse() (response *CreateVideoGenerationTaskResponse)

func (*CreateVideoGenerationTaskResponse) FromJsonString 

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

func (r *CreateVideoGenerationTaskResponse) ToJsonString() string

type CreateVideoGenerationTaskResponseParams 

type CreateVideoGenerationTaskResponseParams struct {
	// ID of the video generation task.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

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

Predefined struct for user

type CustomLayout 

type CustomLayout struct {
	// Mixed stream canvas parameter
	Canvas *Canvas `json:"Canvas,omitnil,omitempty" name:"Canvas"`

	// Stream layout. The layout of each stream cannot exceed the canvas area.
	InputStreamList []*StreamLayout `json:"InputStreamList,omitnil,omitempty" name:"InputStreamList"`
}

type DataItem 

type DataItem struct {
	// Time. The following formats are supported:
	// yyyy-mm
	// yyyy-mm-dd
	// yyyy-mm-dd HH:MM:SS
	Time *string `json:"Time,omitnil,omitempty" name:"Time"`

	// Values required for drawing charts.
	Value *int64 `json:"Value,omitnil,omitempty" name:"Value"`

	// Details of the values.
	Details []*Detail `json:"Details,omitnil,omitempty" name:"Details"`
}

type DescribeAPIServiceRequest 

type DescribeAPIServiceRequest struct {
	*tchttp.BaseRequest

	// Supported services are cos:GetService and cdn:DescribeDomainsConfig.
	Service *string `json:"Service,omitnil,omitempty" name:"Service"`

	// Request parameters in JSON format.
	Data *string `json:"Data,omitnil,omitempty" name:"Data"`
}

func NewDescribeAPIServiceRequest 

func NewDescribeAPIServiceRequest() (request *DescribeAPIServiceRequest)

func (*DescribeAPIServiceRequest) FromJsonString 

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

func (r *DescribeAPIServiceRequest) ToJsonString() string

type DescribeAPIServiceRequestParams 

type DescribeAPIServiceRequestParams struct {
	// Supported services are cos:GetService and cdn:DescribeDomainsConfig.
	Service *string `json:"Service,omitnil,omitempty" name:"Service"`

	// Request parameters in JSON format.
	Data *string `json:"Data,omitnil,omitempty" name:"Data"`
}

Predefined struct for user

type DescribeAPIServiceResponse 

type DescribeAPIServiceResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAPIServiceResponseParams `json:"Response"`
}

func NewDescribeAPIServiceResponse 

func NewDescribeAPIServiceResponse() (response *DescribeAPIServiceResponse)

func (*DescribeAPIServiceResponse) FromJsonString 

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

func (r *DescribeAPIServiceResponse) ToJsonString() string

type DescribeAPIServiceResponseParams 

type DescribeAPIServiceResponseParams struct {
	// Response data in JSON format.
	ResponseData *string `json:"ResponseData,omitnil,omitempty" name:"ResponseData"`

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

Predefined struct for user

type DescribeApplicationInfosRequest 

type DescribeApplicationInfosRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeApplicationInfosRequest 

func NewDescribeApplicationInfosRequest() (request *DescribeApplicationInfosRequest)

func (*DescribeApplicationInfosRequest) FromJsonString 

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

func (r *DescribeApplicationInfosRequest) ToJsonString() string

type DescribeApplicationInfosRequestParams 

type DescribeApplicationInfosRequestParams struct {
}

Predefined struct for user

type DescribeApplicationInfosResponse 

type DescribeApplicationInfosResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApplicationInfosResponseParams `json:"Response"`
}

func NewDescribeApplicationInfosResponse 

func NewDescribeApplicationInfosResponse() (response *DescribeApplicationInfosResponse)

func (*DescribeApplicationInfosResponse) FromJsonString 

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

func (r *DescribeApplicationInfosResponse) ToJsonString() string

type DescribeApplicationInfosResponseParams 

type DescribeApplicationInfosResponseParams struct {
	// Application list.
	ApplicationInfos []*ApplicationItem `json:"ApplicationInfos,omitnil,omitempty" name:"ApplicationInfos"`

	// Specifies whether all applications are included. The value 0 indicates no and 1 indicates yes.
	AllOption *int64 `json:"AllOption,omitnil,omitempty" name:"AllOption"`

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

Predefined struct for user

type DescribeApplicationUsageRequest 

type DescribeApplicationUsageRequest struct {
	*tchttp.BaseRequest

	// Start time of the query period. The start time point is included in the query period.
	BeginTime *string `json:"BeginTime,omitnil,omitempty" name:"BeginTime"`

	// End time of the query period. The end time point is not included in the query period.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// Subproduct name.
	SubProduct *string `json:"SubProduct,omitnil,omitempty" name:"SubProduct"`

	// Unit of time increment.
	// - MONTHLY: month
	// - DAILY: day
	// - MINUTELY: minute
	TimeLevel *string `json:"TimeLevel,omitnil,omitempty" name:"TimeLevel"`

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// true: Returns the weighted sum of raw usage data.
	// false: Returns the raw usage data.
	IsWeighted *bool `json:"IsWeighted,omitnil,omitempty" name:"IsWeighted"`
}

func NewDescribeApplicationUsageRequest 

func NewDescribeApplicationUsageRequest() (request *DescribeApplicationUsageRequest)

func (*DescribeApplicationUsageRequest) FromJsonString 

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

func (r *DescribeApplicationUsageRequest) ToJsonString() string

type DescribeApplicationUsageRequestParams 

type DescribeApplicationUsageRequestParams struct {
	// Start time of the query period. The start time point is included in the query period.
	BeginTime *string `json:"BeginTime,omitnil,omitempty" name:"BeginTime"`

	// End time of the query period. The end time point is not included in the query period.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// Subproduct name.
	SubProduct *string `json:"SubProduct,omitnil,omitempty" name:"SubProduct"`

	// Unit of time increment.
	// - MONTHLY: month
	// - DAILY: day
	// - MINUTELY: minute
	TimeLevel *string `json:"TimeLevel,omitnil,omitempty" name:"TimeLevel"`

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// true: Returns the weighted sum of raw usage data.
	// false: Returns the raw usage data.
	IsWeighted *bool `json:"IsWeighted,omitnil,omitempty" name:"IsWeighted"`
}

Predefined struct for user

type DescribeApplicationUsageResponse 

type DescribeApplicationUsageResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApplicationUsageResponseParams `json:"Response"`
}

func NewDescribeApplicationUsageResponse 

func NewDescribeApplicationUsageResponse() (response *DescribeApplicationUsageResponse)

func (*DescribeApplicationUsageResponse) FromJsonString 

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

func (r *DescribeApplicationUsageResponse) ToJsonString() string

type DescribeApplicationUsageResponseParams 

type DescribeApplicationUsageResponseParams struct {
	// Usage data required for drawing charts.
	Data []*DataItem `json:"Data,omitnil,omitempty" name:"Data"`

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

Predefined struct for user

type DescribeBoardSDKLogRequest 

type DescribeBoardSDKLogRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Room ID to be used to query logs.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// User ID to be used to query logs.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Query period, which consists of two Unix timestamps in milliseconds. The first indicates the start time and the second the end time.
	TimeRange []*int64 `json:"TimeRange,omitnil,omitempty" name:"TimeRange"`

	// Interval for aggregating log number queries. Example values: `5m`, `1h`, `4h`
	AggregationInterval *string `json:"AggregationInterval,omitnil,omitempty" name:"AggregationInterval"`

	// Extra query conditions.
	Query *string `json:"Query,omitnil,omitempty" name:"Query"`

	// Specifies whether to sort results in ascending order of time.
	Ascending *bool `json:"Ascending,omitnil,omitempty" name:"Ascending"`

	// Context key used for recursive extraction. Obtain this parameter in the response to the last request.
	Context *string `json:"Context,omitnil,omitempty" name:"Context"`
}

func NewDescribeBoardSDKLogRequest 

func NewDescribeBoardSDKLogRequest() (request *DescribeBoardSDKLogRequest)

func (*DescribeBoardSDKLogRequest) FromJsonString 

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

func (r *DescribeBoardSDKLogRequest) ToJsonString() string

type DescribeBoardSDKLogRequestParams 

type DescribeBoardSDKLogRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Room ID to be used to query logs.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// User ID to be used to query logs.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Query period, which consists of two Unix timestamps in milliseconds. The first indicates the start time and the second the end time.
	TimeRange []*int64 `json:"TimeRange,omitnil,omitempty" name:"TimeRange"`

	// Interval for aggregating log number queries. Example values: `5m`, `1h`, `4h`
	AggregationInterval *string `json:"AggregationInterval,omitnil,omitempty" name:"AggregationInterval"`

	// Extra query conditions.
	Query *string `json:"Query,omitnil,omitempty" name:"Query"`

	// Specifies whether to sort results in ascending order of time.
	Ascending *bool `json:"Ascending,omitnil,omitempty" name:"Ascending"`

	// Context key used for recursive extraction. Obtain this parameter in the response to the last request.
	Context *string `json:"Context,omitnil,omitempty" name:"Context"`
}

Predefined struct for user

type DescribeBoardSDKLogResponse 

type DescribeBoardSDKLogResponse struct {
	*tchttp.BaseResponse
	Response *DescribeBoardSDKLogResponseParams `json:"Response"`
}

func NewDescribeBoardSDKLogResponse 

func NewDescribeBoardSDKLogResponse() (response *DescribeBoardSDKLogResponse)

func (*DescribeBoardSDKLogResponse) FromJsonString 

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

func (r *DescribeBoardSDKLogResponse) ToJsonString() string

type DescribeBoardSDKLogResponseParams 

type DescribeBoardSDKLogResponseParams struct {
	// Number of logs queried.
	Total *int64 `json:"Total,omitnil,omitempty" name:"Total"`

	// Log details.
	Sources []*string `json:"Sources,omitnil,omitempty" name:"Sources"`

	// Number of logs queried within each time range after aggregation based on the time range.
	Buckets []*string `json:"Buckets,omitnil,omitempty" name:"Buckets"`

	// Context key used for recursive extraction. This parameter can be used in the next request.
	Context *string `json:"Context,omitnil,omitempty" name:"Context"`

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

Predefined struct for user

type DescribeIMApplicationsRequest 

type DescribeIMApplicationsRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeIMApplicationsRequest 

func NewDescribeIMApplicationsRequest() (request *DescribeIMApplicationsRequest)

func (*DescribeIMApplicationsRequest) FromJsonString 

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

func (r *DescribeIMApplicationsRequest) ToJsonString() string

type DescribeIMApplicationsRequestParams 

type DescribeIMApplicationsRequestParams struct {
}

Predefined struct for user

type DescribeIMApplicationsResponse 

type DescribeIMApplicationsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeIMApplicationsResponseParams `json:"Response"`
}

func NewDescribeIMApplicationsResponse 

func NewDescribeIMApplicationsResponse() (response *DescribeIMApplicationsResponse)

func (*DescribeIMApplicationsResponse) FromJsonString 

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

func (r *DescribeIMApplicationsResponse) ToJsonString() string

type DescribeIMApplicationsResponseParams 

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

Predefined struct for user

type DescribeOnlineRecordCallbackRequest 

type DescribeOnlineRecordCallbackRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the application
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDescribeOnlineRecordCallbackRequest 

func NewDescribeOnlineRecordCallbackRequest() (request *DescribeOnlineRecordCallbackRequest)

func (*DescribeOnlineRecordCallbackRequest) FromJsonString 

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

func (r *DescribeOnlineRecordCallbackRequest) ToJsonString() string

type DescribeOnlineRecordCallbackRequestParams 

type DescribeOnlineRecordCallbackRequestParams struct {
	// SdkAppId of the application
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DescribeOnlineRecordCallbackResponse 

type DescribeOnlineRecordCallbackResponse struct {
	*tchttp.BaseResponse
	Response *DescribeOnlineRecordCallbackResponseParams `json:"Response"`
}

func NewDescribeOnlineRecordCallbackResponse 

func NewDescribeOnlineRecordCallbackResponse() (response *DescribeOnlineRecordCallbackResponse)

func (*DescribeOnlineRecordCallbackResponse) FromJsonString 

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

func (r *DescribeOnlineRecordCallbackResponse) ToJsonString() string

type DescribeOnlineRecordCallbackResponseParams 

type DescribeOnlineRecordCallbackResponseParams struct {
	// Callback address of the real-time recording event. If no callback address is set, this field is null.
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`

	// Authentication key of the real-time recording callback
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`

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

Predefined struct for user

type DescribeOnlineRecordRequest 

type DescribeOnlineRecordRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the real-time recording task
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewDescribeOnlineRecordRequest 

func NewDescribeOnlineRecordRequest() (request *DescribeOnlineRecordRequest)

func (*DescribeOnlineRecordRequest) FromJsonString 

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

func (r *DescribeOnlineRecordRequest) ToJsonString() string

type DescribeOnlineRecordRequestParams 

type DescribeOnlineRecordRequestParams struct {
	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the real-time recording task
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type DescribeOnlineRecordResponse 

type DescribeOnlineRecordResponse struct {
	*tchttp.BaseResponse
	Response *DescribeOnlineRecordResponseParams `json:"Response"`
}

func NewDescribeOnlineRecordResponse 

func NewDescribeOnlineRecordResponse() (response *DescribeOnlineRecordResponse)

func (*DescribeOnlineRecordResponse) FromJsonString 

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

func (r *DescribeOnlineRecordResponse) ToJsonString() string

type DescribeOnlineRecordResponseParams 

type DescribeOnlineRecordResponseParams struct {
	// Recording stop reason
	// - AUTO: Recording automatically stops because no upstream audio/video or whiteboard operation occurs in the room for a long time.
	// - USER_CALL: The API for stopping recording is called.
	// - EXCEPTION: An exception occurred.
	// - FORCE_STOP: Recording is forcibly stopped, which is usually because the recording has been paused for more than 90 minutes or has lasted for more than 24 hours.
	FinishReason *string `json:"FinishReason,omitnil,omitempty" name:"FinishReason"`

	// ID of the recording task to be queried.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// Recording task status
	// - PREPARED: preparing
	// - RECORDING: recording
	// - PAUSED: recording is paused.
	// - STOPPED: recording is stopped, and the recorded video is being processed and uploaded.
	// - FINISHED: the recorded video has been processed and uploaded, and the recording result is generated.
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

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

	// Group ID of the whiteboard
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// ID of the recording user
	RecordUserId *string `json:"RecordUserId,omitnil,omitempty" name:"RecordUserId"`

	// Actual recording start time, which is a UNIX timestamp in seconds
	RecordStartTime *int64 `json:"RecordStartTime,omitnil,omitempty" name:"RecordStartTime"`

	// Actual recording stop time, which is a UNIX timestamp in seconds
	RecordStopTime *int64 `json:"RecordStopTime,omitnil,omitempty" name:"RecordStopTime"`

	// Total video playback duration, in milliseconds
	TotalTime *int64 `json:"TotalTime,omitnil,omitempty" name:"TotalTime"`

	// Number of exceptions during recording
	ExceptionCnt *int64 `json:"ExceptionCnt,omitnil,omitempty" name:"ExceptionCnt"`

	// Duration to be deleted in the spliced video. This parameter is valid only when the video splicing feature is enabled.
	OmittedDurations []*OmittedDuration `json:"OmittedDurations,omitnil,omitempty" name:"OmittedDurations"`

	// List of recorded videos
	VideoInfos []*VideoInfo `json:"VideoInfos,omitnil,omitempty" name:"VideoInfos"`

	ReplayUrl *string `json:"ReplayUrl,omitnil,omitempty" name:"ReplayUrl"`

	// Number of video stream interruptions during recording.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	Interrupts []*Interrupt `json:"Interrupts,omitnil,omitempty" name:"Interrupts"`

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

Predefined struct for user

type DescribePostpaidUsageRequest 

type DescribePostpaidUsageRequest struct {
	*tchttp.BaseRequest

	// Start time of the query period.
	BeginTime *string `json:"BeginTime,omitnil,omitempty" name:"BeginTime"`

	// End time of the query period.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`
}

func NewDescribePostpaidUsageRequest 

func NewDescribePostpaidUsageRequest() (request *DescribePostpaidUsageRequest)

func (*DescribePostpaidUsageRequest) FromJsonString 

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

func (r *DescribePostpaidUsageRequest) ToJsonString() string

type DescribePostpaidUsageRequestParams 

type DescribePostpaidUsageRequestParams struct {
	// Start time of the query period.
	BeginTime *string `json:"BeginTime,omitnil,omitempty" name:"BeginTime"`

	// End time of the query period.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`
}

Predefined struct for user

type DescribePostpaidUsageResponse 

type DescribePostpaidUsageResponse struct {
	*tchttp.BaseResponse
	Response *DescribePostpaidUsageResponseParams `json:"Response"`
}

func NewDescribePostpaidUsageResponse 

func NewDescribePostpaidUsageResponse() (response *DescribePostpaidUsageResponse)

func (*DescribePostpaidUsageResponse) FromJsonString 

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

func (r *DescribePostpaidUsageResponse) ToJsonString() string

type DescribePostpaidUsageResponseParams 

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

Predefined struct for user

type DescribeQualityMetricsRequest 

type DescribeQualityMetricsRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Start time, which is a Unix timestamp in seconds. The time length cannot exceed seven days.
	StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// End time, which is a Unix timestamp in seconds. The time length cannot exceed seven days.
	EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// Metrics to be queried. Valid values:
	//   - image_load_total_count: The number of image loads.
	//   - image_load_fail_count: The number of image load failures.
	//   - image_load_success_rate: The success rate of image loading, in percentage.
	//   - ppt_load_total_count: The number of PowerPoint file loads.
	//   - ppt_load_fail_count: The number of PowerPoint file load failures.
	//   - ppt_load_success_rate: The success rate of PowerPoint file loading, in percentage.
	//   - verify_sdk_total_count: The number of SDK verifications.
	//   - verify_sdk_fail_count: The number of SDK verification failures.
	//   - verify_sdk_success_rate: The success rate of SDK verification, in percentage.
	//   - verify_sdk_in_one_second_rate: The rate of SDK verification completed within one second, in percentage.
	//   - verify_sdk_cost_avg: The average time taken by each SDK verification, in milliseconds.
	Metric *string `json:"Metric,omitnil,omitempty" name:"Metric"`

	// Aggregation interval. Valid value: `1h`.
	Interval *string `json:"Interval,omitnil,omitempty" name:"Interval"`
}

func NewDescribeQualityMetricsRequest 

func NewDescribeQualityMetricsRequest() (request *DescribeQualityMetricsRequest)

func (*DescribeQualityMetricsRequest) FromJsonString 

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

func (r *DescribeQualityMetricsRequest) ToJsonString() string

type DescribeQualityMetricsRequestParams 

type DescribeQualityMetricsRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Start time, which is a Unix timestamp in seconds. The time length cannot exceed seven days.
	StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// End time, which is a Unix timestamp in seconds. The time length cannot exceed seven days.
	EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// Metrics to be queried. Valid values:
	//   - image_load_total_count: The number of image loads.
	//   - image_load_fail_count: The number of image load failures.
	//   - image_load_success_rate: The success rate of image loading, in percentage.
	//   - ppt_load_total_count: The number of PowerPoint file loads.
	//   - ppt_load_fail_count: The number of PowerPoint file load failures.
	//   - ppt_load_success_rate: The success rate of PowerPoint file loading, in percentage.
	//   - verify_sdk_total_count: The number of SDK verifications.
	//   - verify_sdk_fail_count: The number of SDK verification failures.
	//   - verify_sdk_success_rate: The success rate of SDK verification, in percentage.
	//   - verify_sdk_in_one_second_rate: The rate of SDK verification completed within one second, in percentage.
	//   - verify_sdk_cost_avg: The average time taken by each SDK verification, in milliseconds.
	Metric *string `json:"Metric,omitnil,omitempty" name:"Metric"`

	// Aggregation interval. Valid value: `1h`.
	Interval *string `json:"Interval,omitnil,omitempty" name:"Interval"`
}

Predefined struct for user

type DescribeQualityMetricsResponse 

type DescribeQualityMetricsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeQualityMetricsResponseParams `json:"Response"`
}

func NewDescribeQualityMetricsResponse 

func NewDescribeQualityMetricsResponse() (response *DescribeQualityMetricsResponse)

func (*DescribeQualityMetricsResponse) FromJsonString 

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

func (r *DescribeQualityMetricsResponse) ToJsonString() string

type DescribeQualityMetricsResponseParams 

type DescribeQualityMetricsResponseParams struct {
	// Query metrics.
	Metric *string `json:"Metric,omitnil,omitempty" name:"Metric"`

	// Time series.
	Content []*TimeValue `json:"Content,omitnil,omitempty" name:"Content"`

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

Predefined struct for user

type DescribeRecordSearchRequest 

type DescribeRecordSearchRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeRecordSearchRequest 

func NewDescribeRecordSearchRequest() (request *DescribeRecordSearchRequest)

func (*DescribeRecordSearchRequest) FromJsonString 

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

func (r *DescribeRecordSearchRequest) ToJsonString() string

type DescribeRecordSearchRequestParams 

type DescribeRecordSearchRequestParams struct {
}

Predefined struct for user

type DescribeRecordSearchResponse 

type DescribeRecordSearchResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRecordSearchResponseParams `json:"Response"`
}

func NewDescribeRecordSearchResponse 

func NewDescribeRecordSearchResponse() (response *DescribeRecordSearchResponse)

func (*DescribeRecordSearchResponse) FromJsonString 

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

func (r *DescribeRecordSearchResponse) ToJsonString() string

type DescribeRecordSearchResponseParams 

type DescribeRecordSearchResponseParams struct {
	// The set of queried recording tasks.
	RecordTaskSet []*RecordTaskSearchResult `json:"RecordTaskSet,omitnil,omitempty" name:"RecordTaskSet"`

	// Number of recording tasks.
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

Predefined struct for user

type DescribeRoomListRequest 

type DescribeRoomListRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Query period, which consists of two Unix timestamps in milliseconds. The first indicates the start time and the second the end time.
	TimeRange []*int64 `json:"TimeRange,omitnil,omitempty" name:"TimeRange"`

	// Extra query conditions.
	Query *string `json:"Query,omitnil,omitempty" name:"Query"`

	// Maximum number of data entries to be returned. Default value: 1000.
	MaxSize *int64 `json:"MaxSize,omitnil,omitempty" name:"MaxSize"`
}

func NewDescribeRoomListRequest 

func NewDescribeRoomListRequest() (request *DescribeRoomListRequest)

func (*DescribeRoomListRequest) FromJsonString 

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

func (r *DescribeRoomListRequest) ToJsonString() string

type DescribeRoomListRequestParams 

type DescribeRoomListRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Query period, which consists of two Unix timestamps in milliseconds. The first indicates the start time and the second the end time.
	TimeRange []*int64 `json:"TimeRange,omitnil,omitempty" name:"TimeRange"`

	// Extra query conditions.
	Query *string `json:"Query,omitnil,omitempty" name:"Query"`

	// Maximum number of data entries to be returned. Default value: 1000.
	MaxSize *int64 `json:"MaxSize,omitnil,omitempty" name:"MaxSize"`
}

Predefined struct for user

type DescribeRoomListResponse 

type DescribeRoomListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRoomListResponseParams `json:"Response"`
}

func NewDescribeRoomListResponse 

func NewDescribeRoomListResponse() (response *DescribeRoomListResponse)

func (*DescribeRoomListResponse) FromJsonString 

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

func (r *DescribeRoomListResponse) ToJsonString() string

type DescribeRoomListResponseParams 

type DescribeRoomListResponseParams struct {
	// List of rooms of the whiteboard.
	RoomList []*RoomListItem `json:"RoomList,omitnil,omitempty" name:"RoomList"`

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

Predefined struct for user

type DescribeSnapshotTaskRequest 

type DescribeSnapshotTaskRequest struct {
	*tchttp.BaseRequest

	// ID of the query task.
	TaskID *string `json:"TaskID,omitnil,omitempty" name:"TaskID"`

	// SdkAppId of the task.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDescribeSnapshotTaskRequest 

func NewDescribeSnapshotTaskRequest() (request *DescribeSnapshotTaskRequest)

func (*DescribeSnapshotTaskRequest) FromJsonString 

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

func (r *DescribeSnapshotTaskRequest) ToJsonString() string

type DescribeSnapshotTaskRequestParams 

type DescribeSnapshotTaskRequestParams struct {
	// ID of the query task.
	TaskID *string `json:"TaskID,omitnil,omitempty" name:"TaskID"`

	// SdkAppId of the task.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DescribeSnapshotTaskResponse 

type DescribeSnapshotTaskResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSnapshotTaskResponseParams `json:"Response"`
}

func NewDescribeSnapshotTaskResponse 

func NewDescribeSnapshotTaskResponse() (response *DescribeSnapshotTaskResponse)

func (*DescribeSnapshotTaskResponse) FromJsonString 

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

func (r *DescribeSnapshotTaskResponse) ToJsonString() string

type DescribeSnapshotTaskResponseParams 

type DescribeSnapshotTaskResponseParams struct {
	// Task ID.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	TaskID *string `json:"TaskID,omitnil,omitempty" name:"TaskID"`

	// Task status.
	// Running: The task is running.
	// Finished: The task is finished.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Creation time of the task. Unit: seconds.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// Completion time of the task. Unit: seconds.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	FinishTime *uint64 `json:"FinishTime,omitnil,omitempty" name:"FinishTime"`

	// Task result information.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	Result *SnapshotResult `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeTIWDailyUsageRequest 

type DescribeTIWDailyUsageRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Subproduct usage to be queried. The following parameters are supported:
	// - sp_tiw_board: The duration of use of whiteboards, in minutes.
	// - sp_tiw_dt: The number of pages dynamically transcoded.
	// - sp_tiw_st: The number of pages statically transcoded.
	// - sp_tiw_ric: The duration of real-time recording, in minutes.
	//
	// Note: Dynamic transcoding multiplies the number of pages of a document by eight times. Static transcoding does not change the number of pages of a document.
	SubProduct *string `json:"SubProduct,omitnil,omitempty" name:"SubProduct"`

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

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

func NewDescribeTIWDailyUsageRequest 

func NewDescribeTIWDailyUsageRequest() (request *DescribeTIWDailyUsageRequest)

func (*DescribeTIWDailyUsageRequest) FromJsonString 

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

func (r *DescribeTIWDailyUsageRequest) ToJsonString() string

type DescribeTIWDailyUsageRequestParams 

type DescribeTIWDailyUsageRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Subproduct usage to be queried. The following parameters are supported:
	// - sp_tiw_board: The duration of use of whiteboards, in minutes.
	// - sp_tiw_dt: The number of pages dynamically transcoded.
	// - sp_tiw_st: The number of pages statically transcoded.
	// - sp_tiw_ric: The duration of real-time recording, in minutes.
	//
	// Note: Dynamic transcoding multiplies the number of pages of a document by eight times. Static transcoding does not change the number of pages of a document.
	SubProduct *string `json:"SubProduct,omitnil,omitempty" name:"SubProduct"`

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

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

Predefined struct for user

type DescribeTIWDailyUsageResponse 

type DescribeTIWDailyUsageResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTIWDailyUsageResponseParams `json:"Response"`
}

func NewDescribeTIWDailyUsageResponse 

func NewDescribeTIWDailyUsageResponse() (response *DescribeTIWDailyUsageResponse)

func (*DescribeTIWDailyUsageResponse) FromJsonString 

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

func (r *DescribeTIWDailyUsageResponse) ToJsonString() string

type DescribeTIWDailyUsageResponseParams 

type DescribeTIWDailyUsageResponseParams struct {
	// Usage summary of a specified product during a specified query period.
	Usages []*UsageDataItem `json:"Usages,omitnil,omitempty" name:"Usages"`

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

Predefined struct for user

type DescribeTIWRoomDailyUsageRequest 

type DescribeTIWRoomDailyUsageRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Subproduct usage to be queried. The following parameters are supported:
	// - sp_tiw_board: The duration of use of whiteboards, in minutes.
	// - sp_tiw_ric: The duration of real-time recording, in minutes.
	SubProduct *string `json:"SubProduct,omitnil,omitempty" name:"SubProduct"`

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

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

	// Room IDs to be queried. If you leave this parameter empty, all room IDs are queried.
	RoomIDs []*uint64 `json:"RoomIDs,omitnil,omitempty" name:"RoomIDs"`

	// Offset for query. Default value: `0`.
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// Maximum number of entries returned per query. Default value: `20`.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeTIWRoomDailyUsageRequest 

func NewDescribeTIWRoomDailyUsageRequest() (request *DescribeTIWRoomDailyUsageRequest)

func (*DescribeTIWRoomDailyUsageRequest) FromJsonString 

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

func (r *DescribeTIWRoomDailyUsageRequest) ToJsonString() string

type DescribeTIWRoomDailyUsageRequestParams 

type DescribeTIWRoomDailyUsageRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Subproduct usage to be queried. The following parameters are supported:
	// - sp_tiw_board: The duration of use of whiteboards, in minutes.
	// - sp_tiw_ric: The duration of real-time recording, in minutes.
	SubProduct *string `json:"SubProduct,omitnil,omitempty" name:"SubProduct"`

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

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

	// Room IDs to be queried. If you leave this parameter empty, all room IDs are queried.
	RoomIDs []*uint64 `json:"RoomIDs,omitnil,omitempty" name:"RoomIDs"`

	// Offset for query. Default value: `0`.
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// Maximum number of entries returned per query. Default value: `20`.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeTIWRoomDailyUsageResponse 

type DescribeTIWRoomDailyUsageResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTIWRoomDailyUsageResponseParams `json:"Response"`
}

func NewDescribeTIWRoomDailyUsageResponse 

func NewDescribeTIWRoomDailyUsageResponse() (response *DescribeTIWRoomDailyUsageResponse)

func (*DescribeTIWRoomDailyUsageResponse) FromJsonString 

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

func (r *DescribeTIWRoomDailyUsageResponse) ToJsonString() string

type DescribeTIWRoomDailyUsageResponseParams 

type DescribeTIWRoomDailyUsageResponseParams struct {
	// Usage of the specified product per room during the specified query period.
	Usages []*RoomUsageDataItem `json:"Usages,omitnil,omitempty" name:"Usages"`

	// Number of usage data entries.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

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

Predefined struct for user

type DescribeTranscodeCallbackRequest 

type DescribeTranscodeCallbackRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the application
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDescribeTranscodeCallbackRequest 

func NewDescribeTranscodeCallbackRequest() (request *DescribeTranscodeCallbackRequest)

func (*DescribeTranscodeCallbackRequest) FromJsonString 

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

func (r *DescribeTranscodeCallbackRequest) ToJsonString() string

type DescribeTranscodeCallbackRequestParams 

type DescribeTranscodeCallbackRequestParams struct {
	// SdkAppId of the application
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DescribeTranscodeCallbackResponse 

type DescribeTranscodeCallbackResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTranscodeCallbackResponseParams `json:"Response"`
}

func NewDescribeTranscodeCallbackResponse 

func NewDescribeTranscodeCallbackResponse() (response *DescribeTranscodeCallbackResponse)

func (*DescribeTranscodeCallbackResponse) FromJsonString 

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

func (r *DescribeTranscodeCallbackResponse) ToJsonString() string

type DescribeTranscodeCallbackResponseParams 

type DescribeTranscodeCallbackResponseParams struct {
	// Document transcoding callback address
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`

	// Authentication key of the document transcoding callback
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`

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

Predefined struct for user

type DescribeTranscodeRequest 

type DescribeTranscodeRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Unique ID of the document transcoding task
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewDescribeTranscodeRequest 

func NewDescribeTranscodeRequest() (request *DescribeTranscodeRequest)

func (*DescribeTranscodeRequest) FromJsonString 

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

func (r *DescribeTranscodeRequest) ToJsonString() string

type DescribeTranscodeRequestParams 

type DescribeTranscodeRequestParams struct {
	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Unique ID of the document transcoding task
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type DescribeTranscodeResponse 

type DescribeTranscodeResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTranscodeResponseParams `json:"Response"`
}

func NewDescribeTranscodeResponse 

func NewDescribeTranscodeResponse() (response *DescribeTranscodeResponse)

func (*DescribeTranscodeResponse) FromJsonString 

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

func (r *DescribeTranscodeResponse) ToJsonString() string

type DescribeTranscodeResponseParams 

type DescribeTranscodeResponseParams struct {
	// Total number of document pages
	Pages *int64 `json:"Pages,omitnil,omitempty" name:"Pages"`

	// Transcoding progress. Value range: 0 to 100
	Progress *int64 `json:"Progress,omitnil,omitempty" name:"Progress"`

	// Document resolution
	Resolution *string `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// URL of the transcoding result
	// Dynamic transcoding: link of the HTML5 page transcoded from a PowerPoint file
	// Static transcoding: URL prefix of the image transcoded for each document page. For example, if the URL prefix is `http://example.com/g0jb42ps49vtebjshilb/`, the image URL of the first page is
	// `http://example.com/g0jb42ps49vtebjshilb/1.jpg`, and so on.
	ResultUrl *string `json:"ResultUrl,omitnil,omitempty" name:"ResultUrl"`

	// Current task state
	// - QUEUED: queuing for transcoding
	// - PROCESSING: transcoding is in progress
	// - FINISHED: transcoded
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Unique ID of the transcoding task
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// Document name
	Title *string `json:"Title,omitnil,omitempty" name:"Title"`

	// URL prefix of the thumbnail. If the URL prefix is `http://example.com/g0jb42ps49vtebjshilb/ `, the thumbnail URL for the first page of the dynamically transcoded PowerPoint file is
	// `http://example.com/g0jb42ps49vtebjshilb/1.jpg`, and so on.
	//
	// If the document transcoding request carries the ThumbnailResolution parameter and the transcoding type is dynamic transcoding, this parameter is not null. In other cases, this parameter is null.
	ThumbnailUrl *string `json:"ThumbnailUrl,omitnil,omitempty" name:"ThumbnailUrl"`

	// Resolution of the thumbnail generated for dynamic transcoding
	ThumbnailResolution *string `json:"ThumbnailResolution,omitnil,omitempty" name:"ThumbnailResolution"`

	// URL for downloading the transcoded and compressed file. If `CompressFileType` carried in the document transcoding request is null or is not a supported compression format, this parameter is null.
	CompressFileUrl *string `json:"CompressFileUrl,omitnil,omitempty" name:"CompressFileUrl"`

	// Download URL (for trial) of the resource list.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	ResourceListUrl *string `json:"ResourceListUrl,omitnil,omitempty" name:"ResourceListUrl"`

	// Document generation mode (for trial).
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	Ext *string `json:"Ext,omitnil,omitempty" name:"Ext"`

	// Document transcoding task creation time, unit: seconds.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// Document transcoding task assignment time, unit: seconds.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	AssignTime *uint64 `json:"AssignTime,omitnil,omitempty" name:"AssignTime"`

	// Document transcoding task finished time, unit: seconds.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	FinishedTime *uint64 `json:"FinishedTime,omitnil,omitempty" name:"FinishedTime"`

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

Predefined struct for user

type DescribeTranscodeSearchRequest 

type DescribeTranscodeSearchRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeTranscodeSearchRequest 

func NewDescribeTranscodeSearchRequest() (request *DescribeTranscodeSearchRequest)

func (*DescribeTranscodeSearchRequest) FromJsonString 

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

func (r *DescribeTranscodeSearchRequest) ToJsonString() string

type DescribeTranscodeSearchRequestParams 

type DescribeTranscodeSearchRequestParams struct {
}

Predefined struct for user

type DescribeTranscodeSearchResponse 

type DescribeTranscodeSearchResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTranscodeSearchResponseParams `json:"Response"`
}

func NewDescribeTranscodeSearchResponse 

func NewDescribeTranscodeSearchResponse() (response *DescribeTranscodeSearchResponse)

func (*DescribeTranscodeSearchResponse) FromJsonString 

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

func (r *DescribeTranscodeSearchResponse) ToJsonString() string

type DescribeTranscodeSearchResponseParams 

type DescribeTranscodeSearchResponseParams struct {
	// The set of queried transcoding tasks.
	TranscodeTaskSet []*TranscodeTaskSearchResult `json:"TranscodeTaskSet,omitnil,omitempty" name:"TranscodeTaskSet"`

	// Number of transcoding tasks.
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

Predefined struct for user

type DescribeUsageSummaryRequest 

type DescribeUsageSummaryRequest struct {
	*tchttp.BaseRequest

	// Start time of the query period.
	BeginTime *string `json:"BeginTime,omitnil,omitempty" name:"BeginTime"`

	// End time of the query period.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// Subproducts whose usage you want to query.
	SubProducts []*string `json:"SubProducts,omitnil,omitempty" name:"SubProducts"`

	// true: Returns weighted data.
	// false: Returns raw data.
	IsWeighted *bool `json:"IsWeighted,omitnil,omitempty" name:"IsWeighted"`
}

func NewDescribeUsageSummaryRequest 

func NewDescribeUsageSummaryRequest() (request *DescribeUsageSummaryRequest)

func (*DescribeUsageSummaryRequest) FromJsonString 

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

func (r *DescribeUsageSummaryRequest) ToJsonString() string

type DescribeUsageSummaryRequestParams 

type DescribeUsageSummaryRequestParams struct {
	// Start time of the query period.
	BeginTime *string `json:"BeginTime,omitnil,omitempty" name:"BeginTime"`

	// End time of the query period.
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// Subproducts whose usage you want to query.
	SubProducts []*string `json:"SubProducts,omitnil,omitempty" name:"SubProducts"`

	// true: Returns weighted data.
	// false: Returns raw data.
	IsWeighted *bool `json:"IsWeighted,omitnil,omitempty" name:"IsWeighted"`
}

Predefined struct for user

type DescribeUsageSummaryResponse 

type DescribeUsageSummaryResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUsageSummaryResponseParams `json:"Response"`
}

func NewDescribeUsageSummaryResponse 

func NewDescribeUsageSummaryResponse() (response *DescribeUsageSummaryResponse)

func (*DescribeUsageSummaryResponse) FromJsonString 

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

func (r *DescribeUsageSummaryResponse) ToJsonString() string

type DescribeUsageSummaryResponseParams 

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

Predefined struct for user

type DescribeUserListRequest 

type DescribeUserListRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Room ID to be used to query users.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Query period, which consists of two Unix timestamps in milliseconds. The first indicates the start time and the second the end time.
	TimeRange []*int64 `json:"TimeRange,omitnil,omitempty" name:"TimeRange"`

	// Extra query conditions.
	Query *string `json:"Query,omitnil,omitempty" name:"Query"`

	// Maximum number of data entries to be returned. Default value: `1000`.
	MaxSize *int64 `json:"MaxSize,omitnil,omitempty" name:"MaxSize"`
}

func NewDescribeUserListRequest 

func NewDescribeUserListRequest() (request *DescribeUserListRequest)

func (*DescribeUserListRequest) FromJsonString 

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

func (r *DescribeUserListRequest) ToJsonString() string

type DescribeUserListRequestParams 

type DescribeUserListRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Room ID to be used to query users.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Query period, which consists of two Unix timestamps in milliseconds. The first indicates the start time and the second the end time.
	TimeRange []*int64 `json:"TimeRange,omitnil,omitempty" name:"TimeRange"`

	// Extra query conditions.
	Query *string `json:"Query,omitnil,omitempty" name:"Query"`

	// Maximum number of data entries to be returned. Default value: `1000`.
	MaxSize *int64 `json:"MaxSize,omitnil,omitempty" name:"MaxSize"`
}

Predefined struct for user

type DescribeUserListResponse 

type DescribeUserListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUserListResponseParams `json:"Response"`
}

func NewDescribeUserListResponse 

func NewDescribeUserListResponse() (response *DescribeUserListResponse)

func (*DescribeUserListResponse) FromJsonString 

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

func (r *DescribeUserListResponse) ToJsonString() string

type DescribeUserListResponseParams 

type DescribeUserListResponseParams struct {
	// User list of the room.
	UserList []*UserListItem `json:"UserList,omitnil,omitempty" name:"UserList"`

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

Predefined struct for user

type DescribeUserResourcesRequest 

type DescribeUserResourcesRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeUserResourcesRequest 

func NewDescribeUserResourcesRequest() (request *DescribeUserResourcesRequest)

func (*DescribeUserResourcesRequest) FromJsonString 

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

func (r *DescribeUserResourcesRequest) ToJsonString() string

type DescribeUserResourcesRequestParams 

type DescribeUserResourcesRequestParams struct {
}

Predefined struct for user

type DescribeUserResourcesResponse 

type DescribeUserResourcesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUserResourcesResponseParams `json:"Response"`
}

func NewDescribeUserResourcesResponse 

func NewDescribeUserResourcesResponse() (response *DescribeUserResourcesResponse)

func (*DescribeUserResourcesResponse) FromJsonString 

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

func (r *DescribeUserResourcesResponse) ToJsonString() string

type DescribeUserResourcesResponseParams 

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

Predefined struct for user

type DescribeUserStatusRequest 

type DescribeUserStatusRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeUserStatusRequest 

func NewDescribeUserStatusRequest() (request *DescribeUserStatusRequest)

func (*DescribeUserStatusRequest) FromJsonString 

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

func (r *DescribeUserStatusRequest) ToJsonString() string

type DescribeUserStatusRequestParams 

type DescribeUserStatusRequestParams struct {
}

Predefined struct for user

type DescribeUserStatusResponse 

type DescribeUserStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUserStatusResponseParams `json:"Response"`
}

func NewDescribeUserStatusResponse 

func NewDescribeUserStatusResponse() (response *DescribeUserStatusResponse)

func (*DescribeUserStatusResponse) FromJsonString 

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

func (r *DescribeUserStatusResponse) ToJsonString() string

type DescribeUserStatusResponseParams 

type DescribeUserStatusResponseParams struct {
	// AppId of the customer.
	AppId *int64 `json:"AppId,omitnil,omitempty" name:"AppId"`

	// Specifies whether the whiteboard service of the trial or official edition is activated before.
	//
	// 0: The whiteboard service is not activated.
	// 1: The whiteboard service is activated.
	IsTiwUser *int64 `json:"IsTiwUser,omitnil,omitempty" name:"IsTiwUser"`

	// Specifies whether the interactive class feature of the trial or official edition is activated before.
	IsSaaSUser *int64 `json:"IsSaaSUser,omitnil,omitempty" name:"IsSaaSUser"`

	// Specifies whether the user uses the offline recording feature of the whiteboard service.
	IsTiwOfflineRecordUser *int64 `json:"IsTiwOfflineRecordUser,omitnil,omitempty" name:"IsTiwOfflineRecordUser"`

	// Specifies whether the user is authenticated.
	IsAuthenticated *int64 `json:"IsAuthenticated,omitnil,omitempty" name:"IsAuthenticated"`

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

Predefined struct for user

type DescribeVideoGenerationTaskCallbackRequest 

type DescribeVideoGenerationTaskCallbackRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDescribeVideoGenerationTaskCallbackRequest 

func NewDescribeVideoGenerationTaskCallbackRequest() (request *DescribeVideoGenerationTaskCallbackRequest)

func (*DescribeVideoGenerationTaskCallbackRequest) FromJsonString 

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

func (r *DescribeVideoGenerationTaskCallbackRequest) ToJsonString() string

type DescribeVideoGenerationTaskCallbackRequestParams 

type DescribeVideoGenerationTaskCallbackRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DescribeVideoGenerationTaskCallbackResponse 

type DescribeVideoGenerationTaskCallbackResponse struct {
	*tchttp.BaseResponse
	Response *DescribeVideoGenerationTaskCallbackResponseParams `json:"Response"`
}

func NewDescribeVideoGenerationTaskCallbackResponse 

func NewDescribeVideoGenerationTaskCallbackResponse() (response *DescribeVideoGenerationTaskCallbackResponse)

func (*DescribeVideoGenerationTaskCallbackResponse) FromJsonString 

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

func (r *DescribeVideoGenerationTaskCallbackResponse) ToJsonString() string

type DescribeVideoGenerationTaskCallbackResponseParams 

type DescribeVideoGenerationTaskCallbackResponseParams struct {
	// Callback URL for recording video generation.
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`

	// Callback authentication key for recording video generation.
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`

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

Predefined struct for user

type DescribeVideoGenerationTaskRequest 

type DescribeVideoGenerationTaskRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the recording video generation task.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewDescribeVideoGenerationTaskRequest 

func NewDescribeVideoGenerationTaskRequest() (request *DescribeVideoGenerationTaskRequest)

func (*DescribeVideoGenerationTaskRequest) FromJsonString 

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

func (r *DescribeVideoGenerationTaskRequest) ToJsonString() string

type DescribeVideoGenerationTaskRequestParams 

type DescribeVideoGenerationTaskRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the recording video generation task.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type DescribeVideoGenerationTaskResponse 

type DescribeVideoGenerationTaskResponse struct {
	*tchttp.BaseResponse
	Response *DescribeVideoGenerationTaskResponseParams `json:"Response"`
}

func NewDescribeVideoGenerationTaskResponse 

func NewDescribeVideoGenerationTaskResponse() (response *DescribeVideoGenerationTaskResponse)

func (*DescribeVideoGenerationTaskResponse) FromJsonString 

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

func (r *DescribeVideoGenerationTaskResponse) ToJsonString() string

type DescribeVideoGenerationTaskResponseParams 

type DescribeVideoGenerationTaskResponseParams struct {
	// Group ID corresponding to the task.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// Room ID corresponding to the task.
	RoomId *int64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

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

	// Disused.
	Progress *int64 `json:"Progress,omitnil,omitempty" name:"Progress"`

	// Status of the recording video generation task. Valid values:
	// - QUEUED: Queuing.
	// - PROCESSING: Video generation in progress.
	// - FINISHED: Video generation finished. (To determine whether the task succeeded or failed, check the error code and message.)
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Total video playback duration. Unit: milliseconds.
	TotalTime *int64 `json:"TotalTime,omitnil,omitempty" name:"TotalTime"`

	// Disused. Use the `VideoInfoList` parameter.
	VideoInfos *VideoInfo `json:"VideoInfos,omitnil,omitempty" name:"VideoInfos"`

	// List of videos generated by the recording video generation tasks.
	VideoInfoList []*VideoInfo `json:"VideoInfoList,omitnil,omitempty" name:"VideoInfoList"`

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

Predefined struct for user

type DescribeWhiteboardApplicationConfigRequest 

type DescribeWhiteboardApplicationConfigRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Task types to be queried.
	// recording: Real-time recording.
	// transcode: Document transcoding.
	TaskTypes []*string `json:"TaskTypes,omitnil,omitempty" name:"TaskTypes"`

	// SdkAppIds to be used to query configurations.
	SdkAppIds []*int64 `json:"SdkAppIds,omitnil,omitempty" name:"SdkAppIds"`
}

func NewDescribeWhiteboardApplicationConfigRequest 

func NewDescribeWhiteboardApplicationConfigRequest() (request *DescribeWhiteboardApplicationConfigRequest)

func (*DescribeWhiteboardApplicationConfigRequest) FromJsonString 

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

func (r *DescribeWhiteboardApplicationConfigRequest) ToJsonString() string

type DescribeWhiteboardApplicationConfigRequestParams 

type DescribeWhiteboardApplicationConfigRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Task types to be queried.
	// recording: Real-time recording.
	// transcode: Document transcoding.
	TaskTypes []*string `json:"TaskTypes,omitnil,omitempty" name:"TaskTypes"`

	// SdkAppIds to be used to query configurations.
	SdkAppIds []*int64 `json:"SdkAppIds,omitnil,omitempty" name:"SdkAppIds"`
}

Predefined struct for user

type DescribeWhiteboardApplicationConfigResponse 

type DescribeWhiteboardApplicationConfigResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteboardApplicationConfigResponseParams `json:"Response"`
}

func NewDescribeWhiteboardApplicationConfigResponse 

func NewDescribeWhiteboardApplicationConfigResponse() (response *DescribeWhiteboardApplicationConfigResponse)

func (*DescribeWhiteboardApplicationConfigResponse) FromJsonString 

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

func (r *DescribeWhiteboardApplicationConfigResponse) ToJsonString() string

type DescribeWhiteboardApplicationConfigResponseParams 

type DescribeWhiteboardApplicationConfigResponseParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Task-related configurations of the whiteboard application.
	Configs []*WhiteboardApplicationConfig `json:"Configs,omitnil,omitempty" name:"Configs"`

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

Predefined struct for user

type DescribeWhiteboardBucketConfigRequest 

type DescribeWhiteboardBucketConfigRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Task type to be queried.
	// recording: Real-time recording.
	// transcode: Document transcoding.
	TaskType *string `json:"TaskType,omitnil,omitempty" name:"TaskType"`
}

func NewDescribeWhiteboardBucketConfigRequest 

func NewDescribeWhiteboardBucketConfigRequest() (request *DescribeWhiteboardBucketConfigRequest)

func (*DescribeWhiteboardBucketConfigRequest) FromJsonString 

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

func (r *DescribeWhiteboardBucketConfigRequest) ToJsonString() string

type DescribeWhiteboardBucketConfigRequestParams 

type DescribeWhiteboardBucketConfigRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Task type to be queried.
	// recording: Real-time recording.
	// transcode: Document transcoding.
	TaskType *string `json:"TaskType,omitnil,omitempty" name:"TaskType"`
}

Predefined struct for user

type DescribeWhiteboardBucketConfigResponse 

type DescribeWhiteboardBucketConfigResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteboardBucketConfigResponseParams `json:"Response"`
}

func NewDescribeWhiteboardBucketConfigResponse 

func NewDescribeWhiteboardBucketConfigResponse() (response *DescribeWhiteboardBucketConfigResponse)

func (*DescribeWhiteboardBucketConfigResponse) FromJsonString 

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

func (r *DescribeWhiteboardBucketConfigResponse) ToJsonString() string

type DescribeWhiteboardBucketConfigResponseParams 

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

Predefined struct for user

type DescribeWhiteboardPushCallbackRequest 

type DescribeWhiteboardPushCallbackRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDescribeWhiteboardPushCallbackRequest 

func NewDescribeWhiteboardPushCallbackRequest() (request *DescribeWhiteboardPushCallbackRequest)

func (*DescribeWhiteboardPushCallbackRequest) FromJsonString 

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

func (r *DescribeWhiteboardPushCallbackRequest) ToJsonString() string

type DescribeWhiteboardPushCallbackRequestParams 

type DescribeWhiteboardPushCallbackRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DescribeWhiteboardPushCallbackResponse 

type DescribeWhiteboardPushCallbackResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteboardPushCallbackResponseParams `json:"Response"`
}

func NewDescribeWhiteboardPushCallbackResponse 

func NewDescribeWhiteboardPushCallbackResponse() (response *DescribeWhiteboardPushCallbackResponse)

func (*DescribeWhiteboardPushCallbackResponse) FromJsonString 

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

func (r *DescribeWhiteboardPushCallbackResponse) ToJsonString() string

type DescribeWhiteboardPushCallbackResponseParams 

type DescribeWhiteboardPushCallbackResponseParams struct {
	// Callback URL of the whiteboard push event. If no callback URL is set, this parameter is null.
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`

	// Callback authentication key for whiteboard push.
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`

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

Predefined struct for user

type DescribeWhiteboardPushRequest 

type DescribeWhiteboardPushRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the whiteboard push task.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewDescribeWhiteboardPushRequest 

func NewDescribeWhiteboardPushRequest() (request *DescribeWhiteboardPushRequest)

func (*DescribeWhiteboardPushRequest) FromJsonString 

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

func (r *DescribeWhiteboardPushRequest) ToJsonString() string

type DescribeWhiteboardPushRequestParams 

type DescribeWhiteboardPushRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the whiteboard push task.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type DescribeWhiteboardPushResponse 

type DescribeWhiteboardPushResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteboardPushResponseParams `json:"Response"`
}

func NewDescribeWhiteboardPushResponse 

func NewDescribeWhiteboardPushResponse() (response *DescribeWhiteboardPushResponse)

func (*DescribeWhiteboardPushResponse) FromJsonString 

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

func (r *DescribeWhiteboardPushResponse) ToJsonString() string

type DescribeWhiteboardPushResponseParams 

type DescribeWhiteboardPushResponseParams struct {
	// Reason for push stop.
	// - AUTO: Pushing automatically stops because no upstream audio/video or whiteboard operation occurs in the room for a long time.
	// - USER_CALL: The API for stopping pushing is called.
	// - EXCEPTION: An exception occurred.
	FinishReason *string `json:"FinishReason,omitnil,omitempty" name:"FinishReason"`

	// ID of the whiteboard push task.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// Status of the push task.
	// - PREPARED: Push in preparation (including entering the room and starting the push service).
	// - PUSHING: Pushing in progress.
	// - STOPPED: Pushing stopped.
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

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

	// Group ID of the whiteboard.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// User ID of the push task.
	PushUserId *string `json:"PushUserId,omitnil,omitempty" name:"PushUserId"`

	// Actual push start time, which is a Unix timestamp in seconds.
	PushStartTime *int64 `json:"PushStartTime,omitnil,omitempty" name:"PushStartTime"`

	// Actual push stop time, which is a Unix timestamp in seconds.
	PushStopTime *int64 `json:"PushStopTime,omitnil,omitempty" name:"PushStopTime"`

	// Number of exceptions during push.
	ExceptionCnt *int64 `json:"ExceptionCnt,omitnil,omitempty" name:"ExceptionCnt"`

	// IM timestamp corresponding to the first frame of the whiteboard push video. The timestamp is used for time synchronization between IM messages and the whiteboard push video during playback.
	IMSyncTime *int64 `json:"IMSyncTime,omitnil,omitempty" name:"IMSyncTime"`

	// Result information of the backup push task.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	Backup *string `json:"Backup,omitnil,omitempty" name:"Backup"`

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

Predefined struct for user

type DescribeWhiteboardPushSearchRequest 

type DescribeWhiteboardPushSearchRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeWhiteboardPushSearchRequest 

func NewDescribeWhiteboardPushSearchRequest() (request *DescribeWhiteboardPushSearchRequest)

func (*DescribeWhiteboardPushSearchRequest) FromJsonString 

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

func (r *DescribeWhiteboardPushSearchRequest) ToJsonString() string

type DescribeWhiteboardPushSearchRequestParams 

type DescribeWhiteboardPushSearchRequestParams struct {
}

Predefined struct for user

type DescribeWhiteboardPushSearchResponse 

type DescribeWhiteboardPushSearchResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteboardPushSearchResponseParams `json:"Response"`
}

func NewDescribeWhiteboardPushSearchResponse 

func NewDescribeWhiteboardPushSearchResponse() (response *DescribeWhiteboardPushSearchResponse)

func (*DescribeWhiteboardPushSearchResponse) FromJsonString 

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

func (r *DescribeWhiteboardPushSearchResponse) ToJsonString() string

type DescribeWhiteboardPushSearchResponseParams 

type DescribeWhiteboardPushSearchResponseParams struct {
	// The set of queried push tasks.
	WhiteboardPushTaskSet []*WhiteboardPushTaskSearchResult `json:"WhiteboardPushTaskSet,omitnil,omitempty" name:"WhiteboardPushTaskSet"`

	// Number of push tasks.
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

Predefined struct for user

type Detail 

type Detail struct {
	// Usage metric.
	TagName *string `json:"TagName,omitnil,omitempty" name:"TagName"`

	// Usage weight.
	Weight *float64 `json:"Weight,omitnil,omitempty" name:"Weight"`

	// Usage value.
	Value *float64 `json:"Value,omitnil,omitempty" name:"Value"`
}

type Interrupt 

type Interrupt struct {
	// User ID.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Number of video stream interruptions.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	Count *int64 `json:"Count,omitnil,omitempty" name:"Count"`
}

type LayoutParams 

type LayoutParams struct {
	// Stream image width. Value range: [2,3000]
	Width *int64 `json:"Width,omitnil,omitempty" name:"Width"`

	// Stream image height. Value range: [2,3000]
	Height *int64 `json:"Height,omitnil,omitempty" name:"Height"`

	// Offset of the top point in the upper-left corner of the current image to the X axis of the top point in the upper-left corner of the canvas. Default value: 0. Value range: [0,3000].
	X *int64 `json:"X,omitnil,omitempty" name:"X"`

	// Offset of the top point in the upper-left corner of the current image to the Y axis of the top point in the upper-left corner of the canvas. Default value: 0. Value range: [0,3000].
	Y *int64 `json:"Y,omitnil,omitempty" name:"Y"`

	// Z-axis position of the image. The default value is 0.
	// The Z axis determines the overlap sequence of images. The image with the largest z-axis value is at the top layer.
	ZOrder *int64 `json:"ZOrder,omitnil,omitempty" name:"ZOrder"`
}

type MixStream 

type MixStream struct {
	// Whether stream mixing is enabled
	Enabled *bool `json:"Enabled,omitnil,omitempty" name:"Enabled"`

	// Whether audio stream mixing is disabled
	DisableAudio *bool `json:"DisableAudio,omitnil,omitempty" name:"DisableAudio"`

	// ID of the embedded mixed stream layout template. Valid values: 1 and 2. For more information on the differences of both values, see the sample embedded mixed stream layout template.
	// If the Custom field is not specified, ModelId is required.
	ModelId *int64 `json:"ModelId,omitnil,omitempty" name:"ModelId"`

	// ID of a teacher account
	// This field is valid only when ModelId is specified.
	// If you specify TeacherID for a user, the user's video stream will be displayed in the first image of the embedded template.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// Custom mixed stream layout parameter
	// If this parameter is available, the ModelId and TeacherId fields will be ignored.
	Custom *CustomLayout `json:"Custom,omitnil,omitempty" name:"Custom"`
}

type ModifyApplicationRequest 

type ModifyApplicationRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

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

func NewModifyApplicationRequest 

func NewModifyApplicationRequest() (request *ModifyApplicationRequest)

func (*ModifyApplicationRequest) FromJsonString 

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

func (r *ModifyApplicationRequest) ToJsonString() string

type ModifyApplicationRequestParams 

type ModifyApplicationRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

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

Predefined struct for user

type ModifyApplicationResponse 

type ModifyApplicationResponse struct {
	*tchttp.BaseResponse
	Response *ModifyApplicationResponseParams `json:"Response"`
}

func NewModifyApplicationResponse 

func NewModifyApplicationResponse() (response *ModifyApplicationResponse)

func (*ModifyApplicationResponse) FromJsonString 

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

func (r *ModifyApplicationResponse) ToJsonString() string

type ModifyApplicationResponseParams 

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

Predefined struct for user

type ModifyAutoRenewFlagRequest 

type ModifyAutoRenewFlagRequest struct {
	*tchttp.BaseRequest

	// Subproduct ID. To obtain this ID, call the `DescribeUserResources` API and find the subproduct ID of the monthly feature package with the level 1. Usually the value is `sp_tiw_package`.
	SubProduct *string `json:"SubProduct,omitnil,omitempty" name:"SubProduct"`

	// Resource ID. To obtain this ID, call the `DescribeUserResources` API and find the resource ID of the monthly feature package with the level 1.
	ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`

	// Renewal mode. Valid values: `0` (default mode, which is auto-renewal), `1` (auto-renewal), `2` (manual renewal, which is specified by users). If no renewal is required, set it to `0`.
	AutoRenewFlag *int64 `json:"AutoRenewFlag,omitnil,omitempty" name:"AutoRenewFlag"`
}

func NewModifyAutoRenewFlagRequest 

func NewModifyAutoRenewFlagRequest() (request *ModifyAutoRenewFlagRequest)

func (*ModifyAutoRenewFlagRequest) FromJsonString 

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

func (r *ModifyAutoRenewFlagRequest) ToJsonString() string

type ModifyAutoRenewFlagRequestParams 

type ModifyAutoRenewFlagRequestParams struct {
	// Subproduct ID. To obtain this ID, call the `DescribeUserResources` API and find the subproduct ID of the monthly feature package with the level 1. Usually the value is `sp_tiw_package`.
	SubProduct *string `json:"SubProduct,omitnil,omitempty" name:"SubProduct"`

	// Resource ID. To obtain this ID, call the `DescribeUserResources` API and find the resource ID of the monthly feature package with the level 1.
	ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`

	// Renewal mode. Valid values: `0` (default mode, which is auto-renewal), `1` (auto-renewal), `2` (manual renewal, which is specified by users). If no renewal is required, set it to `0`.
	AutoRenewFlag *int64 `json:"AutoRenewFlag,omitnil,omitempty" name:"AutoRenewFlag"`
}

Predefined struct for user

type ModifyAutoRenewFlagResponse 

type ModifyAutoRenewFlagResponse struct {
	*tchttp.BaseResponse
	Response *ModifyAutoRenewFlagResponseParams `json:"Response"`
}

func NewModifyAutoRenewFlagResponse 

func NewModifyAutoRenewFlagResponse() (response *ModifyAutoRenewFlagResponse)

func (*ModifyAutoRenewFlagResponse) FromJsonString 

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

func (r *ModifyAutoRenewFlagResponse) ToJsonString() string

type ModifyAutoRenewFlagResponseParams 

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

Predefined struct for user

type ModifyWhiteboardApplicationConfigRequest 

type ModifyWhiteboardApplicationConfigRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Task-related configurations of the whiteboard application.
	Configs []*WhiteboardApplicationConfig `json:"Configs,omitnil,omitempty" name:"Configs"`
}

func NewModifyWhiteboardApplicationConfigRequest 

func NewModifyWhiteboardApplicationConfigRequest() (request *ModifyWhiteboardApplicationConfigRequest)

func (*ModifyWhiteboardApplicationConfigRequest) FromJsonString 

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

func (r *ModifyWhiteboardApplicationConfigRequest) ToJsonString() string

type ModifyWhiteboardApplicationConfigRequestParams 

type ModifyWhiteboardApplicationConfigRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Task-related configurations of the whiteboard application.
	Configs []*WhiteboardApplicationConfig `json:"Configs,omitnil,omitempty" name:"Configs"`
}

Predefined struct for user

type ModifyWhiteboardApplicationConfigResponse 

type ModifyWhiteboardApplicationConfigResponse struct {
	*tchttp.BaseResponse
	Response *ModifyWhiteboardApplicationConfigResponseParams `json:"Response"`
}

func NewModifyWhiteboardApplicationConfigResponse 

func NewModifyWhiteboardApplicationConfigResponse() (response *ModifyWhiteboardApplicationConfigResponse)

func (*ModifyWhiteboardApplicationConfigResponse) FromJsonString 

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

func (r *ModifyWhiteboardApplicationConfigResponse) ToJsonString() string

type ModifyWhiteboardApplicationConfigResponseParams 

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

Predefined struct for user

type ModifyWhiteboardBucketConfigRequest 

type ModifyWhiteboardBucketConfigRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Task type to be queried.
	// recording: Real-time recording.
	// transcode: Document transcoding.
	TaskType *string `json:"TaskType,omitnil,omitempty" name:"TaskType"`

	// Name of the COS bucket.
	BucketName *string `json:"BucketName,omitnil,omitempty" name:"BucketName"`

	// Region of the COS bucket.
	BucketLocation *string `json:"BucketLocation,omitnil,omitempty" name:"BucketLocation"`

	// Resource prefix of the bucket.
	BucketPrefix *string `json:"BucketPrefix,omitnil,omitempty" name:"BucketPrefix"`

	// Domain name of the URL of the bucket.
	ResultDomain *string `json:"ResultDomain,omitnil,omitempty" name:"ResultDomain"`
}

func NewModifyWhiteboardBucketConfigRequest 

func NewModifyWhiteboardBucketConfigRequest() (request *ModifyWhiteboardBucketConfigRequest)

func (*ModifyWhiteboardBucketConfigRequest) FromJsonString 

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

func (r *ModifyWhiteboardBucketConfigRequest) ToJsonString() string

type ModifyWhiteboardBucketConfigRequestParams 

type ModifyWhiteboardBucketConfigRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Task type to be queried.
	// recording: Real-time recording.
	// transcode: Document transcoding.
	TaskType *string `json:"TaskType,omitnil,omitempty" name:"TaskType"`

	// Name of the COS bucket.
	BucketName *string `json:"BucketName,omitnil,omitempty" name:"BucketName"`

	// Region of the COS bucket.
	BucketLocation *string `json:"BucketLocation,omitnil,omitempty" name:"BucketLocation"`

	// Resource prefix of the bucket.
	BucketPrefix *string `json:"BucketPrefix,omitnil,omitempty" name:"BucketPrefix"`

	// Domain name of the URL of the bucket.
	ResultDomain *string `json:"ResultDomain,omitnil,omitempty" name:"ResultDomain"`
}

Predefined struct for user

type ModifyWhiteboardBucketConfigResponse 

type ModifyWhiteboardBucketConfigResponse struct {
	*tchttp.BaseResponse
	Response *ModifyWhiteboardBucketConfigResponseParams `json:"Response"`
}

func NewModifyWhiteboardBucketConfigResponse 

func NewModifyWhiteboardBucketConfigResponse() (response *ModifyWhiteboardBucketConfigResponse)

func (*ModifyWhiteboardBucketConfigResponse) FromJsonString 

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

func (r *ModifyWhiteboardBucketConfigResponse) ToJsonString() string

type ModifyWhiteboardBucketConfigResponseParams 

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

Predefined struct for user

type OmittedDuration 

type OmittedDuration struct {
	// Offset of the paused time in the spliced video, in milliseconds
	VideoTime *int64 `json:"VideoTime,omitnil,omitempty" name:"VideoTime"`

	// Recording pause timestamp, in milliseconds
	PauseTime *int64 `json:"PauseTime,omitnil,omitempty" name:"PauseTime"`

	// Recording resumption timestamp, in milliseconds
	ResumeTime *int64 `json:"ResumeTime,omitnil,omitempty" name:"ResumeTime"`
}

type PauseOnlineRecordRequest 

type PauseOnlineRecordRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the real-time recording task
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewPauseOnlineRecordRequest 

func NewPauseOnlineRecordRequest() (request *PauseOnlineRecordRequest)

func (*PauseOnlineRecordRequest) FromJsonString 

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

func (r *PauseOnlineRecordRequest) ToJsonString() string

type PauseOnlineRecordRequestParams 

type PauseOnlineRecordRequestParams struct {
	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the real-time recording task
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type PauseOnlineRecordResponse 

type PauseOnlineRecordResponse struct {
	*tchttp.BaseResponse
	Response *PauseOnlineRecordResponseParams `json:"Response"`
}

func NewPauseOnlineRecordResponse 

func NewPauseOnlineRecordResponse() (response *PauseOnlineRecordResponse)

func (*PauseOnlineRecordResponse) FromJsonString 

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

func (r *PauseOnlineRecordResponse) ToJsonString() string

type PauseOnlineRecordResponseParams 

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

Predefined struct for user

type RecordControl 

type RecordControl struct {
	// It specifies whether to enable RecordControl. Valid values: true (yes); false (no).
	Enabled *bool `json:"Enabled,omitnil,omitempty" name:"Enabled"`

	// A global parameter generally used in conjunction with `StreamControls` that specifies whether to disable recording. Valid values:
	//
	// true: no stream is recorded.
	// false: all streams are recorded. Default value: false.
	//
	// The setting in this parameter is applied to all streams. However, if `StreamControls` is passed in, the parameters in `StreamControls` will take precedence.
	DisableRecord *bool `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// A global parameter generally used in conjunction with `StreamControls` that specifies whether to disable audio recording over all streams. Valid values:
	//
	// true: no audio recording of any streams.
	// false: audio recording of all streams. Default value: false.
	//
	// The setting in this parameter is applied to all streams. However, if `StreamControls` is passed in, the parameters in `StreamControls` will take precedence.
	DisableAudio *bool `json:"DisableAudio,omitnil,omitempty" name:"DisableAudio"`

	// A global parameter generally used in conjunction with `StreamControls` that specifies whether to record low-resolution videos only. Valid values:
	//
	// true: only records low-resolution videos for all streams. Please ensure that the up-streaming end pushes the low-resolution videos. Otherwise, the recorded video may be black.
	// false: high-resolution video recording of all streams. Default value: false.
	//
	// The setting in this parameter is applied to all streams. However, if `StreamControls` is passed in, the parameters in `StreamControls` will take precedence.
	PullSmallVideo *bool `json:"PullSmallVideo,omitnil,omitempty" name:"PullSmallVideo"`

	// Parameters over specific streams, which take priority over global configurations. If it’s empty, all streams are recorded according to the global configurations.
	StreamControls []*StreamControl `json:"StreamControls,omitnil,omitempty" name:"StreamControls"`
}

type RecordTaskResult 

type RecordTaskResult struct {
	// `AUTO`: Recording automatically stops. `USER_CALL`: The API for stopping recording is called.
	FinishReason *string `json:"FinishReason,omitnil,omitempty" name:"FinishReason"`

	// Number of exceptions.
	ExceptionCnt *int64 `json:"ExceptionCnt,omitnil,omitempty" name:"ExceptionCnt"`

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

	// Group ID.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// Actual recording start time.
	RecordStartTime *int64 `json:"RecordStartTime,omitnil,omitempty" name:"RecordStartTime"`

	// Recording end time.
	RecordStopTime *int64 `json:"RecordStopTime,omitnil,omitempty" name:"RecordStopTime"`

	// Recording duration.
	TotalTime *int64 `json:"TotalTime,omitnil,omitempty" name:"TotalTime"`

	// List of video information.
	VideoInfos []*VideoInfo `json:"VideoInfos,omitnil,omitempty" name:"VideoInfos"`

	// Omitted video durations.
	OmittedDurations []*OmittedDuration `json:"OmittedDurations,omitnil,omitempty" name:"OmittedDurations"`

	// Details.
	Details *string `json:"Details,omitnil,omitempty" name:"Details"`

	// Task execution error code.
	ErrorCode *int64 `json:"ErrorCode,omitnil,omitempty" name:"ErrorCode"`

	// Error message.
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`
}

type RecordTaskSearchResult 

type RecordTaskSearchResult struct {
	// Unique task ID.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// Status of the real-time recording task.
	// - PAUSED: Recording paused.
	// - PREPARED: Recording in preparation.
	// - RECORDING: Recording in progress.
	// - STOPPED: Recording stopped.
	// - FINISHED: Recording finished.
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Room ID of the real-time recording task.
	RoomId *int64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Creation time of the task.
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Real-time recording result.
	Result *RecordTaskResult `json:"Result,omitnil,omitempty" name:"Result"`
}

type ResumeOnlineRecordRequest 

type ResumeOnlineRecordRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the resumed real-time recording task
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewResumeOnlineRecordRequest 

func NewResumeOnlineRecordRequest() (request *ResumeOnlineRecordRequest)

func (*ResumeOnlineRecordRequest) FromJsonString 

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

func (r *ResumeOnlineRecordRequest) ToJsonString() string

type ResumeOnlineRecordRequestParams 

type ResumeOnlineRecordRequestParams struct {
	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the resumed real-time recording task
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type ResumeOnlineRecordResponse 

type ResumeOnlineRecordResponse struct {
	*tchttp.BaseResponse
	Response *ResumeOnlineRecordResponseParams `json:"Response"`
}

func NewResumeOnlineRecordResponse 

func NewResumeOnlineRecordResponse() (response *ResumeOnlineRecordResponse)

func (*ResumeOnlineRecordResponse) FromJsonString 

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

func (r *ResumeOnlineRecordResponse) ToJsonString() string

type ResumeOnlineRecordResponseParams 

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

Predefined struct for user

type RoomListItem 

type RoomListItem struct {
	// Room ID.
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The first time when the room ID appeared during the queried period, which is a Unix timestamp in milliseconds.
	StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The last time when the room ID appeared during the queried period, which is a Unix timestamp in milliseconds.
	EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// Number of users in the room.
	UserNumber *int64 `json:"UserNumber,omitnil,omitempty" name:"UserNumber"`
}

type RoomUsageDataItem 

type RoomUsageDataItem struct {
	// Start date in the format of YYYY-MM-DD.
	Time *string `json:"Time,omitnil,omitempty" name:"Time"`

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Subproduct usage information, which is consistent with the corresponding request parameters.
	// - sp_tiw_board: The duration of use of whiteboards.
	// - sp_tiw_ric: The duration of real-time recording.
	SubProduct *string `json:"SubProduct,omitnil,omitempty" name:"SubProduct"`

	// Usage values.
	// - The unit of sp_tiw_board and sp_tiw_ric is minutes.
	Value *float64 `json:"Value,omitnil,omitempty" name:"Value"`

	RoomID *uint64 `json:"RoomID,omitnil,omitempty" name:"RoomID"`
}

type SetOnlineRecordCallbackKeyRequest 

type SetOnlineRecordCallbackKeyRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the application
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Authentication key for the real-time recording callback. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key will be deleted. For more information, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`
}

func NewSetOnlineRecordCallbackKeyRequest 

func NewSetOnlineRecordCallbackKeyRequest() (request *SetOnlineRecordCallbackKeyRequest)

func (*SetOnlineRecordCallbackKeyRequest) FromJsonString 

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

func (r *SetOnlineRecordCallbackKeyRequest) ToJsonString() string

type SetOnlineRecordCallbackKeyRequestParams 

type SetOnlineRecordCallbackKeyRequestParams struct {
	// SdkAppId of the application
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Authentication key for the real-time recording callback. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key will be deleted. For more information, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`
}

Predefined struct for user

type SetOnlineRecordCallbackKeyResponse 

type SetOnlineRecordCallbackKeyResponse struct {
	*tchttp.BaseResponse
	Response *SetOnlineRecordCallbackKeyResponseParams `json:"Response"`
}

func NewSetOnlineRecordCallbackKeyResponse 

func NewSetOnlineRecordCallbackKeyResponse() (response *SetOnlineRecordCallbackKeyResponse)

func (*SetOnlineRecordCallbackKeyResponse) FromJsonString 

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

func (r *SetOnlineRecordCallbackKeyResponse) ToJsonString() string

type SetOnlineRecordCallbackKeyResponseParams 

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

Predefined struct for user

type SetOnlineRecordCallbackRequest 

type SetOnlineRecordCallbackRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback address of the real-time recording task result. If an empty string is passed in, the existing callback address will be deleted. The callback address only supports the HTTP or HTTPS protocol, so the callback address must start with `http://` or `https://`. For the callback format, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`
}

func NewSetOnlineRecordCallbackRequest 

func NewSetOnlineRecordCallbackRequest() (request *SetOnlineRecordCallbackRequest)

func (*SetOnlineRecordCallbackRequest) FromJsonString 

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

func (r *SetOnlineRecordCallbackRequest) ToJsonString() string

type SetOnlineRecordCallbackRequestParams 

type SetOnlineRecordCallbackRequestParams struct {
	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback address of the real-time recording task result. If an empty string is passed in, the existing callback address will be deleted. The callback address only supports the HTTP or HTTPS protocol, so the callback address must start with `http://` or `https://`. For the callback format, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`
}

Predefined struct for user

type SetOnlineRecordCallbackResponse 

type SetOnlineRecordCallbackResponse struct {
	*tchttp.BaseResponse
	Response *SetOnlineRecordCallbackResponseParams `json:"Response"`
}

func NewSetOnlineRecordCallbackResponse 

func NewSetOnlineRecordCallbackResponse() (response *SetOnlineRecordCallbackResponse)

func (*SetOnlineRecordCallbackResponse) FromJsonString 

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

func (r *SetOnlineRecordCallbackResponse) ToJsonString() string

type SetOnlineRecordCallbackResponseParams 

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

Predefined struct for user

type SetTranscodeCallbackKeyRequest 

type SetTranscodeCallbackKeyRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the application
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Authentication key for the document transcoding callback. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key will be deleted. For more information about callback authentication, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`
}

func NewSetTranscodeCallbackKeyRequest 

func NewSetTranscodeCallbackKeyRequest() (request *SetTranscodeCallbackKeyRequest)

func (*SetTranscodeCallbackKeyRequest) FromJsonString 

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

func (r *SetTranscodeCallbackKeyRequest) ToJsonString() string

type SetTranscodeCallbackKeyRequestParams 

type SetTranscodeCallbackKeyRequestParams struct {
	// SdkAppId of the application
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Authentication key for the document transcoding callback. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key will be deleted. For more information about callback authentication, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`
}

Predefined struct for user

type SetTranscodeCallbackKeyResponse 

type SetTranscodeCallbackKeyResponse struct {
	*tchttp.BaseResponse
	Response *SetTranscodeCallbackKeyResponseParams `json:"Response"`
}

func NewSetTranscodeCallbackKeyResponse 

func NewSetTranscodeCallbackKeyResponse() (response *SetTranscodeCallbackKeyResponse)

func (*SetTranscodeCallbackKeyResponse) FromJsonString 

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

func (r *SetTranscodeCallbackKeyResponse) ToJsonString() string

type SetTranscodeCallbackKeyResponseParams 

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

Predefined struct for user

type SetTranscodeCallbackRequest 

type SetTranscodeCallbackRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback address for the document transcoding progress. If an empty string is passed in, the existing callback address will be deleted. The callback address only supports the HTTP or HTTPS protocol, so the callback address must start with `http://` or `https://`.
	// For more information about the callback format, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`
}

func NewSetTranscodeCallbackRequest 

func NewSetTranscodeCallbackRequest() (request *SetTranscodeCallbackRequest)

func (*SetTranscodeCallbackRequest) FromJsonString 

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

func (r *SetTranscodeCallbackRequest) ToJsonString() string

type SetTranscodeCallbackRequestParams 

type SetTranscodeCallbackRequestParams struct {
	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback address for the document transcoding progress. If an empty string is passed in, the existing callback address will be deleted. The callback address only supports the HTTP or HTTPS protocol, so the callback address must start with `http://` or `https://`.
	// For more information about the callback format, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`
}

Predefined struct for user

type SetTranscodeCallbackResponse 

type SetTranscodeCallbackResponse struct {
	*tchttp.BaseResponse
	Response *SetTranscodeCallbackResponseParams `json:"Response"`
}

func NewSetTranscodeCallbackResponse 

func NewSetTranscodeCallbackResponse() (response *SetTranscodeCallbackResponse)

func (*SetTranscodeCallbackResponse) FromJsonString 

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

func (r *SetTranscodeCallbackResponse) ToJsonString() string

type SetTranscodeCallbackResponseParams 

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

Predefined struct for user

type SetVideoGenerationTaskCallbackKeyRequest 

type SetVideoGenerationTaskCallbackKeyRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback authentication key for recording video generation. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key is deleted.
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`
}

func NewSetVideoGenerationTaskCallbackKeyRequest 

func NewSetVideoGenerationTaskCallbackKeyRequest() (request *SetVideoGenerationTaskCallbackKeyRequest)

func (*SetVideoGenerationTaskCallbackKeyRequest) FromJsonString 

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

func (r *SetVideoGenerationTaskCallbackKeyRequest) ToJsonString() string

type SetVideoGenerationTaskCallbackKeyRequestParams 

type SetVideoGenerationTaskCallbackKeyRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback authentication key for recording video generation. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key is deleted.
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`
}

Predefined struct for user

type SetVideoGenerationTaskCallbackKeyResponse 

type SetVideoGenerationTaskCallbackKeyResponse struct {
	*tchttp.BaseResponse
	Response *SetVideoGenerationTaskCallbackKeyResponseParams `json:"Response"`
}

func NewSetVideoGenerationTaskCallbackKeyResponse 

func NewSetVideoGenerationTaskCallbackKeyResponse() (response *SetVideoGenerationTaskCallbackKeyResponse)

func (*SetVideoGenerationTaskCallbackKeyResponse) FromJsonString 

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

func (r *SetVideoGenerationTaskCallbackKeyResponse) ToJsonString() string

type SetVideoGenerationTaskCallbackKeyResponseParams 

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

Predefined struct for user

type SetVideoGenerationTaskCallbackRequest 

type SetVideoGenerationTaskCallbackRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback URL of the offline recording task result. If it is specified as null, the set callback URL is deleted. The callback URL only supports the HTTP or HTTPS protocol, and therefore the callback URL must start with `http://` or `https://`.
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`
}

func NewSetVideoGenerationTaskCallbackRequest 

func NewSetVideoGenerationTaskCallbackRequest() (request *SetVideoGenerationTaskCallbackRequest)

func (*SetVideoGenerationTaskCallbackRequest) FromJsonString 

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

func (r *SetVideoGenerationTaskCallbackRequest) ToJsonString() string

type SetVideoGenerationTaskCallbackRequestParams 

type SetVideoGenerationTaskCallbackRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback URL of the offline recording task result. If it is specified as null, the set callback URL is deleted. The callback URL only supports the HTTP or HTTPS protocol, and therefore the callback URL must start with `http://` or `https://`.
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`
}

Predefined struct for user

type SetVideoGenerationTaskCallbackResponse 

type SetVideoGenerationTaskCallbackResponse struct {
	*tchttp.BaseResponse
	Response *SetVideoGenerationTaskCallbackResponseParams `json:"Response"`
}

func NewSetVideoGenerationTaskCallbackResponse 

func NewSetVideoGenerationTaskCallbackResponse() (response *SetVideoGenerationTaskCallbackResponse)

func (*SetVideoGenerationTaskCallbackResponse) FromJsonString 

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

func (r *SetVideoGenerationTaskCallbackResponse) ToJsonString() string

type SetVideoGenerationTaskCallbackResponseParams 

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

Predefined struct for user

type SetWhiteboardPushCallbackKeyRequest 

type SetWhiteboardPushCallbackKeyRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback authentication key for whiteboard push. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key is deleted. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`
}

func NewSetWhiteboardPushCallbackKeyRequest 

func NewSetWhiteboardPushCallbackKeyRequest() (request *SetWhiteboardPushCallbackKeyRequest)

func (*SetWhiteboardPushCallbackKeyRequest) FromJsonString 

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

func (r *SetWhiteboardPushCallbackKeyRequest) ToJsonString() string

type SetWhiteboardPushCallbackKeyRequestParams 

type SetWhiteboardPushCallbackKeyRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback authentication key for whiteboard push. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key is deleted. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`
}

Predefined struct for user

type SetWhiteboardPushCallbackKeyResponse 

type SetWhiteboardPushCallbackKeyResponse struct {
	*tchttp.BaseResponse
	Response *SetWhiteboardPushCallbackKeyResponseParams `json:"Response"`
}

func NewSetWhiteboardPushCallbackKeyResponse 

func NewSetWhiteboardPushCallbackKeyResponse() (response *SetWhiteboardPushCallbackKeyResponse)

func (*SetWhiteboardPushCallbackKeyResponse) FromJsonString 

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

func (r *SetWhiteboardPushCallbackKeyResponse) ToJsonString() string

type SetWhiteboardPushCallbackKeyResponseParams 

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

Predefined struct for user

type SetWhiteboardPushCallbackRequest 

type SetWhiteboardPushCallbackRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback URL of the whiteboard push task result. If an empty string is passed in, the existing callback URL is deleted. The callback URL only supports the HTTP or HTTPS protocol, and therefore the callback URL must start with `http://` or `https://`. For the callback format, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`
}

func NewSetWhiteboardPushCallbackRequest 

func NewSetWhiteboardPushCallbackRequest() (request *SetWhiteboardPushCallbackRequest)

func (*SetWhiteboardPushCallbackRequest) FromJsonString 

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

func (r *SetWhiteboardPushCallbackRequest) ToJsonString() string

type SetWhiteboardPushCallbackRequestParams 

type SetWhiteboardPushCallbackRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback URL of the whiteboard push task result. If an empty string is passed in, the existing callback URL is deleted. The callback URL only supports the HTTP or HTTPS protocol, and therefore the callback URL must start with `http://` or `https://`. For the callback format, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`
}

Predefined struct for user

type SetWhiteboardPushCallbackResponse 

type SetWhiteboardPushCallbackResponse struct {
	*tchttp.BaseResponse
	Response *SetWhiteboardPushCallbackResponseParams `json:"Response"`
}

func NewSetWhiteboardPushCallbackResponse 

func NewSetWhiteboardPushCallbackResponse() (response *SetWhiteboardPushCallbackResponse)

func (*SetWhiteboardPushCallbackResponse) FromJsonString 

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

func (r *SetWhiteboardPushCallbackResponse) ToJsonString() string

type SetWhiteboardPushCallbackResponseParams 

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

Predefined struct for user

type SnapshotCOS 

type SnapshotCOS struct {
	// UIN of the Tencent Cloud account.
	Uin *uint64 `json:"Uin,omitnil,omitempty" name:"Uin"`

	// COS region.
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

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

	// Root directory for storing whiteboard snapshots.
	TargetDir *string `json:"TargetDir,omitnil,omitempty" name:"TargetDir"`

	// CDN acceleration domain name.
	Domain *string `json:"Domain,omitnil,omitempty" name:"Domain"`
}

type SnapshotResult 

type SnapshotResult struct {
	// Task execution error code.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	ErrorCode *string `json:"ErrorCode,omitnil,omitempty" name:"ErrorCode"`

	// Task execution error message.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	ErrorMessage *string `json:"ErrorMessage,omitnil,omitempty" name:"ErrorMessage"`

	// Number of generated snapshot images.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// List of URLs of the snapshot images.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	Snapshots []*string `json:"Snapshots,omitnil,omitempty" name:"Snapshots"`
}

type SnapshotWhiteboard 

type SnapshotWhiteboard struct {
	// Whiteboard width. Valid range: [0,2560]. Default value: 1280.
	Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"`

	// Whiteboard height. Valid range: [0,2560]. Default value: 720.
	Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"`

	// Escaped JSON string of the whiteboard initial parameters, which is passed through to the Tencent Interactive Whiteboard SDK.
	InitParams *string `json:"InitParams,omitnil,omitempty" name:"InitParams"`
}

type StartOnlineRecordRequest 

type StartOnlineRecordRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the room for recording. Value range: (1, 4294967295)
	RoomId *int64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// User ID used by the recording service for entering a room. The ID cannot exceed 60 bytes in length. Its format is `tic_record_user_${RoomId}_${Random}`, where `${RoomId}` indicates the ID of the room for recording and `${Random}` is a random string.
	// The ID must be an unused ID in the SDK. The recording service uses the user ID to enter the room for audio, video, and whiteboard recording. If this ID is already used in the SDK, the SDK and recording service will conflict, affecting the recording operation.
	RecordUserId *string `json:"RecordUserId,omitnil,omitempty" name:"RecordUserId"`

	// Signature corresponding to RecordUserId
	RecordUserSig *string `json:"RecordUserSig,omitnil,omitempty" name:"RecordUserSig"`

	// (Disused) IM group ID of the whiteboard. By default, it is the same as the room ID.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// Real-time recording video splicing parameter
	Concat *Concat `json:"Concat,omitnil,omitempty" name:"Concat"`

	// Real-time recording whiteboard parameter, such as the whiteboard width and height
	Whiteboard *Whiteboard `json:"Whiteboard,omitnil,omitempty" name:"Whiteboard"`

	// Real-time recording stream mixing parameter
	// Notes:
	// 1. The stream mixing feature needs to be enabled separately. If you need the feature, contact TIW customer service.
	// 2. To use the stream mixing feature, the Extras parameter is required and must contain "MIX_STREAM".
	MixStream *MixStream `json:"MixStream,omitnil,omitempty" name:"MixStream"`

	// List of advanced features used
	// List of possible values:
	// MIX_STREAM - Stream mixing feature
	Extras []*string `json:"Extras,omitnil,omitempty" name:"Extras"`

	// Whether to return the audio-only recording file of different streams in the result callback. The file format is mp3.
	AudioFileNeeded *bool `json:"AudioFileNeeded,omitnil,omitempty" name:"AudioFileNeeded"`

	// A group of real-time recording parameters. It specifies the streams to be recorded, whether to disable the audio recording, and whether to record only low-resolution videos, etc.
	RecordControl *RecordControl `json:"RecordControl,omitnil,omitempty" name:"RecordControl"`

	RecordMode *string `json:"RecordMode,omitnil,omitempty" name:"RecordMode"`

	ChatGroupId *string `json:"ChatGroupId,omitnil,omitempty" name:"ChatGroupId"`

	// Recording timeout. Unit: seconds. Valid range: [300,86400]. Default value: 300.
	//
	// If no upstream audio/video exists or no operation is performed on the whiteboard for the specified period of time, the recording service automatically stops the recording task.
	AutoStopTimeout *int64 `json:"AutoStopTimeout,omitnil,omitempty" name:"AutoStopTimeout"`

	// Internal parameter. You can ignore this parameter.
	ExtraData *string `json:"ExtraData,omitnil,omitempty" name:"ExtraData"`
}

func NewStartOnlineRecordRequest 

func NewStartOnlineRecordRequest() (request *StartOnlineRecordRequest)

func (*StartOnlineRecordRequest) FromJsonString 

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

func (r *StartOnlineRecordRequest) ToJsonString() string

type StartOnlineRecordRequestParams 

type StartOnlineRecordRequestParams struct {
	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the room for recording. Value range: (1, 4294967295)
	RoomId *int64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// User ID used by the recording service for entering a room. The ID cannot exceed 60 bytes in length. Its format is `tic_record_user_${RoomId}_${Random}`, where `${RoomId}` indicates the ID of the room for recording and `${Random}` is a random string.
	// The ID must be an unused ID in the SDK. The recording service uses the user ID to enter the room for audio, video, and whiteboard recording. If this ID is already used in the SDK, the SDK and recording service will conflict, affecting the recording operation.
	RecordUserId *string `json:"RecordUserId,omitnil,omitempty" name:"RecordUserId"`

	// Signature corresponding to RecordUserId
	RecordUserSig *string `json:"RecordUserSig,omitnil,omitempty" name:"RecordUserSig"`

	// (Disused) IM group ID of the whiteboard. By default, it is the same as the room ID.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// Real-time recording video splicing parameter
	Concat *Concat `json:"Concat,omitnil,omitempty" name:"Concat"`

	// Real-time recording whiteboard parameter, such as the whiteboard width and height
	Whiteboard *Whiteboard `json:"Whiteboard,omitnil,omitempty" name:"Whiteboard"`

	// Real-time recording stream mixing parameter
	// Notes:
	// 1. The stream mixing feature needs to be enabled separately. If you need the feature, contact TIW customer service.
	// 2. To use the stream mixing feature, the Extras parameter is required and must contain "MIX_STREAM".
	MixStream *MixStream `json:"MixStream,omitnil,omitempty" name:"MixStream"`

	// List of advanced features used
	// List of possible values:
	// MIX_STREAM - Stream mixing feature
	Extras []*string `json:"Extras,omitnil,omitempty" name:"Extras"`

	// Whether to return the audio-only recording file of different streams in the result callback. The file format is mp3.
	AudioFileNeeded *bool `json:"AudioFileNeeded,omitnil,omitempty" name:"AudioFileNeeded"`

	// A group of real-time recording parameters. It specifies the streams to be recorded, whether to disable the audio recording, and whether to record only low-resolution videos, etc.
	RecordControl *RecordControl `json:"RecordControl,omitnil,omitempty" name:"RecordControl"`

	RecordMode *string `json:"RecordMode,omitnil,omitempty" name:"RecordMode"`

	ChatGroupId *string `json:"ChatGroupId,omitnil,omitempty" name:"ChatGroupId"`

	// Recording timeout. Unit: seconds. Valid range: [300,86400]. Default value: 300.
	//
	// If no upstream audio/video exists or no operation is performed on the whiteboard for the specified period of time, the recording service automatically stops the recording task.
	AutoStopTimeout *int64 `json:"AutoStopTimeout,omitnil,omitempty" name:"AutoStopTimeout"`

	// Internal parameter. You can ignore this parameter.
	ExtraData *string `json:"ExtraData,omitnil,omitempty" name:"ExtraData"`
}

Predefined struct for user

type StartOnlineRecordResponse 

type StartOnlineRecordResponse struct {
	*tchttp.BaseResponse
	Response *StartOnlineRecordResponseParams `json:"Response"`
}

func NewStartOnlineRecordResponse 

func NewStartOnlineRecordResponse() (response *StartOnlineRecordResponse)

func (*StartOnlineRecordResponse) FromJsonString 

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

func (r *StartOnlineRecordResponse) ToJsonString() string

type StartOnlineRecordResponseParams 

type StartOnlineRecordResponseParams struct {
	// ID of the real-time recording task
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

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

Predefined struct for user

type StartWhiteboardPushRequest 

type StartWhiteboardPushRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Room ID of the whiteboard push task. Valid range: (1,4294967295).
	//
	// 1. By default, the whiteboard push task uses the RoomId string as the GroupID of the IM group. For example, if the RoomId string is 1234, the GroupID of the IM group is also 1234. Message synchronization requires joining a group. Make sure that an IM group is created before the push starts. Otherwise, the push fails.
	// 2. If neither TRTCRoomId nor TRTCRoomIdStr is specified, the value of RoomId is used as the Tencent Real-Time Communication (TRTC) room ID for the whiteboard push task.
	RoomId *int64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// User ID used by the whiteboard push service for entering the whiteboard room. If `IMAuthParam`and `TRTCAuthParam` are not specified, this user ID is used for operations such as logging in to the IM application, joining an IM group, and entering the room for TRTC whiteboard push.
	// The ID cannot exceed 60 bytes in length and must be an unused ID. The whiteboard push service uses the user ID to enter the room for whiteboard audio/video push. If this ID is already used in another scenario, the other scenario and whiteboard push service will conflict, affecting the pushing operation.
	PushUserId *string `json:"PushUserId,omitnil,omitempty" name:"PushUserId"`

	// User's IM signature corresponding to the PushUserId.
	PushUserSig *string `json:"PushUserSig,omitnil,omitempty" name:"PushUserSig"`

	// Whiteboard parameters, such as the width, height, and background color of the whiteboard.
	Whiteboard *Whiteboard `json:"Whiteboard,omitnil,omitempty" name:"Whiteboard"`

	// Whiteboard push timeout. Unit: seconds. Valid range: [300,259200]. Default value: 1800.
	//
	// If no operation is performed on the whiteboard for the specified period of time, the whiteboard push service automatically stops whiteboard push.
	AutoStopTimeout *int64 `json:"AutoStopTimeout,omitnil,omitempty" name:"AutoStopTimeout"`

	// Specifies whether to synchronize operations on the primary whiteboard push task to the backup task.
	AutoManageBackup *bool `json:"AutoManageBackup,omitnil,omitempty" name:"AutoManageBackup"`

	// Parameters of the backup whiteboard push task.
	//
	// After the backup parameters are specified, the whiteboard push service adds a relayed video stream. That is, there are two video streams on the whiteboard in the same room.
	Backup *WhiteboardPushBackupParam `json:"Backup,omitnil,omitempty" name:"Backup"`

	// Advanced permission control parameter in TRTC. If the advanced permission control feature is enabled in TRTC, this parameter is required.
	PrivateMapKey *string `json:"PrivateMapKey,omitnil,omitempty" name:"PrivateMapKey"`

	// Frame rate of the whiteboard push video. Valid range: [0,30]. Default value: 20. Unit: fps.
	VideoFPS *int64 `json:"VideoFPS,omitnil,omitempty" name:"VideoFPS"`

	// Whiteboard push bitrate. Valid range: [0,2000]. Default value: 1200. Unit: kbps.
	//
	// The bitrate specified here is a reference value. During actual push, a dynamic bitrate is used. The actual bitrate does not remain the specified value but rather fluctuates around it.
	VideoBitrate *int64 `json:"VideoBitrate,omitnil,omitempty" name:"VideoBitrate"`

	// Specifies whether to automatically record the whiteboard push when the recording mode in TRTC is set to `SubscribeStreamUserIds`.
	//
	// Default value: `false`. If you need to enable automatic whiteboard push recording, set this parameter to `true`.
	//
	// If the recording mode in TRTC is set to `Global Auto Recording`, ignore this parameter.
	AutoRecord *bool `json:"AutoRecord,omitnil,omitempty" name:"AutoRecord"`

	// ID of the whiteboard push recording. The ID is filled in the `userdefinerecordid` parameter in the callback message after cloud recording is complete in TRTC, helping you identify the recording callback and locate the video file in VOD media resource management.
	//
	// The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-).
	//
	// After this parameter is set, automatic whiteboard push recording is enabled regardless of the value of the `AutoRecord` parameter.
	//
	// Default RecordId generation rule:
	// urlencode(SdkAppID_RoomID_PushUserID)
	//
	// Example:
	// SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1
	// Therefore: RecordId = 12345678_12345_push_user_1
	UserDefinedRecordId *string `json:"UserDefinedRecordId,omitnil,omitempty" name:"UserDefinedRecordId"`

	// Specifies whether to enable automatic relay whiteboard push when the relay push mode in TRTC is set to `SubscribeRelayUserIds`.
	//
	// Default value: `false`. If you need to enable automatic relay whiteboard push, set this parameter to `true`.
	//
	// If the recording mode in TRTC is set to `Global Auto Relay`, ignore this parameter.
	AutoPublish *bool `json:"AutoPublish,omitnil,omitempty" name:"AutoPublish"`

	// Stream ID used by TRTC for relay whiteboard push. With this ID, you can stream the user’s audio/video by using the domain name and standard streaming solution (FLV or HLS) in TRTC.
	//
	// The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-).
	//
	// After this parameter is set, automatic relay whiteboard push is enabled regardless of the value of the `AutoPublish` parameter.
	//
	// Default StreamID generation rule:
	// urlencode(SdkAppID_RoomID_PushUserID_main)
	//
	// Example:
	// SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1
	// Therefore, StreamID = 12345678_12345_push_user_1_main
	UserDefinedStreamId *string `json:"UserDefinedStreamId,omitnil,omitempty" name:"UserDefinedStreamId"`

	// Internal parameter. You can ignore this parameter.
	ExtraData *string `json:"ExtraData,omitnil,omitempty" name:"ExtraData"`

	// TRTC room ID of the numeric type. Valid range: (1,4294967295).
	//
	// If RoomId and TRTCRoomId are both specified, the value of TRTCRoomId takes priority as the room ID for TRTC whiteboard push.
	//
	// If the TRTCRoomIdStr parameter is specified, this parameter is ignored.
	TRTCRoomId *int64 `json:"TRTCRoomId,omitnil,omitempty" name:"TRTCRoomId"`

	// TRTC room ID of the string type.
	//
	// If TRTCRoomIdStr is specified, its value takes priority as the room ID for TRTC whiteboard push.
	TRTCRoomIdStr *string `json:"TRTCRoomIdStr,omitnil,omitempty" name:"TRTCRoomIdStr"`

	// IM authentication parameters.
	// If the ID of the IM application used by whiteboard messages is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the IM application.
	//
	// If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the transmission channel for whiteboard messages. If this parameter is left empty, the SdkAppId value in the common parameters is used.
	IMAuthParam *AuthParam `json:"IMAuthParam,omitnil,omitempty" name:"IMAuthParam"`

	// TRTC authentication parameters, used for room entrance authentication for TRTC push.
	// If the ID of the TRTC application to which the target TRTC room belongs is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the TRTC application.
	//
	// If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the ID of the target TRTC application. If this parameter is left empty, the SdkAppId value in the common parameters is used.
	TRTCAuthParam *AuthParam `json:"TRTCAuthParam,omitnil,omitempty" name:"TRTCAuthParam"`

	// This parameter is available only to users in the allowlist for trial.
	//
	// TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCall`.
	//
	// `TRTCAppSceneVideoCall`: This scenario is most suitable when there are two or more people on a video call. The internal encoders and network protocols are optimized for video smoothness to reduce call latency and lagging.
	// `TRTCAppSceneLIVE`: This scenario is most suitable when there is only one person speaking or performing for an online audience, and occasionally multiple people interact with one another through video. The internal encoders and network protocols are optimized for performance and compatibility to deliver better performance and video clarity.
	TRTCEnterRoomMode *string `json:"TRTCEnterRoomMode,omitnil,omitempty" name:"TRTCEnterRoomMode"`
}

func NewStartWhiteboardPushRequest 

func NewStartWhiteboardPushRequest() (request *StartWhiteboardPushRequest)

func (*StartWhiteboardPushRequest) FromJsonString 

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

func (r *StartWhiteboardPushRequest) ToJsonString() string

type StartWhiteboardPushRequestParams 

type StartWhiteboardPushRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Room ID of the whiteboard push task. Valid range: (1,4294967295).
	//
	// 1. By default, the whiteboard push task uses the RoomId string as the GroupID of the IM group. For example, if the RoomId string is 1234, the GroupID of the IM group is also 1234. Message synchronization requires joining a group. Make sure that an IM group is created before the push starts. Otherwise, the push fails.
	// 2. If neither TRTCRoomId nor TRTCRoomIdStr is specified, the value of RoomId is used as the Tencent Real-Time Communication (TRTC) room ID for the whiteboard push task.
	RoomId *int64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// User ID used by the whiteboard push service for entering the whiteboard room. If `IMAuthParam`and `TRTCAuthParam` are not specified, this user ID is used for operations such as logging in to the IM application, joining an IM group, and entering the room for TRTC whiteboard push.
	// The ID cannot exceed 60 bytes in length and must be an unused ID. The whiteboard push service uses the user ID to enter the room for whiteboard audio/video push. If this ID is already used in another scenario, the other scenario and whiteboard push service will conflict, affecting the pushing operation.
	PushUserId *string `json:"PushUserId,omitnil,omitempty" name:"PushUserId"`

	// User's IM signature corresponding to the PushUserId.
	PushUserSig *string `json:"PushUserSig,omitnil,omitempty" name:"PushUserSig"`

	// Whiteboard parameters, such as the width, height, and background color of the whiteboard.
	Whiteboard *Whiteboard `json:"Whiteboard,omitnil,omitempty" name:"Whiteboard"`

	// Whiteboard push timeout. Unit: seconds. Valid range: [300,259200]. Default value: 1800.
	//
	// If no operation is performed on the whiteboard for the specified period of time, the whiteboard push service automatically stops whiteboard push.
	AutoStopTimeout *int64 `json:"AutoStopTimeout,omitnil,omitempty" name:"AutoStopTimeout"`

	// Specifies whether to synchronize operations on the primary whiteboard push task to the backup task.
	AutoManageBackup *bool `json:"AutoManageBackup,omitnil,omitempty" name:"AutoManageBackup"`

	// Parameters of the backup whiteboard push task.
	//
	// After the backup parameters are specified, the whiteboard push service adds a relayed video stream. That is, there are two video streams on the whiteboard in the same room.
	Backup *WhiteboardPushBackupParam `json:"Backup,omitnil,omitempty" name:"Backup"`

	// Advanced permission control parameter in TRTC. If the advanced permission control feature is enabled in TRTC, this parameter is required.
	PrivateMapKey *string `json:"PrivateMapKey,omitnil,omitempty" name:"PrivateMapKey"`

	// Frame rate of the whiteboard push video. Valid range: [0,30]. Default value: 20. Unit: fps.
	VideoFPS *int64 `json:"VideoFPS,omitnil,omitempty" name:"VideoFPS"`

	// Whiteboard push bitrate. Valid range: [0,2000]. Default value: 1200. Unit: kbps.
	//
	// The bitrate specified here is a reference value. During actual push, a dynamic bitrate is used. The actual bitrate does not remain the specified value but rather fluctuates around it.
	VideoBitrate *int64 `json:"VideoBitrate,omitnil,omitempty" name:"VideoBitrate"`

	// Specifies whether to automatically record the whiteboard push when the recording mode in TRTC is set to `SubscribeStreamUserIds`.
	//
	// Default value: `false`. If you need to enable automatic whiteboard push recording, set this parameter to `true`.
	//
	// If the recording mode in TRTC is set to `Global Auto Recording`, ignore this parameter.
	AutoRecord *bool `json:"AutoRecord,omitnil,omitempty" name:"AutoRecord"`

	// ID of the whiteboard push recording. The ID is filled in the `userdefinerecordid` parameter in the callback message after cloud recording is complete in TRTC, helping you identify the recording callback and locate the video file in VOD media resource management.
	//
	// The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-).
	//
	// After this parameter is set, automatic whiteboard push recording is enabled regardless of the value of the `AutoRecord` parameter.
	//
	// Default RecordId generation rule:
	// urlencode(SdkAppID_RoomID_PushUserID)
	//
	// Example:
	// SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1
	// Therefore: RecordId = 12345678_12345_push_user_1
	UserDefinedRecordId *string `json:"UserDefinedRecordId,omitnil,omitempty" name:"UserDefinedRecordId"`

	// Specifies whether to enable automatic relay whiteboard push when the relay push mode in TRTC is set to `SubscribeRelayUserIds`.
	//
	// Default value: `false`. If you need to enable automatic relay whiteboard push, set this parameter to `true`.
	//
	// If the recording mode in TRTC is set to `Global Auto Relay`, ignore this parameter.
	AutoPublish *bool `json:"AutoPublish,omitnil,omitempty" name:"AutoPublish"`

	// Stream ID used by TRTC for relay whiteboard push. With this ID, you can stream the user’s audio/video by using the domain name and standard streaming solution (FLV or HLS) in TRTC.
	//
	// The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-).
	//
	// After this parameter is set, automatic relay whiteboard push is enabled regardless of the value of the `AutoPublish` parameter.
	//
	// Default StreamID generation rule:
	// urlencode(SdkAppID_RoomID_PushUserID_main)
	//
	// Example:
	// SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1
	// Therefore, StreamID = 12345678_12345_push_user_1_main
	UserDefinedStreamId *string `json:"UserDefinedStreamId,omitnil,omitempty" name:"UserDefinedStreamId"`

	// Internal parameter. You can ignore this parameter.
	ExtraData *string `json:"ExtraData,omitnil,omitempty" name:"ExtraData"`

	// TRTC room ID of the numeric type. Valid range: (1,4294967295).
	//
	// If RoomId and TRTCRoomId are both specified, the value of TRTCRoomId takes priority as the room ID for TRTC whiteboard push.
	//
	// If the TRTCRoomIdStr parameter is specified, this parameter is ignored.
	TRTCRoomId *int64 `json:"TRTCRoomId,omitnil,omitempty" name:"TRTCRoomId"`

	// TRTC room ID of the string type.
	//
	// If TRTCRoomIdStr is specified, its value takes priority as the room ID for TRTC whiteboard push.
	TRTCRoomIdStr *string `json:"TRTCRoomIdStr,omitnil,omitempty" name:"TRTCRoomIdStr"`

	// IM authentication parameters.
	// If the ID of the IM application used by whiteboard messages is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the IM application.
	//
	// If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the transmission channel for whiteboard messages. If this parameter is left empty, the SdkAppId value in the common parameters is used.
	IMAuthParam *AuthParam `json:"IMAuthParam,omitnil,omitempty" name:"IMAuthParam"`

	// TRTC authentication parameters, used for room entrance authentication for TRTC push.
	// If the ID of the TRTC application to which the target TRTC room belongs is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the TRTC application.
	//
	// If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the ID of the target TRTC application. If this parameter is left empty, the SdkAppId value in the common parameters is used.
	TRTCAuthParam *AuthParam `json:"TRTCAuthParam,omitnil,omitempty" name:"TRTCAuthParam"`

	// This parameter is available only to users in the allowlist for trial.
	//
	// TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCall`.
	//
	// `TRTCAppSceneVideoCall`: This scenario is most suitable when there are two or more people on a video call. The internal encoders and network protocols are optimized for video smoothness to reduce call latency and lagging.
	// `TRTCAppSceneLIVE`: This scenario is most suitable when there is only one person speaking or performing for an online audience, and occasionally multiple people interact with one another through video. The internal encoders and network protocols are optimized for performance and compatibility to deliver better performance and video clarity.
	TRTCEnterRoomMode *string `json:"TRTCEnterRoomMode,omitnil,omitempty" name:"TRTCEnterRoomMode"`
}

Predefined struct for user

type StartWhiteboardPushResponse 

type StartWhiteboardPushResponse struct {
	*tchttp.BaseResponse
	Response *StartWhiteboardPushResponseParams `json:"Response"`
}

func NewStartWhiteboardPushResponse 

func NewStartWhiteboardPushResponse() (response *StartWhiteboardPushResponse)

func (*StartWhiteboardPushResponse) FromJsonString 

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

func (r *StartWhiteboardPushResponse) ToJsonString() string

type StartWhiteboardPushResponseParams 

type StartWhiteboardPushResponseParams struct {
	// Push task ID.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// Result parameters of the backup task.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	Backup *string `json:"Backup,omitnil,omitempty" name:"Backup"`

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

Predefined struct for user

type StopOnlineRecordRequest 

type StopOnlineRecordRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the recording task to stop
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewStopOnlineRecordRequest 

func NewStopOnlineRecordRequest() (request *StopOnlineRecordRequest)

func (*StopOnlineRecordRequest) FromJsonString 

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

func (r *StopOnlineRecordRequest) ToJsonString() string

type StopOnlineRecordRequestParams 

type StopOnlineRecordRequestParams struct {
	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the recording task to stop
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type StopOnlineRecordResponse 

type StopOnlineRecordResponse struct {
	*tchttp.BaseResponse
	Response *StopOnlineRecordResponseParams `json:"Response"`
}

func NewStopOnlineRecordResponse 

func NewStopOnlineRecordResponse() (response *StopOnlineRecordResponse)

func (*StopOnlineRecordResponse) FromJsonString 

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

func (r *StopOnlineRecordResponse) ToJsonString() string

type StopOnlineRecordResponseParams 

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

Predefined struct for user

type StopWhiteboardPushRequest 

type StopWhiteboardPushRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the whiteboard push task to be stopped.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

func NewStopWhiteboardPushRequest 

func NewStopWhiteboardPushRequest() (request *StopWhiteboardPushRequest)

func (*StopWhiteboardPushRequest) FromJsonString 

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

func (r *StopWhiteboardPushRequest) ToJsonString() string

type StopWhiteboardPushRequestParams 

type StopWhiteboardPushRequestParams struct {
	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// ID of the whiteboard push task to be stopped.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}

Predefined struct for user

type StopWhiteboardPushResponse 

type StopWhiteboardPushResponse struct {
	*tchttp.BaseResponse
	Response *StopWhiteboardPushResponseParams `json:"Response"`
}

func NewStopWhiteboardPushResponse 

func NewStopWhiteboardPushResponse() (response *StopWhiteboardPushResponse)

func (*StopWhiteboardPushResponse) FromJsonString 

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

func (r *StopWhiteboardPushResponse) ToJsonString() string

type StopWhiteboardPushResponseParams 

type StopWhiteboardPushResponseParams struct {
	// Parameters of the backup task.
	// Note: This parameter may return null, indicating that no valid values can be obtained.
	Backup *string `json:"Backup,omitnil,omitempty" name:"Backup"`

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

Predefined struct for user

type StreamControl 

type StreamControl struct {
	// Video stream ID
	// Description of the possible video stream ID values:
	// 1. `tic_record_user`: the whiteboard video stream
	// 2. `tic_substream`: the auxiliary video stream
	// 3. Specific user ID: the video stream of the specified user
	//
	// The actual recording uses the prefix match of the video stream ID. The real stream becomes the specified stream once its ID prefix matches with the stream ID.
	StreamId *string `json:"StreamId,omitnil,omitempty" name:"StreamId"`

	// Whether to disable recording over the stream.
	//
	// true: does not record this stream. This stream will not be included in the final recording file.
	// false: records this stream. This stream will be included in the final recording file.
	//
	// Default value: false
	DisableRecord *bool `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// Whether to disable the audio recording of the stream.
	//
	// true: does not record the audio of the stream. In the final recording file, this stream will be soundless.
	// false: the stream has both video and audio recording.
	//
	// Default value: false
	DisableAudio *bool `json:"DisableAudio,omitnil,omitempty" name:"DisableAudio"`

	// Whether to only record low-resolution stream videos.
	//
	// true: records only low-resolution videos. In this case, please make sure that the client pushes low-resolution videos upstream. Otherwise, the recorded video may be black.
	// false: records only high-resolution videos.
	//
	// Default value: false
	PullSmallVideo *bool `json:"PullSmallVideo,omitnil,omitempty" name:"PullSmallVideo"`
}

type StreamLayout 

type StreamLayout struct {
	// Stream layout configuration
	LayoutParams *LayoutParams `json:"LayoutParams,omitnil,omitempty" name:"LayoutParams"`

	// Video stream ID
	// Description of the possible video stream ID values:
	// 1. tic_record_user: the current picture is used to display the whiteboard video stream.
	// 2. tic_substream: the current picture is used to display the auxiliary video stream.
	// 3. Specific user ID: the current picture is used to display the video stream of a specific user.
	// 4.Left empty: the current picture is vacant for new video stream.
	InputStreamId *string `json:"InputStreamId,omitnil,omitempty" name:"InputStreamId"`

	// Background color in RGB format, such as "#FF0000" for red. The default color is black.
	BackgroundColor *string `json:"BackgroundColor,omitnil,omitempty" name:"BackgroundColor"`

	// Video filling mode.
	//
	// 0: self-adaption mode. Scales the video proportionally to completely display it in the specified area. In this mode, there may be black bars.
	// 1: full-screen mode. Scales the video to make it fill the entire specified area. In this mode, no black bars will appear, but the video may not be displayed fully.
	FillMode *int64 `json:"FillMode,omitnil,omitempty" name:"FillMode"`
}

type Tag 

type Tag struct {
	// Tag key.
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// Tag value.
	TagValue *string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}

type TimeValue 

type TimeValue struct {
	// Unix timestamp in seconds.
	Time *uint64 `json:"Time,omitnil,omitempty" name:"Time"`

	// Current value of the queried metric.
	Value *float64 `json:"Value,omitnil,omitempty" name:"Value"`
}

type TranscodeTaskResult 

type TranscodeTaskResult struct {
	// Transcoding result URL.
	ResultUrl *string `json:"ResultUrl,omitnil,omitempty" name:"ResultUrl"`

	// Target resolution.
	Resolution *string `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// Title (usually the document name).
	Title *string `json:"Title,omitnil,omitempty" name:"Title"`

	// Number of transcoded pages.
	Pages *int64 `json:"Pages,omitnil,omitempty" name:"Pages"`

	// URL prefix of the thumbnail. If the URL prefix is `http://example.com/g0jb42ps49vtebjshilb/`, the thumbnail URL for the first page of the dynamically transcoded PowerPoint file is
	// `http://example.com/g0jb42ps49vtebjshilb/1.jpg`, and so on.
	//
	// If the document transcoding request carries the ThumbnailResolution parameter and the transcoding type is dynamic transcoding, this parameter is not null. In other cases, this parameter is null.
	ThumbnailUrl *string `json:"ThumbnailUrl,omitnil,omitempty" name:"ThumbnailUrl"`

	// Resolution of the thumbnail generated for dynamic transcoding
	ThumbnailResolution *string `json:"ThumbnailResolution,omitnil,omitempty" name:"ThumbnailResolution"`

	// URL for downloading the transcoded and compressed file. If `CompressFileType` carried in the document transcoding request is null or is not a supported compression format, this parameter is null.
	CompressFileUrl *string `json:"CompressFileUrl,omitnil,omitempty" name:"CompressFileUrl"`

	// Task execution error code.
	ErrorCode *int64 `json:"ErrorCode,omitnil,omitempty" name:"ErrorCode"`

	// Task execution error message.
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`
}

type TranscodeTaskSearchResult 

type TranscodeTaskSearchResult struct {
	// Creation time of the task.
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// Unique task ID.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// Current task status.
	// - QUEUED: Queuing for transcoding.
	// - PROCESSING: Transcoding in progress.
	// - FINISHED: Transcoding finished.
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Original name of the transcoded document.
	OriginalFilename *string `json:"OriginalFilename,omitnil,omitempty" name:"OriginalFilename"`

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Transcoding task result.
	Result *TranscodeTaskResult `json:"Result,omitnil,omitempty" name:"Result"`

	// Specifies whether the transcoding is static.
	IsStatic *bool `json:"IsStatic,omitnil,omitempty" name:"IsStatic"`
}

type UsageDataItem 

type UsageDataItem struct {
	// Start date in the format of YYYY-MM-DD.
	Time *string `json:"Time,omitnil,omitempty" name:"Time"`

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Subproduct usage information, which is consistent with the corresponding request parameters.
	// - sp_tiw_board: The duration of use of whiteboards.
	// - sp_tiw_dt: The number of pages dynamically transcoded.
	// - sp_tiw_st: The number of pages statically transcoded.
	// - sp_tiw_ric: The duration of real-time recording.
	SubProduct *string `json:"SubProduct,omitnil,omitempty" name:"SubProduct"`

	// Usage values.
	// - The unit of sp_tiw_dt and sp_tiw_st is pages.
	// - The unit of sp_tiw_board and sp_tiw_ric is minutes.
	Value *float64 `json:"Value,omitnil,omitempty" name:"Value"`
}

type UserListItem 

type UserListItem struct {
	// User ID in the room.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The first time when the user ID appeared during the queried period, which is a Unix timestamp in milliseconds.
	StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The last time when the user ID appeared during the queried period, which is a Unix timestamp in milliseconds.
	EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`
}

type VideoInfo 

type VideoInfo struct {
	// Video playback start time, in milliseconds
	VideoPlayTime *int64 `json:"VideoPlayTime,omitnil,omitempty" name:"VideoPlayTime"`

	// Video size, in bytes
	VideoSize *int64 `json:"VideoSize,omitnil,omitempty" name:"VideoSize"`

	// Video format
	VideoFormat *string `json:"VideoFormat,omitnil,omitempty" name:"VideoFormat"`

	// Video playback duration, in milliseconds
	VideoDuration *int64 `json:"VideoDuration,omitnil,omitempty" name:"VideoDuration"`

	// Video file URL
	VideoUrl *string `json:"VideoUrl,omitnil,omitempty" name:"VideoUrl"`

	// Video file ID
	VideoId *string `json:"VideoId,omitnil,omitempty" name:"VideoId"`

	// Video stream type - 0: camera video - 1: screen-sharing video - 2: whiteboard video - 3: mixed stream video - 4: audio-only (mp3)
	VideoType *int64 `json:"VideoType,omitnil,omitempty" name:"VideoType"`

	// ID of the user to which the camera video or screen-sharing video belongs (whiteboard video: null, mixed stream video: tic_mixstream_<Room ID>_<Mixed stream layout type>, auxiliary video: tic_substream_user ID)
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Width of the video resolution.
	Width *int64 `json:"Width,omitnil,omitempty" name:"Width"`

	// Height of the video resolution.
	Height *int64 `json:"Height,omitnil,omitempty" name:"Height"`
}

type Whiteboard 

type Whiteboard struct {
	// Whiteboard video width in the real-time recording result. The value must be equal to or greater than 2. Default value: 1280.
	Width *int64 `json:"Width,omitnil,omitempty" name:"Width"`

	// Whiteboard video height in the real-time recording result. The value must be equal to or greater than 2. Default value: 960.
	Height *int64 `json:"Height,omitnil,omitempty" name:"Height"`

	// Whiteboard initialization parameter, which is passed through to the whiteboard SDK
	InitParam *string `json:"InitParam,omitnil,omitempty" name:"InitParam"`
}

type WhiteboardApplicationConfig 

type WhiteboardApplicationConfig struct {
	// Task type.
	//
	// recording: Real-time recording.
	// transcode: Document transcoding.
	TaskType *string `json:"TaskType,omitnil,omitempty" name:"TaskType"`

	// Bucket name.
	BucketName *string `json:"BucketName,omitnil,omitempty" name:"BucketName"`

	// Region of the bucket.
	BucketLocation *string `json:"BucketLocation,omitnil,omitempty" name:"BucketLocation"`

	// Resource prefix of the bucket.
	BucketPrefix *string `json:"BucketPrefix,omitnil,omitempty" name:"BucketPrefix"`

	// Destination CDN domain name.
	ResultDomain *string `json:"ResultDomain,omitnil,omitempty" name:"ResultDomain"`

	// Callback URL.
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`

	// Callback authentication key.
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// IM admin user ID.
	AdminUserId *string `json:"AdminUserId,omitnil,omitempty" name:"AdminUserId"`

	// IM admin user signature.
	AdminUserSig *string `json:"AdminUserSig,omitnil,omitempty" name:"AdminUserSig"`
}

type WhiteboardPushBackupParam 

type WhiteboardPushBackupParam struct {
	// User ID used by the whiteboard push service for entering a room,
	// The ID must be an unused ID in the SDK. The whiteboard push service uses the user ID to enter the room for whiteboard push. If this ID is already used in the SDK, the SDK and recording service will conflict, affecting the pushing operation.
	PushUserId *string `json:"PushUserId,omitnil,omitempty" name:"PushUserId"`

	// Signature corresponding to the PushUserId ID.
	PushUserSig *string `json:"PushUserSig,omitnil,omitempty" name:"PushUserSig"`
}

type WhiteboardPushResult 

type WhiteboardPushResult struct {
	// `AUTO`: Pushing automatically stops. `USER_CALL`: The API for stopping pushing is called.
	FinishReason *string `json:"FinishReason,omitnil,omitempty" name:"FinishReason"`

	// Number of exceptions.
	ExceptionCnt *int64 `json:"ExceptionCnt,omitnil,omitempty" name:"ExceptionCnt"`

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

	// IM group ID.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// Actual push start time.
	PushStartTime *int64 `json:"PushStartTime,omitnil,omitempty" name:"PushStartTime"`

	// Push end time.
	PushStopTime *int64 `json:"PushStopTime,omitnil,omitempty" name:"PushStopTime"`

	// IM timestamp corresponding to the first frame of the whiteboard push video. The timestamp is used for time synchronization between IM messages and the whiteboard push video during playback.
	IMSyncTime *int64 `json:"IMSyncTime,omitnil,omitempty" name:"IMSyncTime"`

	// Task execution error code.
	ErrorCode *int64 `json:"ErrorCode,omitnil,omitempty" name:"ErrorCode"`

	// Error message.
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`
}

type WhiteboardPushTaskSearchResult 

type WhiteboardPushTaskSearchResult struct {
	// Unique task ID.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	// Status of the whiteboard push task.
	// - PREPARED: Push in preparation.
	// - PUSHING: Pushing in progress.
	// - STOPPED: Pushing stopped.
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Room ID of the whiteboard push task.
	RoomId *int64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Creation time of the task.
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// SdkAppId of the whiteboard application.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Whiteboard push result.
	Result *WhiteboardPushResult `json:"Result,omitnil,omitempty" name:"Result"`

	// User ID of the whiteboard push task.
	PushUserId *string `json:"PushUserId,omitnil,omitempty" name:"PushUserId"`
}

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.