v20190919

package
v3.0.678+incompatible Latest Latest
Warning

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

 Go to latest Published: Apr 19, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type Canvas struct {
	// Width and height of the mixed stream canvas
	LayoutParams *LayoutParams `json:"LayoutParams,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,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) 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: 

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: 

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

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: 

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: 

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: 

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

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: 

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: 

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
RESOURCEUNAVAILABLE_NOTREGISTERED = "ResourceUnavailable.NotRegistered"
RESOURCEUNAVAILABLE_SERVICEEXPIRED = "ResourceUnavailable.ServiceExpired"
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: 

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

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: 

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: 

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: 

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://intl.cloud.tencent.com/document/product/1137/40258?from_cn_redirect=1).

error code that may be returned: 

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://intl.cloud.tencent.com/document/product/1137/40257?from_cn_redirect=1).

error code that may be returned: 

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://intl.cloud.tencent.com/document/product/1137/40257?from_cn_redirect=1).

error code that may be returned: 

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://intl.cloud.tencent.com/document/product/1137/40258?from_cn_redirect=1).

error code that may be returned: 

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://intl.cloud.tencent.com/document/product/1137/40260?from_cn_redirect=1).

error code that may be returned: 

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://intl.cloud.tencent.com/document/product/1137/40257?from_cn_redirect=1).

error code that may be returned: 

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://intl.cloud.tencent.com/document/product/1137/40257?from_cn_redirect=1).

error code that may be returned: 

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://intl.cloud.tencent.com/document/product/1137/40260?from_cn_redirect=1).

error code that may be returned: 

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: 

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: 

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: 

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: 

INVALIDPARAMETER_BODYPARAMETERTYPEUNMATCHED = "InvalidParameter.BodyParameterTypeUnmatched"
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,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,omitempty" name:"Image"`
}

type CreateTranscodeRequest 

type CreateTranscodeRequest struct {
	*tchttp.BaseRequest

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

	// Address of the file for transcoding
	Url *string `json:"Url,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,omitempty" name:"IsStaticPPT"`

	// 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.
	//
	//
	MinResolution *string `json:"MinResolution,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,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,omitempty" name:"CompressFileType"`
}

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,omitempty" name:"SdkAppId"`

	// Address of the file for transcoding
	Url *string `json:"Url,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,omitempty" name:"IsStaticPPT"`

	// 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.
	//
	//
	MinResolution *string `json:"MinResolution,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,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,omitempty" name:"CompressFileType"`
}

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,omitempty" name:"TaskId"`

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

Predefined struct for user

type CustomLayout 

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

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

type DescribeOnlineRecordCallbackRequest 

type DescribeOnlineRecordCallbackRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the application
	SdkAppId *int64 `json:"SdkAppId,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,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,omitempty" name:"Callback"`

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

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

Predefined struct for user

type DescribeOnlineRecordRequest 

