v20190722

package
v3.0.525+incompatible Latest Latest
Warning

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

 Go to latest Published: Aug 31, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

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

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

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

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

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

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

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

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

	// Internal error.
	INTERNALERROR = "InternalError"

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

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

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

	// Parameter error.
	INVALIDPARAMETER = "InvalidParameter"

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

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

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

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

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

	// Missing parameter.
	MISSINGPARAMETER = "MissingParameter"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// No permission to manipulate `SdkAppId`.
	UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
)
View Source 
const APIVersion = "2019-07-22"

Variables

This section is empty.

Functions

This section is empty.

Types

type AgentParams 

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

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

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

type AudioEncode 

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

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

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

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

type AudioParams 

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

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

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

type Client 

type Client struct {
	common.Client
}

func NewClient 

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

func NewClientWithSecretId 

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

Deprecated

func (*Client) CreateCloudRecording 

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

CreateCloudRecording API description:

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

You can use this API to perform the following operations:

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

* Specify the storage service you want to save recording files to by using the `StorageParams` parameter

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

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

Key concepts:

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

* Mixed-stream recording: Mix the audios and videos of subscribed users (`UserId`) in a room, record the mixed stream, and save the recording files to VOD.

error code that may be returned: 

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

func (*Client) CreateCloudRecordingWithContext 

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

CreateCloudRecording API description:

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

You can use this API to perform the following operations:

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

* Specify the storage service you want to save recording files to by using the `StorageParams` parameter

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

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

Key concepts:

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

* Mixed-stream recording: Mix the audios and videos of subscribed users (`UserId`) in a room, record the mixed stream, and save the recording files to VOD.

error code that may be returned: 

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

func (*Client) DeleteCloudRecording 

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

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

error code that may be returned: 

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

func (*Client) DeleteCloudRecordingWithContext 

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

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

error code that may be returned: 

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

func (*Client) DescribeCloudRecording 

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

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

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

error code that may be returned: 

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

func (*Client) DescribeCloudRecordingWithContext 

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

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

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

error code that may be returned: 

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

func (*Client) DismissRoom 

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

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

error code that may be returned: 

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

func (*Client) DismissRoomByStrRoomId 

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

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

error code that may be returned: 

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

func (*Client) DismissRoomByStrRoomIdWithContext 

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

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

error code that may be returned: 

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

func (*Client) DismissRoomWithContext 

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

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

error code that may be returned: 

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

func (*Client) ModifyCloudRecording 

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

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

error code that may be returned: 

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

func (*Client) ModifyCloudRecordingWithContext 

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

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

error code that may be returned: 

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

func (*Client) RemoveUser 

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

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

error code that may be returned: 

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

func (*Client) RemoveUserByStrRoomId 

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

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

error code that may be returned: 

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

func (*Client) RemoveUserByStrRoomIdWithContext 

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

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

error code that may be returned: 

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

func (*Client) RemoveUserWithContext 

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

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

error code that may be returned: 

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

func (*Client) StartPublishCdnStream 

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

StartPublishCdnStream This API is used to mix streams and relay the mixed stream to CDNs. You can use this API to do the following:

1. Publish (also known as “relay”) the audio/video stream of one anchor to CDNs. For details, see example 2 (starting a task to relay the audio and video of a stream) and example 3 (starting a task to relay only the audio of a stream).

2. Mix the streams of multiple anchors in a room or in different rooms and publish the mixed stream to CDNs. You can use `AudioParams.SubscribeAudioList` to specify the users whose audios are mixed, and use `VideoParams.LayoutParams` to specify the layout of the anchors’ videos. For details, see example 1 (mixing streams and publishing the mixed stream to a CDN).

3. Mix multiple streams in a room according to a template and publish the mixed stream to CDNs. The TRTC backend will detect the change of anchors in the room and adjust the video layout automatically according to the stream mixing template. The following template types are supported:

  • Floating: The entire screen is covered by the video image of the first user who enters the room, and the images of other users are displayed as small images in rows in the bottom-left corner in room entry sequence. The screen allows up to 4 rows of 4 small images, which float over the large main image. Up to 1 large image and 15 small images can be displayed.

  • Grid: The images of all users split the screen evenly. The more the users, the smaller the image dimensions. Up to 16 images are supported.

  • Screen sharing: This is designed for video conferencing and online education. The shared screen (or camera image of the anchor) is always displayed as the large main image, which occupies the left half of the screen, and the images of other users occupy the right half in up to two columns of up to eight small images each. Up to 1 large image and 15 small images can be displayed. If the upstream aspect ratio does not match the output, the large image on the left will be scaled and displayed in whole, while the small images on the right will be cropped.

4. Publish audio/video streams to up to 10 CDNs at a time. You can use `PublishCdnParams.PublishCdnUrl` to specify the URLs of the CDNs to publish to. To publish to Tencent Cloud’s CDN, set `PublishCdnParams.IsTencentCdn` to 1.

5. Configure a server-side callback to have Tencent Cloud send relay status updates to your server in the form of HTTP/HTTPS POST requests. To use the callback for relay events, please contact Technical Support.

Notes:

1. **Because On-Cloud MixTranscoding is a paid feature, calling this API will incur MixTranscoding fees. For details, see [Billing of MixTranscoding and Relay to CDN](https://intl.cloud.tencent.com/document/product/647/47631?lang=en&pg=).**

2. **Relaying to third-party CDNs will incur relaying fees. For details, see [Billing of MixTranscoding and Relay to CDN](https://intl.cloud.tencent.com/document/product/647/47631?lang=en&pg=).**

Others:

1. You need to first call `StartPublishCdnStream` to start a relay task and get the task ID before you can use the `UpdatePublishCdnStream` API to modify the task and `StopPublishCdnStream` to stop the task.

2. To ensure the stability of relaying, you cannot switch between relaying audio only, relaying audio and video, and relaying video only for the same task.

3. To ensure the stability of relaying, you cannot change the video codec, audio codec, audio sample rate, audio bitrate, or sound channels using the `UpdatePublishCdnStream` API.

4. When you relay a single stream, specify both `AudioParams` and `VideoParams` to publish both audio and video, and specify only `AudioParams` to publish audio only. You cannot switch between the two modes during the relaying process. For `VideoParams`, set `Width`, `Height`, `Fps`, `Bitrate`, and `Gop` according to the actual settings used for publishing.

5. The `SequenceNumber` parameter is required when you call `UpdatePublishCdnStream` to change the relaying parameters. It ensures that multiple requests for the same relaying task are in the correct order. The value of `SequenceNumber` increases each time a new request is made for the same task. If `InternalError` is returned, try again using the same `SequenceNumber`. You don’t need to handle the `FailedOperation.OutdateRequest` error.

6. You can create a relay task before anchors enter a room, in which case you need to manually call `StopPublishCdnStream` to stop the task. If you don’t, after all the users whose streams are mixed leave the room, the TRTC backend will wait for the timeout period (`AgentParams.MaxIdleTime`) to elapse before stopping the relaying task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"
FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency"
INTERNALERROR = "InternalError"
INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"

func (*Client) StartPublishCdnStreamWithContext 

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

StartPublishCdnStream This API is used to mix streams and relay the mixed stream to CDNs. You can use this API to do the following:

1. Publish (also known as “relay”) the audio/video stream of one anchor to CDNs. For details, see example 2 (starting a task to relay the audio and video of a stream) and example 3 (starting a task to relay only the audio of a stream).

2. Mix the streams of multiple anchors in a room or in different rooms and publish the mixed stream to CDNs. You can use `AudioParams.SubscribeAudioList` to specify the users whose audios are mixed, and use `VideoParams.LayoutParams` to specify the layout of the anchors’ videos. For details, see example 1 (mixing streams and publishing the mixed stream to a CDN).

3. Mix multiple streams in a room according to a template and publish the mixed stream to CDNs. The TRTC backend will detect the change of anchors in the room and adjust the video layout automatically according to the stream mixing template. The following template types are supported:

  • Floating: The entire screen is covered by the video image of the first user who enters the room, and the images of other users are displayed as small images in rows in the bottom-left corner in room entry sequence. The screen allows up to 4 rows of 4 small images, which float over the large main image. Up to 1 large image and 15 small images can be displayed.

  • Grid: The images of all users split the screen evenly. The more the users, the smaller the image dimensions. Up to 16 images are supported.

  • Screen sharing: This is designed for video conferencing and online education. The shared screen (or camera image of the anchor) is always displayed as the large main image, which occupies the left half of the screen, and the images of other users occupy the right half in up to two columns of up to eight small images each. Up to 1 large image and 15 small images can be displayed. If the upstream aspect ratio does not match the output, the large image on the left will be scaled and displayed in whole, while the small images on the right will be cropped.

4. Publish audio/video streams to up to 10 CDNs at a time. You can use `PublishCdnParams.PublishCdnUrl` to specify the URLs of the CDNs to publish to. To publish to Tencent Cloud’s CDN, set `PublishCdnParams.IsTencentCdn` to 1.

5. Configure a server-side callback to have Tencent Cloud send relay status updates to your server in the form of HTTP/HTTPS POST requests. To use the callback for relay events, please contact Technical Support.

Notes:

1. **Because On-Cloud MixTranscoding is a paid feature, calling this API will incur MixTranscoding fees. For details, see [Billing of MixTranscoding and Relay to CDN](https://intl.cloud.tencent.com/document/product/647/47631?lang=en&pg=).**

2. **Relaying to third-party CDNs will incur relaying fees. For details, see [Billing of MixTranscoding and Relay to CDN](https://intl.cloud.tencent.com/document/product/647/47631?lang=en&pg=).**

Others:

1. You need to first call `StartPublishCdnStream` to start a relay task and get the task ID before you can use the `UpdatePublishCdnStream` API to modify the task and `StopPublishCdnStream` to stop the task.

2. To ensure the stability of relaying, you cannot switch between relaying audio only, relaying audio and video, and relaying video only for the same task.

3. To ensure the stability of relaying, you cannot change the video codec, audio codec, audio sample rate, audio bitrate, or sound channels using the `UpdatePublishCdnStream` API.

4. When you relay a single stream, specify both `AudioParams` and `VideoParams` to publish both audio and video, and specify only `AudioParams` to publish audio only. You cannot switch between the two modes during the relaying process. For `VideoParams`, set `Width`, `Height`, `Fps`, `Bitrate`, and `Gop` according to the actual settings used for publishing.

5. The `SequenceNumber` parameter is required when you call `UpdatePublishCdnStream` to change the relaying parameters. It ensures that multiple requests for the same relaying task are in the correct order. The value of `SequenceNumber` increases each time a new request is made for the same task. If `InternalError` is returned, try again using the same `SequenceNumber`. You don’t need to handle the `FailedOperation.OutdateRequest` error.

6. You can create a relay task before anchors enter a room, in which case you need to manually call `StopPublishCdnStream` to stop the task. If you don’t, after all the users whose streams are mixed leave the room, the TRTC backend will wait for the timeout period (`AgentParams.MaxIdleTime`) to elapse before stopping the relaying task.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"
AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"
FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency"
INTERNALERROR = "InternalError"
INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"

func (*Client) StopPublishCdnStream 

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

StopPublishCdnStream This API is used to stop a relaying task.

error code that may be returned: 

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

func (*Client) StopPublishCdnStreamWithContext 

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

StopPublishCdnStream This API is used to stop a relaying task.

error code that may be returned: 

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

func (*Client) UpdatePublishCdnStream 

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

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

error code that may be returned: 

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

func (*Client) UpdatePublishCdnStreamWithContext 

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

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

error code that may be returned: 

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

type CloudStorage 

type CloudStorage struct {
	// The cloud storage provider.
	// 0: Tencent Cloud COS. The storage services of other providers are not supported currently.
	Vendor *uint64 `json:"Vendor,omitempty" name:"Vendor"`

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

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

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

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

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

type CloudVod 

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

type CreateCloudRecordingRequest 

type CreateCloudRecordingRequest struct {
	*tchttp.BaseRequest

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

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

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

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

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

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

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

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

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

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

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

func NewCreateCloudRecordingRequest 

func NewCreateCloudRecordingRequest() (request *CreateCloudRecordingRequest)

func (*CreateCloudRecordingRequest) FromJsonString 

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

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

func (*CreateCloudRecordingRequest) ToJsonString 

func (r *CreateCloudRecordingRequest) ToJsonString() string

type CreateCloudRecordingRequestParams 

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

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

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

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

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

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

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

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

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

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

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

Predefined struct for user

type CreateCloudRecordingResponse 

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

func NewCreateCloudRecordingResponse 

func NewCreateCloudRecordingResponse() (response *CreateCloudRecordingResponse)

func (*CreateCloudRecordingResponse) FromJsonString 

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

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

func (*CreateCloudRecordingResponse) ToJsonString 

func (r *CreateCloudRecordingResponse) ToJsonString() string

type CreateCloudRecordingResponseParams 

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

type DeleteCloudRecordingRequest struct {
	*tchttp.BaseRequest

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

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

func NewDeleteCloudRecordingRequest 

func NewDeleteCloudRecordingRequest() (request *DeleteCloudRecordingRequest)

func (*DeleteCloudRecordingRequest) FromJsonString 

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

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

func (*DeleteCloudRecordingRequest) ToJsonString 

func (r *DeleteCloudRecordingRequest) ToJsonString() string

type DeleteCloudRecordingRequestParams 

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

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

Predefined struct for user

type DeleteCloudRecordingResponse 

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

func NewDeleteCloudRecordingResponse 

func NewDeleteCloudRecordingResponse() (response *DeleteCloudRecordingResponse)

func (*DeleteCloudRecordingResponse) FromJsonString 

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

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

func (*DeleteCloudRecordingResponse) ToJsonString 

func (r *DeleteCloudRecordingResponse) ToJsonString() string

type DeleteCloudRecordingResponseParams 

type DeleteCloudRecordingResponseParams struct {
	// The task ID assigned by the recording service, which uniquely identifies a recording process and becomes invalid after a recording task ends.
	TaskId *string `json:"TaskId,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 DescribeCloudRecordingRequest 

type DescribeCloudRecordingRequest struct {
	*tchttp.BaseRequest

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

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

func NewDescribeCloudRecordingRequest 

func NewDescribeCloudRecordingRequest() (request *DescribeCloudRecordingRequest)

func (*DescribeCloudRecordingRequest) FromJsonString 

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

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

func (*DescribeCloudRecordingRequest) ToJsonString 

func (r *DescribeCloudRecordingRequest) ToJsonString() string

type DescribeCloudRecordingRequestParams 

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

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

Predefined struct for user

type DescribeCloudRecordingResponse 

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

func NewDescribeCloudRecordingResponse 

func NewDescribeCloudRecordingResponse() (response *DescribeCloudRecordingResponse)

func (*DescribeCloudRecordingResponse) FromJsonString 

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

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

func (*DescribeCloudRecordingResponse) ToJsonString 

func (r *DescribeCloudRecordingResponse) ToJsonString() string

type DescribeCloudRecordingResponseParams 

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

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

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

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

type DismissRoomByStrRoomIdRequest struct {
	*tchttp.BaseRequest

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

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

func NewDismissRoomByStrRoomIdRequest 

func NewDismissRoomByStrRoomIdRequest() (request *DismissRoomByStrRoomIdRequest)

func (*DismissRoomByStrRoomIdRequest) FromJsonString 

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

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

func (*DismissRoomByStrRoomIdRequest) ToJsonString 

func (r *DismissRoomByStrRoomIdRequest) ToJsonString() string

type DismissRoomByStrRoomIdRequestParams 

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

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

Predefined struct for user

type DismissRoomByStrRoomIdResponse 

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

func NewDismissRoomByStrRoomIdResponse 

func NewDismissRoomByStrRoomIdResponse() (response *DismissRoomByStrRoomIdResponse)

func (*DismissRoomByStrRoomIdResponse) FromJsonString 

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

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

func (*DismissRoomByStrRoomIdResponse) ToJsonString 

func (r *DismissRoomByStrRoomIdResponse) ToJsonString() string

type DismissRoomByStrRoomIdResponseParams 

type DismissRoomByStrRoomIdResponseParams struct {
	// The unique request ID, 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 DismissRoomRequest 

type DismissRoomRequest struct {
	*tchttp.BaseRequest

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

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

func NewDismissRoomRequest 

func NewDismissRoomRequest() (request *DismissRoomRequest)

func (*DismissRoomRequest) FromJsonString 

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

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

func (*DismissRoomRequest) ToJsonString 

func (r *DismissRoomRequest) ToJsonString() string

type DismissRoomRequestParams 

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

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

Predefined struct for user

type DismissRoomResponse 

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

func NewDismissRoomResponse 

func NewDismissRoomResponse() (response *DismissRoomResponse)

func (*DismissRoomResponse) FromJsonString 

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

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

func (*DismissRoomResponse) ToJsonString 

func (r *DismissRoomResponse) ToJsonString() string

type DismissRoomResponseParams 

type DismissRoomResponseParams struct {
	// The unique request ID, 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 MaxVideoUser 

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

type McuAudioParams 

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

	// The users whose audios are mixed. For the `StartPublishCdnStream` API, if you do not pass this parameter or leave it empty, the audios of all anchors will be mixed. For the `UpdatePublishCdnStream` API, if you do not pass this parameter, TRTC will not change the users whose audios are mixed; if you pass in an empty string, the audios of all anchors will be mixed.
	SubscribeAudioList []*McuUserInfoParams `json:"SubscribeAudioList,omitempty" name:"SubscribeAudioList"`
}

type McuLayout 

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

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

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

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

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

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

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

	// The background color of the video. Below are the values for some common colors:
	// Red: 0xcc0033
	// Yellow: 0xcc9900
	// Green: 0xcccc33
	// Blue: 0x99CCFF
	// Black: 0x000000
	// White: 0xFFFFFF
	// Grey: 0x999999
	BackGroundColor *string `json:"BackGroundColor,omitempty" name:"BackGroundColor"`

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

type McuLayoutParams 

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

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

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

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

type McuLayoutVolume 

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

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

type McuPassThrough 

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

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

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

type McuPublishCdnParam 

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

	// Whether to relay to Tencent Cloud’s CDN. 0 (default): No; 1: Yes. An optimized route will be assigned if you relay to Tencent Cloud’s CDN.
	IsTencentCdn *uint64 `json:"IsTencentCdn,omitempty" name:"IsTencentCdn"`
}

type McuSeiParams 

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

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

type McuUserInfoParams 

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

type McuVideoParams 

type McuVideoParams struct {
	// The video encoding parameters.
	VideoEncode *VideoEncode `json:"VideoEncode,omitempty" name:"VideoEncode"`

	// The layout parameters.
	LayoutParams *McuLayoutParams `json:"LayoutParams,omitempty" name:"LayoutParams"`

	// The canvas color. Below are the values for some common colors:
	// Red: 0xcc0033
	// Yellow: 0xcc9900
	// Green: 0xcccc33
	// Blue: 0x99CCFF
	// Black: 0x000000
	// White: 0xFFFFFF
	// Grey: 0x999999
	BackGroundColor *string `json:"BackGroundColor,omitempty" name:"BackGroundColor"`

	// The URL of the background image for the canvas. This parameter has a higher priority than `BackGroundColor`.
	BackgroundImageUrl *string `json:"BackgroundImageUrl,omitempty" name:"BackgroundImageUrl"`

	// The watermark information for the mixed stream.
	WaterMarkList []*McuWaterMarkParams `json:"WaterMarkList,omitempty" name:"WaterMarkList"`
}

type McuWaterMarkImage 

type McuWaterMarkImage struct {
	// The URL of the watermark image, which must be in PNG, JPG, or JPEG format and cannot exceed 5 MB.
	WaterMarkUrl *string `json:"WaterMarkUrl,omitempty" name:"WaterMarkUrl"`

	// The watermark width (pixels).
	WaterMarkWidth *uint64 `json:"WaterMarkWidth,omitempty" name:"WaterMarkWidth"`

	// The watermark height (pixels).
	WaterMarkHeight *uint64 `json:"WaterMarkHeight,omitempty" name:"WaterMarkHeight"`

	// The horizontal offset (pixels) of the watermark.
	LocationX *uint64 `json:"LocationX,omitempty" name:"LocationX"`

	// The vertical offset (pixels) of the watermark.
	LocationY *uint64 `json:"LocationY,omitempty" name:"LocationY"`

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

type McuWaterMarkParams 

type McuWaterMarkParams struct {
	// The watermark type. The default is 0, which indicates an image watermark.
	WaterMarkType *uint64 `json:"WaterMarkType,omitempty" name:"WaterMarkType"`

	// The watermark image information. This parameter is required if `WaterMarkType` is 0.
	WaterMarkImage *McuWaterMarkImage `json:"WaterMarkImage,omitempty" name:"WaterMarkImage"`
}

type MixLayout 

type MixLayout struct {
	// The Y axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas height.
	Top *uint64 `json:"Top,omitempty" name:"Top"`

	// The X axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas width.
	Left *uint64 `json:"Left,omitempty" name:"Left"`

	// The relative width of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Left` cannot exceed the canvas width.
	Width *uint64 `json:"Width,omitempty" name:"Width"`

	// The relative height of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Top` cannot exceed the canvas height.
	Height *uint64 `json:"Height,omitempty" name:"Height"`

	// The user ID (string) of the anchor whose video is shown in the window. If you do not set this parameter, anchors’ videos will be shown in their room entry sequence.
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// The degree of transparency of the canvas. Value range: [0, 255]. 0 means fully opaque, and 255 means fully transparent.
	Alpha *uint64 `json:"Alpha,omitempty" name:"Alpha"`

	// 0: Stretch. In this mode, the image is stretched to fill the space available. The whole image is visible after scaling. However, if the original aspect ratio is different from the target, the image may be distorted.
	//
	// 1: Crop (default). In this mode, if the original aspect ratio is different from the target, the image will be cropped according to the target before being stretched to fill the space available. The image will not be distorted.
	//
	// 2: Blank. This mode stretches the image while keeping its original aspect ratio. If the original aspect ratio is different from the target, there may be blank spaces to the top and bottom or to the left and right of the window.
	//
	// 3: Smart stretch. This mode is similar to the crop mode, except that it restricts cropping to 20% of the image’s width or height at most.
	RenderMode *uint64 `json:"RenderMode,omitempty" name:"RenderMode"`

	// The type of the stream subscribed to.
	// 0: Primary stream (default)
	// 1: Substream
	MediaId *uint64 `json:"MediaId,omitempty" name:"MediaId"`

	// The image layer. 0 is the default value and means the bottommost layer.
	ImageLayer *uint64 `json:"ImageLayer,omitempty" name:"ImageLayer"`

	// The download URL of the background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of `RenderMode`.
	SubBackgroundImage *string `json:"SubBackgroundImage,omitempty" name:"SubBackgroundImage"`
}

type MixLayoutParams 

type MixLayoutParams struct {
	// Layout mode:
	// 1: Floating
	// 2: Screen sharing
	// 3: Grid (default)
	// 4: Custom
	//
	// Floating: By default, the video of the first anchor (you can also specify an anchor) who enters the room is scaled to fill the screen. When other anchors enter the room, their videos appear smaller and are superimposed over the large video from left to right starting from the bottom of the canvas according to their room entry sequence. If the total number of videos is 17 or less, there will be four windows in each row (4 x 4); if it is greater than 17, there will be five windows in each row (5 x 5). Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window.
	//
	// Screen sharing: The video of a specified anchor occupies a larger part of the canvas on the left side (if you do not specify an anchor, the left window will display the canvas background). The videos of other anchors are smaller and are positioned on the right side. If the total number of videos is 17 or less, the small videos are positioned from top to bottom in up to two columns on the right side, with eight videos per column at most. If there are more than 17 videos, the additional videos are positioned at the bottom of the canvas from left to right. Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window.
	//
	// Grid: The videos of anchors are scaled and positioned automatically according to the total number of anchors in a room. Each video has the same size. Up to 25 videos can be displayed.
	//
	// Custom: Specify the layout of videos by using the `MixLayoutList` parameter.
	MixLayoutMode *uint64 `json:"MixLayoutMode,omitempty" name:"MixLayoutMode"`

	// The custom layout details. This parameter is valid if `MixLayoutMode` is set to `4`. Up to 25 videos can be displayed.
	MixLayoutList []*MixLayout `json:"MixLayoutList,omitempty" name:"MixLayoutList"`

	// The background color, which is a hexadecimal value (starting with "#", followed by the color value) converted from an 8-bit RGB value. For example, the RGB value of orange is `R:255 G:165 B:0`, and its hexadecimal value is `#FFA500`. The default color is black.
	BackGroundColor *string `json:"BackGroundColor,omitempty" name:"BackGroundColor"`

	// The user whose video is displayed in the big window. This parameter is valid if `MixLayoutMode` is set to `1` (floating) or `2` (screen sharing). If it is left empty, the first anchor entering the room is displayed in the big window in the floating mode and the canvas background is displayed in the screen sharing mode.
	MaxResolutionUserId *string `json:"MaxResolutionUserId,omitempty" name:"MaxResolutionUserId"`

	// The stream type.
	// 0: Primary stream (default)
	// 1: Substream (screen sharing stream)
	// This parameter specifies the type of the stream displayed in the big window. If it appears in `MixLayoutList`, it indicates the type of the stream of a specified user.
	MediaId *uint64 `json:"MediaId,omitempty" name:"MediaId"`

	// The download URL of the background image for the canvas, which must be in JPG or PNG format and cannot be larger than 5 MB.
	BackgroundImageUrl *string `json:"BackgroundImageUrl,omitempty" name:"BackgroundImageUrl"`

	// `1` means to use placeholders, and `0` (default) means to not use placeholders. If this parameter is set to `1`, when a user is not publishing video, a placeholder image will be displayed in the window reserved for the user.
	PlaceHolderMode *uint64 `json:"PlaceHolderMode,omitempty" name:"PlaceHolderMode"`

	// The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is defined the same as `RenderMode` in `MixLayoufList`.
	BackgroundImageRenderMode *uint64 `json:"BackgroundImageRenderMode,omitempty" name:"BackgroundImageRenderMode"`

	// The download URL of the default background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of `RenderMode`.
	DefaultSubBackgroundImage *string `json:"DefaultSubBackgroundImage,omitempty" name:"DefaultSubBackgroundImage"`

	// The watermark layout. Up to 25 watermarks are supported.
	WaterMarkList []*WaterMark `json:"WaterMarkList,omitempty" name:"WaterMarkList"`
}

type MixTranscodeParams 

type MixTranscodeParams struct {
	// The video transcoding parameters for recording. If you set this parameter, you must specify all its fields. If you do not set it, the default will be used.
	VideoParams *VideoParams `json:"VideoParams,omitempty" name:"VideoParams"`

	// The audio transcoding parameters for recording. If you set this parameter, you must specify all its fields. If you do not set it, the default will be used.
	AudioParams *AudioParams `json:"AudioParams,omitempty" name:"AudioParams"`
}

type MixUserInfo 

type MixUserInfo struct {
	// User ID.
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// If a dynamic layout is used, the value of this parameter should be the ID of the main room. If a custom layout is used, the value of this parameter should be the same as the room ID in `MixLayoutList`.
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// The type of the `RoomId` parameter. 0: integer; 1: string.
	RoomIdType *uint64 `json:"RoomIdType,omitempty" name:"RoomIdType"`
}

type ModifyCloudRecordingRequest 

type ModifyCloudRecordingRequest struct {
	*tchttp.BaseRequest

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

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

	// The new stream mixing layout to use.
	MixLayoutParams *MixLayoutParams `json:"MixLayoutParams,omitempty" name:"MixLayoutParams"`

	// The allowlist/blocklist for stream subscription.
	SubscribeStreamUserIds *SubscribeStreamUserIds `json:"SubscribeStreamUserIds,omitempty" name:"SubscribeStreamUserIds"`
}

func NewModifyCloudRecordingRequest 

func NewModifyCloudRecordingRequest() (request *ModifyCloudRecordingRequest)

func (*ModifyCloudRecordingRequest) FromJsonString 

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

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

func (*ModifyCloudRecordingRequest) ToJsonString 

func (r *ModifyCloudRecordingRequest) ToJsonString() string

type ModifyCloudRecordingRequestParams 

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

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

	// The new stream mixing layout to use.
	MixLayoutParams *MixLayoutParams `json:"MixLayoutParams,omitempty" name:"MixLayoutParams"`

	// The allowlist/blocklist for stream subscription.
	SubscribeStreamUserIds *SubscribeStreamUserIds `json:"SubscribeStreamUserIds,omitempty" name:"SubscribeStreamUserIds"`
}

Predefined struct for user

type ModifyCloudRecordingResponse 

type ModifyCloudRecordingResponse struct {
	*tchttp.BaseResponse
	Response *ModifyCloudRecordingResponseParams `json:"Response"`
}

func NewModifyCloudRecordingResponse 

func NewModifyCloudRecordingResponse() (response *ModifyCloudRecordingResponse)

func (*ModifyCloudRecordingResponse) FromJsonString 

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

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

func (*ModifyCloudRecordingResponse) ToJsonString 

func (r *ModifyCloudRecordingResponse) ToJsonString() string

type ModifyCloudRecordingResponseParams 

type ModifyCloudRecordingResponseParams struct {
	// The task ID assigned by the recording service, which uniquely identifies a recording process and becomes invalid after a recording task ends.
	TaskId *string `json:"TaskId,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 RecordParams 

type RecordParams struct {
	// The recording mode.
	// 1: Single-stream recording. Records the audio and video of each subscribed user (`UserId`) in a room and saves the recording files to the cloud.
	// 2: Mixed-stream recording. Mixes the audios and videos of subscribed users (`UserId`) in a room, records the mixed stream, and saves the recording files to the cloud.
	RecordMode *uint64 `json:"RecordMode,omitempty" name:"RecordMode"`

	// The time period (seconds) to wait after there are no anchors in a room to stop recording automatically. The value cannot be smaller than 5 or larger than 86400 (24 hours). Default value: 30.
	MaxIdleTime *uint64 `json:"MaxIdleTime,omitempty" name:"MaxIdleTime"`

	// The media type of the streams to record.
	// 0: Audio and video streams (default)
	// 1: Audio streams only
	// 2: Video streams only
	StreamType *uint64 `json:"StreamType,omitempty" name:"StreamType"`

	// The allowlist/blocklist for stream subscription.
	SubscribeStreamUserIds *SubscribeStreamUserIds `json:"SubscribeStreamUserIds,omitempty" name:"SubscribeStreamUserIds"`

	// The format of recording files. 0 (default): HLS; 1: HLS + MP4 (recorded in HLS and converted to MP4). This parameter is invalid if recording files are saved to VOD.
	OutputFormat *uint64 `json:"OutputFormat,omitempty" name:"OutputFormat"`
}

type RemoveUserByStrRoomIdRequest 

type RemoveUserByStrRoomIdRequest struct {
	*tchttp.BaseRequest

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

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

	// List of up to 10 users to be removed
	UserIds []*string `json:"UserIds,omitempty" name:"UserIds"`
}

func NewRemoveUserByStrRoomIdRequest 

func NewRemoveUserByStrRoomIdRequest() (request *RemoveUserByStrRoomIdRequest)

func (*RemoveUserByStrRoomIdRequest) FromJsonString 

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

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

func (*RemoveUserByStrRoomIdRequest) ToJsonString 

func (r *RemoveUserByStrRoomIdRequest) ToJsonString() string

type RemoveUserByStrRoomIdRequestParams 

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

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

	// List of up to 10 users to be removed
	UserIds []*string `json:"UserIds,omitempty" name:"UserIds"`
}

Predefined struct for user

type RemoveUserByStrRoomIdResponse 

type RemoveUserByStrRoomIdResponse struct {
	*tchttp.BaseResponse
	Response *RemoveUserByStrRoomIdResponseParams `json:"Response"`
}

func NewRemoveUserByStrRoomIdResponse 

func NewRemoveUserByStrRoomIdResponse() (response *RemoveUserByStrRoomIdResponse)

func (*RemoveUserByStrRoomIdResponse) FromJsonString 

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

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

func (*RemoveUserByStrRoomIdResponse) ToJsonString 

func (r *RemoveUserByStrRoomIdResponse) ToJsonString() string

type RemoveUserByStrRoomIdResponseParams 

type RemoveUserByStrRoomIdResponseParams struct {
	// The unique request ID, 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 RemoveUserRequest 

type RemoveUserRequest struct {
	*tchttp.BaseRequest

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

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

	// List of up to 10 users to be removed.
	UserIds []*string `json:"UserIds,omitempty" name:"UserIds"`
}

func NewRemoveUserRequest 

func NewRemoveUserRequest() (request *RemoveUserRequest)

func (*RemoveUserRequest) FromJsonString 

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

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

func (*RemoveUserRequest) ToJsonString 

func (r *RemoveUserRequest) ToJsonString() string

type RemoveUserRequestParams 

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

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

	// List of up to 10 users to be removed.
	UserIds []*string `json:"UserIds,omitempty" name:"UserIds"`
}

Predefined struct for user

type RemoveUserResponse 

type RemoveUserResponse struct {
	*tchttp.BaseResponse
	Response *RemoveUserResponseParams `json:"Response"`
}

func NewRemoveUserResponse 

func NewRemoveUserResponse() (response *RemoveUserResponse)

func (*RemoveUserResponse) FromJsonString 

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

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

func (*RemoveUserResponse) ToJsonString 

func (r *RemoveUserResponse) ToJsonString() string

type RemoveUserResponseParams 

type RemoveUserResponseParams struct {
	// The unique request ID, 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 SingleSubscribeParams 

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

type StartPublishCdnStreamRequest 

type StartPublishCdnStreamRequest struct {
	*tchttp.BaseRequest

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

	// The ID of the room whose streams are relayed (the main room).
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// The type of the `RoomId` parameter, which must be the same as the ID type of the room whose streams are relayed. 0: integer; 1: string.
	RoomIdType *uint64 `json:"RoomIdType,omitempty" name:"RoomIdType"`

	// The information of the relaying robot in the room.
	AgentParams *AgentParams `json:"AgentParams,omitempty" name:"AgentParams"`

	// Whether to transcode the streams. 0: No; 1: Yes.
	WithTranscoding *uint64 `json:"WithTranscoding,omitempty" name:"WithTranscoding"`

	// The audio encoding parameters for relaying.
	AudioParams *McuAudioParams `json:"AudioParams,omitempty" name:"AudioParams"`

	// The video encoding parameters for relaying. If you do not pass this parameter, only audio will be relayed.
	VideoParams *McuVideoParams `json:"VideoParams,omitempty" name:"VideoParams"`

	// The information of a single stream relayed. When you relay a single stream, set `WithTranscoding` to 0.
	SingleSubscribeParams *SingleSubscribeParams `json:"SingleSubscribeParams,omitempty" name:"SingleSubscribeParams"`

	// The CDN information.
	PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitempty" name:"PublishCdnParams"`

	// The stream mixing SEI parameters.
	SeiParams *McuSeiParams `json:"SeiParams,omitempty" name:"SeiParams"`
}

func NewStartPublishCdnStreamRequest 

func NewStartPublishCdnStreamRequest() (request *StartPublishCdnStreamRequest)

func (*StartPublishCdnStreamRequest) FromJsonString 

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

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

func (*StartPublishCdnStreamRequest) ToJsonString 

func (r *StartPublishCdnStreamRequest) ToJsonString() string

type StartPublishCdnStreamRequestParams 

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

	// The ID of the room whose streams are relayed (the main room).
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// The type of the `RoomId` parameter, which must be the same as the ID type of the room whose streams are relayed. 0: integer; 1: string.
	RoomIdType *uint64 `json:"RoomIdType,omitempty" name:"RoomIdType"`

	// The information of the relaying robot in the room.
	AgentParams *AgentParams `json:"AgentParams,omitempty" name:"AgentParams"`

	// Whether to transcode the streams. 0: No; 1: Yes.
	WithTranscoding *uint64 `json:"WithTranscoding,omitempty" name:"WithTranscoding"`

	// The audio encoding parameters for relaying.
	AudioParams *McuAudioParams `json:"AudioParams,omitempty" name:"AudioParams"`

	// The video encoding parameters for relaying. If you do not pass this parameter, only audio will be relayed.
	VideoParams *McuVideoParams `json:"VideoParams,omitempty" name:"VideoParams"`

	// The information of a single stream relayed. When you relay a single stream, set `WithTranscoding` to 0.
	SingleSubscribeParams *SingleSubscribeParams `json:"SingleSubscribeParams,omitempty" name:"SingleSubscribeParams"`

	// The CDN information.
	PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitempty" name:"PublishCdnParams"`

	// The stream mixing SEI parameters.
	SeiParams *McuSeiParams `json:"SeiParams,omitempty" name:"SeiParams"`
}

Predefined struct for user

type StartPublishCdnStreamResponse 

type StartPublishCdnStreamResponse struct {
	*tchttp.BaseResponse
	Response *StartPublishCdnStreamResponseParams `json:"Response"`
}

func NewStartPublishCdnStreamResponse 

func NewStartPublishCdnStreamResponse() (response *StartPublishCdnStreamResponse)

func (*StartPublishCdnStreamResponse) FromJsonString 

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

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

func (*StartPublishCdnStreamResponse) ToJsonString 

func (r *StartPublishCdnStreamResponse) ToJsonString() string

type StartPublishCdnStreamResponseParams 

type StartPublishCdnStreamResponseParams struct {
	// The task ID, which is generated by the Tencent Cloud server. You need to pass in the task ID when making a request to update or stop a relaying task.
	TaskId *string `json:"TaskId,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 StopPublishCdnStreamRequest 

type StopPublishCdnStreamRequest struct {
	*tchttp.BaseRequest

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

	// The task ID.
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`
}

func NewStopPublishCdnStreamRequest 

func NewStopPublishCdnStreamRequest() (request *StopPublishCdnStreamRequest)

func (*StopPublishCdnStreamRequest) FromJsonString 

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

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

func (*StopPublishCdnStreamRequest) ToJsonString 

func (r *StopPublishCdnStreamRequest) ToJsonString() string

type StopPublishCdnStreamRequestParams 

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

	// The task ID.
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`
}

Predefined struct for user

type StopPublishCdnStreamResponse 

type StopPublishCdnStreamResponse struct {
	*tchttp.BaseResponse
	Response *StopPublishCdnStreamResponseParams `json:"Response"`
}

func NewStopPublishCdnStreamResponse 

func NewStopPublishCdnStreamResponse() (response *StopPublishCdnStreamResponse)

func (*StopPublishCdnStreamResponse) FromJsonString 

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

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

func (*StopPublishCdnStreamResponse) ToJsonString 

func (r *StopPublishCdnStreamResponse) ToJsonString() string

type StopPublishCdnStreamResponseParams 

type StopPublishCdnStreamResponseParams struct {
	// The task ID.
	TaskId *string `json:"TaskId,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 StorageFile 

type StorageFile struct {
	// The user whose stream is recorded into the file. In the mixed-stream recording mode, this parameter will be empty.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	UserId *string `json:"UserId,omitempty" name:"UserId"`

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

	// The type of the media recorded.
	// video
	// audio
	// audio_video
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	TrackType *string `json:"TrackType,omitempty" name:"TrackType"`

	// The start time (Unix timestamp) of the recording file.
	BeginTimeStamp *uint64 `json:"BeginTimeStamp,omitempty" name:"BeginTimeStamp"`
}

type StorageParams 

type StorageParams struct {
	// The cloud storage information.
	CloudStorage *CloudStorage `json:"CloudStorage,omitempty" name:"CloudStorage"`

	// The VOD information.
	CloudVod *CloudVod `json:"CloudVod,omitempty" name:"CloudVod"`
}

type SubscribeStreamUserIds 

type SubscribeStreamUserIds struct {
	// The allowlist for audio subscription. For example, `["1", "2", "3"]` means to only subscribe to the audios of users 1, 2, and 3, and ["1.*$"] means to only subscribe to the audios of users whose ID prefix is `1`. If this parameter is left empty, the audios of all anchors in the room will be received. The array can contain at most 32 elements.
	SubscribeAudioUserIds []*string `json:"SubscribeAudioUserIds,omitempty" name:"SubscribeAudioUserIds"`

	// The blocklist for audio subscription. For example, `["1", "2", "3"]` means to not subscribe to the audios of users 1, 2, and 3, and `["1.*$"]` means to not subscribe to users whose ID prefix is `1`. If this parameter is left empty, the audios of all anchors in the room will be received. The array can contain at most 32 elements.
	UnSubscribeAudioUserIds []*string `json:"UnSubscribeAudioUserIds,omitempty" name:"UnSubscribeAudioUserIds"`

	// The allowlist for video subscription. For example, `["1", "2", "3"]` means to only subscribe to the videos of users 1, 2, and 3, and `["1.*$"]` means to only subscribe to the videos of users whose ID prefix is `1`. If this parameter is left empty, the videos of all anchors in the room will be received. The array can contain at most 32 elements.
	SubscribeVideoUserIds []*string `json:"SubscribeVideoUserIds,omitempty" name:"SubscribeVideoUserIds"`

	// The blocklist for video subscription. For example, `["1", "2", "3"]` means to not subscribe to the videos of users 1, 2, and 3, and `["1.*$"]` means to not subscribe to the videos of users whose ID prefix is `1`. If this parameter is left empty, the videos of all anchors in the room will be received. The array can contain at most 32 elements.
	UnSubscribeVideoUserIds []*string `json:"UnSubscribeVideoUserIds,omitempty" name:"UnSubscribeVideoUserIds"`
}

type TencentVod 

type TencentVod struct {
	// The operation to perform on the media uploaded. The value of this parameter is the name of a task flow template. You can create a custom task flow template in Tencent Cloud VOD.
	Procedure *string `json:"Procedure,omitempty" name:"Procedure"`

	// The expiration time of the media file, which is a time period (seconds) from the current time. For example, `86400` means to save the media file for one day. To save the file permanently, set this parameter to `0`.
	ExpireTime *uint64 `json:"ExpireTime,omitempty" name:"ExpireTime"`

	// The storage region. Set this parameter if you have special requirements on the storage region.
	StorageRegion *string `json:"StorageRegion,omitempty" name:"StorageRegion"`

	// The category ID, which is returned after you create a category by calling an API. You can use categories to manage media files.
	// The default value is `0`, which means others.
	ClassId *uint64 `json:"ClassId,omitempty" name:"ClassId"`

	// The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.
	SubAppId *uint64 `json:"SubAppId,omitempty" name:"SubAppId"`

	// The task flow context, which is passed through after the task is completed.
	SessionContext *string `json:"SessionContext,omitempty" name:"SessionContext"`

	// The upload context, which is passed through after upload is completed.
	SourceContext *string `json:"SourceContext,omitempty" name:"SourceContext"`
}

type UpdatePublishCdnStreamRequest 

type UpdatePublishCdnStreamRequest struct {
	*tchttp.BaseRequest

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

	// The task ID.
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// The sequence of a request. This parameter ensures the requests to change the parameters of the same relaying task are in the correct order. It increases each time a new request is made.
	SequenceNumber *uint64 `json:"SequenceNumber,omitempty" name:"SequenceNumber"`

	// Whether to transcode the streams. 0: No; 1: Yes.
	WithTranscoding *uint64 `json:"WithTranscoding,omitempty" name:"WithTranscoding"`

	// Pass this parameter to change the users whose audios are mixed. If you do not pass this parameter, no changes will be made.
	AudioParams *McuAudioParams `json:"AudioParams,omitempty" name:"AudioParams"`

	// Pass this parameter to change video parameters other than the codec, including the video layout, background image, background color, and watermark information. This parameter is valid only if streams are transcoded. If you do not pass it, no changes will be made.
	VideoParams *McuVideoParams `json:"VideoParams,omitempty" name:"VideoParams"`

	// Pass this parameter to change the single stream that is relayed. This parameter is valid only if streams are not transcoded. If you do not pass this parameter, no changes will be made.
	SingleSubscribeParams *SingleSubscribeParams `json:"SingleSubscribeParams,omitempty" name:"SingleSubscribeParams"`

	// Pass this parameter to change the CDNs to relay to. If you do not pass this parameter, no changes will be made.
	PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitempty" name:"PublishCdnParams"`

	// The stream mixing SEI parameters.
	SeiParams *McuSeiParams `json:"SeiParams,omitempty" name:"SeiParams"`
}

func NewUpdatePublishCdnStreamRequest 

func NewUpdatePublishCdnStreamRequest() (request *UpdatePublishCdnStreamRequest)

func (*UpdatePublishCdnStreamRequest) FromJsonString 

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

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

func (*UpdatePublishCdnStreamRequest) ToJsonString 

func (r *UpdatePublishCdnStreamRequest) ToJsonString() string

type UpdatePublishCdnStreamRequestParams 

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

	// The task ID.
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// The sequence of a request. This parameter ensures the requests to change the parameters of the same relaying task are in the correct order. It increases each time a new request is made.
	SequenceNumber *uint64 `json:"SequenceNumber,omitempty" name:"SequenceNumber"`

	// Whether to transcode the streams. 0: No; 1: Yes.
	WithTranscoding *uint64 `json:"WithTranscoding,omitempty" name:"WithTranscoding"`

	// Pass this parameter to change the users whose audios are mixed. If you do not pass this parameter, no changes will be made.
	AudioParams *McuAudioParams `json:"AudioParams,omitempty" name:"AudioParams"`

	// Pass this parameter to change video parameters other than the codec, including the video layout, background image, background color, and watermark information. This parameter is valid only if streams are transcoded. If you do not pass it, no changes will be made.
	VideoParams *McuVideoParams `json:"VideoParams,omitempty" name:"VideoParams"`

	// Pass this parameter to change the single stream that is relayed. This parameter is valid only if streams are not transcoded. If you do not pass this parameter, no changes will be made.
	SingleSubscribeParams *SingleSubscribeParams `json:"SingleSubscribeParams,omitempty" name:"SingleSubscribeParams"`

	// Pass this parameter to change the CDNs to relay to. If you do not pass this parameter, no changes will be made.
	PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitempty" name:"PublishCdnParams"`

	// The stream mixing SEI parameters.
	SeiParams *McuSeiParams `json:"SeiParams,omitempty" name:"SeiParams"`
}

Predefined struct for user

type UpdatePublishCdnStreamResponse 

type UpdatePublishCdnStreamResponse struct {
	*tchttp.BaseResponse
	Response *UpdatePublishCdnStreamResponseParams `json:"Response"`
}

func NewUpdatePublishCdnStreamResponse 

func NewUpdatePublishCdnStreamResponse() (response *UpdatePublishCdnStreamResponse)

func (*UpdatePublishCdnStreamResponse) FromJsonString 

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

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

func (*UpdatePublishCdnStreamResponse) ToJsonString 

func (r *UpdatePublishCdnStreamResponse) ToJsonString() string

type UpdatePublishCdnStreamResponseParams 

type UpdatePublishCdnStreamResponseParams struct {
	// The task ID.
	TaskId *string `json:"TaskId,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 UserMediaStream 

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

	// The stream type. 0: Camera; 1: Screen sharing. If you do not pass this parameter, 0 will be used.
	StreamType *uint64 `json:"StreamType,omitempty" name:"StreamType"`
}

type VideoEncode 

type VideoEncode struct {
	// The width of the output stream (pixels). This parameter is required if audio and video are relayed. Value range: [0, 1920].
	Width *uint64 `json:"Width,omitempty" name:"Width"`

	// The height of the output stream (pixels). This parameter is required if audio and video are relayed. Value range: [0, 1080].
	Height *uint64 `json:"Height,omitempty" name:"Height"`

	// The frame rate (fps) of the output stream. This parameter is required if audio and video are relayed. Value range: [0, 60].
	Fps *uint64 `json:"Fps,omitempty" name:"Fps"`

	// The bitrate (Kbps) of the output stream. This parameter is required if audio and video are relayed. Value range: [0, 10000].
	BitRate *uint64 `json:"BitRate,omitempty" name:"BitRate"`

	// The GOP (seconds) of the output stream. This parameter is required if audio and video are relayed. Value range: [1, 5].
	Gop *uint64 `json:"Gop,omitempty" name:"Gop"`
}

type VideoParams 

type VideoParams struct {
	// The video width in pixels. The value of this parameter cannot be larger than 1920, and the result of multiplying `Width` and `Height` cannot exceed 1920 x 1080. The default value is `360`.
	Width *uint64 `json:"Width,omitempty" name:"Width"`

	// The video height in pixels. The value of this parameter cannot be larger than 1920, and the result of multiplying `Width` and `Height` cannot exceed 1920 x 1080. The default value is `640`.
	Height *uint64 `json:"Height,omitempty" name:"Height"`

	// The video frame rate. Value range: [1, 60]. Default: 15.
	Fps *uint64 `json:"Fps,omitempty" name:"Fps"`

	// The video bitrate (bps). Value range: [64000, 8192000]. Default: 550000.
	BitRate *uint64 `json:"BitRate,omitempty" name:"BitRate"`

	// The keyframe interval (seconds). Default value: 10.
	Gop *uint64 `json:"Gop,omitempty" name:"Gop"`
}

type WaterMark 

type WaterMark struct {
	// The watermark type. 0 (default): image; 1: text (not supported yet).
	WaterMarkType *uint64 `json:"WaterMarkType,omitempty" name:"WaterMarkType"`

	// The information of watermark images. This parameter is required if the watermark type is image.
	WaterMarkImage *WaterMarkImage `json:"WaterMarkImage,omitempty" name:"WaterMarkImage"`
}

type WaterMarkImage 

type WaterMarkImage struct {
	// The download URLs of the watermark images, which must be in JPG or PNG format and cannot be larger than 5 MB.
	WaterMarkUrl *string `json:"WaterMarkUrl,omitempty" name:"WaterMarkUrl"`

	// The Y axis of the image's top-left corner. Value range: [0, 2560]. The value cannot be larger than the canvas height.
	Top *uint64 `json:"Top,omitempty" name:"Top"`

	// The X axis of the image’s top-left corner. Value range: [0, 2560]. The value cannot be larger than the canvas width.
	Left *uint64 `json:"Left,omitempty" name:"Left"`

	// The relative width of the image. Value range: [0, 2560]. The sum of the values of this parameter and `Left` cannot exceed the canvas width.
	Width *uint64 `json:"Width,omitempty" name:"Width"`

	// The relative height of the image. Value range: [0, 2560]. The sum of the values of this parameter and `Top` cannot exceed the canvas height.
	Height *uint64 `json:"Height,omitempty" name:"Height"`
}

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.