type DescribeOnlineRecordRequest struct {
	*tchttp.BaseRequest

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

	// ID of the real-time recording task
	TaskId *string `json:"TaskId,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,omitempty" name:"SdkAppId"`

	// ID of the real-time recording task
	TaskId *string `json:"TaskId,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 during recording.
	FinishReason *string `json:"FinishReason,omitempty" name:"FinishReason"`

	// ID of the recording task to be queried.
	TaskId *string `json:"TaskId,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,omitempty" name:"Status"`

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

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

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

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

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

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

	// Number of exceptions during recording
	ExceptionCnt *int64 `json:"ExceptionCnt,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,omitempty" name:"OmittedDurations"`

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

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

Predefined struct for user

type DescribeTranscodeCallbackRequest 

type DescribeTranscodeCallbackRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the application
	SdkAppId *int64 `json:"SdkAppId,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,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,omitempty" name:"Callback"`

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

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

Predefined struct for user

type DescribeTranscodeRequest 

type DescribeTranscodeRequest struct {
	*tchttp.BaseRequest

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

	// Unique ID of the document transcoding task
	TaskId *string `json:"TaskId,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,omitempty" name:"SdkAppId"`

	// Unique ID of the document transcoding task
	TaskId *string `json:"TaskId,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,omitempty" name:"Pages"`

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

	// Document resolution
	Resolution *string `json:"Resolution,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,omitempty" name:"ResultUrl"`

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

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

	// Document name
	Title *string `json:"Title,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,omitempty" name:"ThumbnailUrl"`

	// Resolution of the thumbnail generated for dynamic transcoding
	ThumbnailResolution *string `json:"ThumbnailResolution,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,omitempty" name:"CompressFileUrl"`

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

Predefined struct for user

type LayoutParams 

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

	// Stream image height. Value range: [2,3000]
	Height *int64 `json:"Height,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,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,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,omitempty" name:"ZOrder"`
}

type MixStream 

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

	// Whether audio stream mixing is disabled
	DisableAudio *bool `json:"DisableAudio,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,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,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,omitempty" name:"Custom"`
}

type OmittedDuration 

type OmittedDuration struct {
	// Offset of the paused time in the spliced video, in milliseconds
	VideoTime *int64 `json:"VideoTime,omitempty" name:"VideoTime"`

	// Recording pause timestamp, in milliseconds
	PauseTime *int64 `json:"PauseTime,omitempty" name:"PauseTime"`

	// Recording resumption timestamp, in milliseconds
	ResumeTime *int64 `json:"ResumeTime,omitempty" name:"ResumeTime"`
}

type PauseOnlineRecordRequest 

type PauseOnlineRecordRequest struct {
	*tchttp.BaseRequest

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

	// ID of the real-time recording task
	TaskId *string `json:"TaskId,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,omitempty" name:"SdkAppId"`

	// ID of the real-time recording task
	TaskId *string `json:"TaskId,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,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,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,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,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,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,omitempty" name:"StreamControls"`
}

type ResumeOnlineRecordRequest 

type ResumeOnlineRecordRequest struct {
	*tchttp.BaseRequest

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

	// ID of the resumed real-time recording task
	TaskId *string `json:"TaskId,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,omitempty" name:"SdkAppId"`

	// ID of the resumed real-time recording task
	TaskId *string `json:"TaskId,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,omitempty" name:"RequestId"`
}

Predefined struct for user

type SetOnlineRecordCallbackKeyRequest 

type SetOnlineRecordCallbackKeyRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the application
	SdkAppId *int64 `json:"SdkAppId,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://intl.cloud.tencent.com/document/product/1137/40257?from_cn_redirect=1).
	CallbackKey *string `json:"CallbackKey,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,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://intl.cloud.tencent.com/document/product/1137/40257?from_cn_redirect=1).
	CallbackKey *string `json:"CallbackKey,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,omitempty" name:"RequestId"`
}

Predefined struct for user

type SetOnlineRecordCallbackRequest 

type SetOnlineRecordCallbackRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,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://intl.cloud.tencent.com/document/product/1137/40258?from_cn_redirect=1).
	Callback *string `json:"Callback,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,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://intl.cloud.tencent.com/document/product/1137/40258?from_cn_redirect=1).
	Callback *string `json:"Callback,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,omitempty" name:"RequestId"`
}

Predefined struct for user

type SetTranscodeCallbackKeyRequest 

type SetTranscodeCallbackKeyRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the application
	SdkAppId *int64 `json:"SdkAppId,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://intl.cloud.tencent.com/document/product/1137/40257?from_cn_redirect=1).
	CallbackKey *string `json:"CallbackKey,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,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://intl.cloud.tencent.com/document/product/1137/40257?from_cn_redirect=1).
	CallbackKey *string `json:"CallbackKey,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,omitempty" name:"RequestId"`
}

Predefined struct for user

type SetTranscodeCallbackRequest 

type SetTranscodeCallbackRequest struct {
	*tchttp.BaseRequest

	// SdkAppId of the customer
	SdkAppId *int64 `json:"SdkAppId,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://intl.cloud.tencent.com/document/product/1137/40260?from_cn_redirect=1).
	Callback *string `json:"Callback,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,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://intl.cloud.tencent.com/document/product/1137/40260?from_cn_redirect=1).
	Callback *string `json:"Callback,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,omitempty" name:"RequestId"`
}

Predefined struct for user

type StartOnlineRecordRequest 

type StartOnlineRecordRequest struct {
	*tchttp.BaseRequest

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

	// ID of the room for recording. Value range: (1, 4294967295)
	RoomId *int64 `json:"RoomId,omitempty" name:"RoomId"`

	// User ID used by the real-time recording service for entering a room. 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 real-time 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,omitempty" name:"RecordUserId"`

	// Signature corresponding to RecordUserId
	RecordUserSig *string `json:"RecordUserSig,omitempty" name:"RecordUserSig"`

	// (Disused) IM group ID of the whiteboard. By default, it is the same as the room ID.
	GroupId *string `json:"GroupId,omitempty" name:"GroupId"`

	// Real-time recording video splicing parameter
	Concat *Concat `json:"Concat,omitempty" name:"Concat"`

	// Real-time recording whiteboard parameter, such as the whiteboard width and height
	Whiteboard *Whiteboard `json:"Whiteboard,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,omitempty" name:"MixStream"`

	// List of advanced features used
	// List of possible values:
	// MIX_STREAM - Stream mixing feature
	Extras []*string `json:"Extras,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,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,omitempty" name:"RecordControl"`
}

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,omitempty" name:"SdkAppId"`

	// ID of the room for recording. Value range: (1, 4294967295)
	RoomId *int64 `json:"RoomId,omitempty" name:"RoomId"`

	// User ID used by the real-time recording service for entering a room. 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 real-time 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,omitempty" name:"RecordUserId"`

	// Signature corresponding to RecordUserId
	RecordUserSig *string `json:"RecordUserSig,omitempty" name:"RecordUserSig"`

	// (Disused) IM group ID of the whiteboard. By default, it is the same as the room ID.
	GroupId *string `json:"GroupId,omitempty" name:"GroupId"`

	// Real-time recording video splicing parameter
	Concat *Concat `json:"Concat,omitempty" name:"Concat"`

	// Real-time recording whiteboard parameter, such as the whiteboard width and height
	Whiteboard *Whiteboard `json:"Whiteboard,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,omitempty" name:"MixStream"`

	// List of advanced features used
	// List of possible values:
	// MIX_STREAM - Stream mixing feature
	Extras []*string `json:"Extras,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,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,omitempty" name:"RecordControl"`
}

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,omitempty" name:"TaskId"`

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

Predefined struct for user

type StopOnlineRecordRequest 

type StopOnlineRecordRequest struct {
	*tchttp.BaseRequest

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

	// ID of the recording task to stop
	TaskId *string `json:"TaskId,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,omitempty" name:"SdkAppId"`

	// ID of the recording task to stop
	TaskId *string `json:"TaskId,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,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,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,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,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,omitempty" name:"PullSmallVideo"`
}

type StreamLayout 

type StreamLayout struct {
	// Stream layout configuration
	LayoutParams *LayoutParams `json:"LayoutParams,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,omitempty" name:"InputStreamId"`

	// Background color in RGB format, such as "#FF0000" for red. The default color is black.
	BackgroundColor *string `json:"BackgroundColor,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,omitempty" name:"FillMode"`
}

type VideoInfo 

type VideoInfo struct {
	// Video playback start time, in milliseconds
	VideoPlayTime *int64 `json:"VideoPlayTime,omitempty" name:"VideoPlayTime"`

	// Video size, in bytes
	VideoSize *int64 `json:"VideoSize,omitempty" name:"VideoSize"`

	// Video format
	VideoFormat *string `json:"VideoFormat,omitempty" name:"VideoFormat"`

	// Video playback duration, in milliseconds
	VideoDuration *int64 `json:"VideoDuration,omitempty" name:"VideoDuration"`

	// Video file URL
	VideoUrl *string `json:"VideoUrl,omitempty" name:"VideoUrl"`

	// Video file ID
	VideoId *string `json:"VideoId,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,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,omitempty" name:"UserId"`

	// Width of the video resolution.
	Width *int64 `json:"Width,omitempty" name:"Width"`

	// Height of the video resolution.
	Height *int64 `json:"Height,omitempty" name:"Height"`
}

type Whiteboard 

type Whiteboard struct {
	// Whiteboard video width in the real-time recording result. The default value is 1280.
	Width *int64 `json:"Width,omitempty" name:"Width"`

	// Whiteboard video height in the real-time recording result. The default value is 960.
	Height *int64 `json:"Height,omitempty" name:"Height"`

	// Whiteboard initialization parameter, which is passed through to the whiteboard SDK
	InitParam *string `json:"InitParam,omitempty" name:"InitParam"`
}

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.