v20190722

package
v1.0.418 Latest Latest
Warning

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

Go to latest
Published: Jun 12, 2022 License: Apache-2.0 Imports: 7 Imported by: 1

Documentation

Index

Constants

View Source
const (

	// CAM签名/鉴权错误。
	AUTHFAILURE = "AuthFailure"

	// 未完成实名认证,不允许此操作。
	AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"

	// CAM鉴权失败。
	AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation"

	// 不支持该操作。
	AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation"

	// 操作失败。
	FAILEDOPERATION = "FailedOperation"

	// 云端录制方法不支持。
	FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod"

	// 房间中没有设置混流模板。
	FAILEDOPERATION_MIXSESSIONNOTEXIST = "FailedOperation.MixSessionNotExist"

	// 云API混流模板和SDK混流冲突。
	FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection"

	// 单用户并发过载,请联系我们增大并发路数到合理值。
	FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency"

	// 房间不存在。
	FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"

	// 应用ID不存在。
	FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist"

	// 内部错误。
	INTERNALERROR = "InternalError"

	// 访问后端服务失败。
	INTERNALERROR_BACKENDFAIL = "InternalError.BackendFail"

	// 访问后端服务超时。
	INTERNALERROR_BACKENDTIMEOUT = "InternalError.BackendTimeOut"

	// 云端录制内部服务错误。
	INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError"

	// 数据库查询异常。
	INTERNALERROR_DBERROR = "InternalError.DBError"

	// ES查询异常。
	INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError"

	// 查询房间失败。
	INTERNALERROR_GETROOMCACHEIPERROR = "InternalError.GetRoomCacheIpError"

	// 获取房间信息失败。
	INTERNALERROR_GETROOMFROMCACHEERROR = "InternalError.GetRoomFromCacheError"

	// http请求解析失败。
	INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied"

	// 接口错误。
	INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr"

	// 内部错误,请重试。
	INTERNALERROR_INTERNALERROR = "InternalError.InternalError"

	// 不支持的方法。
	INTERNALERROR_METHODERR = "InternalError.MethodErr"

	// 参数错误。
	INVALIDPARAMETER = "InvalidParameter"

	// AppId校验失败。
	INVALIDPARAMETER_APPID = "InvalidParameter.AppId"

	// 音频编码参数错误。
	INVALIDPARAMETER_AUDIOENCODEPARAMS = "InvalidParameter.AudioEncodeParams"

	// body 解析参数失败。
	INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"

	// 图片过大。
	INVALIDPARAMETER_CHECKCONTENTFAILED = "InvalidParameter.CheckContentFailed"

	// 后缀名校验失败。
	INVALIDPARAMETER_CHECKSUFFIXFAILED = "InvalidParameter.CheckSuffixFailed"

	// EncodeParams参数错误。
	INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams"

	// EndTs参数错误。
	INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs"

	// 大画面居右显示参数错误。
	INVALIDPARAMETER_MAINVIDEORIGHTALIGN = "InvalidParameter.MainVideoRightAlign"

	// 大画面流类型错误。
	INVALIDPARAMETER_MAINVIDEOSTREAMTYPE = "InvalidParameter.MainVideoStreamType"

	// 参数超出范围。
	INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange"

	// OutputParams参数错误。
	INVALIDPARAMETER_OUTPUTPARAMS = "InvalidParameter.OutputParams"

	// PageNumber 参数错误。
	INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber"

	// PageSize参数错误。
	INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize"

	// PageSize超过100。
	INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize"

	// 待操作的图片未找到。
	INVALIDPARAMETER_PICTURENOTFOUND = "InvalidParameter.PictureNotFound"

	// 自定义布局参数错误。
	INVALIDPARAMETER_PRESETLAYOUTCONFIG = "InvalidParameter.PresetLayoutConfig"

	// PublishCdnUrls参数校验失败。
	INVALIDPARAMETER_PUBLISHCDNURLS = "InvalidParameter.PublishCdnUrls"

	// 纯音频推流参数错误。
	INVALIDPARAMETER_PUREAUDIOSTREAM = "InvalidParameter.PureAudioStream"

	// 查询范围超过文档限制。
	INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize"

	// 纯音频录制参数错误。
	INVALIDPARAMETER_RECORDAUDIOONLY = "InvalidParameter.RecordAudioOnly"

	// RecordId参数错误。
	INVALIDPARAMETER_RECORDID = "InvalidParameter.RecordId"

	// RoomId参数错误。
	INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"

	// SdkAppId参数错误。
	INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

	// 小画面布局参数错误。
	INVALIDPARAMETER_SMALLVIDEOLAYOUTPARAMS = "InvalidParameter.SmallVideoLayoutParams"

	// 小画面布局中流类型参数错误。
	INVALIDPARAMETER_SMALLVIDEOSTREAMTYPE = "InvalidParameter.SmallVideoStreamType"

	// 查询开始时间超过文档限制。
	INVALIDPARAMETER_STARTTIMEEXPIRE = "InvalidParameter.StartTimeExpire"

	// StartTs参数错误。
	INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs"

	// 查询开始时间超过文档限制。
	INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize"

	// StreamId参数错误。
	INVALIDPARAMETER_STREAMID = "InvalidParameter.StreamId"

	// Url解析参数失败。
	INVALIDPARAMETER_URLPARAMSERROR = "InvalidParameter.UrlParamsError"

	// UserId参数错误。
	INVALIDPARAMETER_USERID = "InvalidParameter.UserId"

	// UserIds参数错误。
	INVALIDPARAMETER_USERIDS = "InvalidParameter.UserIds"

	// 用户数超过6个。
	INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix"

	// 视频分辨率参数错误。
	INVALIDPARAMETER_VIDEORESOLUTION = "InvalidParameter.VideoResolution"

	// RoomId值错误。
	INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"

	// 缺少参数错误。
	MISSINGPARAMETER = "MissingParameter"

	// 缺少AccessKey参数。
	MISSINGPARAMETER_ACCESSKEY = "MissingParameter.AccessKey"

	// 缺少AppId参数。
	MISSINGPARAMETER_APPID = "MissingParameter.AppId"

	// EncodeParams中缺少音频输出参数。
	MISSINGPARAMETER_AUDIOENCODEPARAMS = "MissingParameter.AudioEncodeParams"

	// 转推参数中缺少BizId。
	MISSINGPARAMETER_BIZID = "MissingParameter.BizId"

	// 缺少Bucket参数。
	MISSINGPARAMETER_BUCKET = "MissingParameter.Bucket"

	// 缺少CloudStorage参数。
	MISSINGPARAMETER_CLOUDSTORAGE = "MissingParameter.CloudStorage"

	// 缺少CommId参数。
	MISSINGPARAMETER_COMMID = "MissingParameter.CommId"

	// 缺少SdkAppId参数或CommID参数。
	MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId"

	// 缺少EncodeParams参数。
	MISSINGPARAMETER_ENCODEPARAMS = "MissingParameter.EncodeParams"

	// 缺少endTS_s参数。
	MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs"

	// 缺少OutputParams参数。
	MISSINGPARAMETER_OUTPUTPARAMS = "MissingParameter.OutputParams"

	// 缺少自定义布局参数。
	MISSINGPARAMETER_PRESETLAYOUTCONFIG = "MissingParameter.PresetLayoutConfig"

	// 缺少转推参数。
	MISSINGPARAMETER_PUBLISHCDNPARAMS = "MissingParameter.PublishCdnParams"

	// 转推参数中缺少转推目的地址。
	MISSINGPARAMETER_PUBLISHCDNURLS = "MissingParameter.PublishCdnUrls"

	// 缺少RecordMode参数。
	MISSINGPARAMETER_RECORDMODE = "MissingParameter.RecordMode"

	// 缺少RecordParams参数。
	MISSINGPARAMETER_RECORDPARAMS = "MissingParameter.RecordParams"

	// 缺少Region参数。
	MISSINGPARAMETER_REGION = "MissingParameter.Region"

	// 缺少RoomId参数。
	MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"

	// 缺少RoomNum参数。
	MISSINGPARAMETER_ROOMNUM = "MissingParameter.RoomNum"

	// 缺少SdkAppId参数。
	MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"

	// 缺少SecretKey参数。
	MISSINGPARAMETER_SECRETKEY = "MissingParameter.SecretKey"

	// 缺少startTS_s参数。
	MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"

	// 缺少StorageParams参数。
	MISSINGPARAMETER_STORAGEPARAMS = "MissingParameter.StorageParams"

	// OutputParams中缺少StreamId参数。
	MISSINGPARAMETER_STREAMID = "MissingParameter.StreamId"

	// 缺少StreamType参数。
	MISSINGPARAMETER_STREAMTYPE = "MissingParameter.StreamType"

	// 缺少TaskId参数。
	MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"

	// 缺少UserId参数。
	MISSINGPARAMETER_USERID = "MissingParameter.UserId"

	// 缺少UserIds参数。
	MISSINGPARAMETER_USERIDS = "MissingParameter.UserIds"

	// 缺少UserSig参数。
	MISSINGPARAMETER_USERSIG = "MissingParameter.UserSig"

	// 缺少Vendor参数。
	MISSINGPARAMETER_VENDOR = "MissingParameter.Vendor"

	// EncodeParams中缺少视频输出参数。
	MISSINGPARAMETER_VIDEOENCODEPARAMS = "MissingParameter.VideoEncodeParams"

	// 资源不存在。
	RESOURCENOTFOUND = "ResourceNotFound"

	// 没有操作SdkAppId的权限。
	UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

	// 未知参数错误。
	UNKNOWNPARAMETER = "UnknownParameter"
)
View Source
const APIVersion = "2019-07-22"

Variables

This section is empty.

Functions

This section is empty.

Types

type AbnormalEvent

type AbnormalEvent struct {

	// 异常事件ID,具体值查看附录:异常体验ID映射表:https://cloud.tencent.com/document/product/647/44916
	AbnormalEventId *uint64 `json:"AbnormalEventId,omitempty" name:"AbnormalEventId"`

	// 远端用户ID,"":表示异常事件不是由远端用户产生
	// 注意:此字段可能返回 null,表示取不到有效值。
	PeerId *string `json:"PeerId,omitempty" name:"PeerId"`
}

type AbnormalExperience

type AbnormalExperience struct {

	// 用户ID
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// 异常体验ID
	ExperienceId *uint64 `json:"ExperienceId,omitempty" name:"ExperienceId"`

	// 字符串房间号
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// 异常事件数组
	AbnormalEventList []*AbnormalEvent `json:"AbnormalEventList,omitempty" name:"AbnormalEventList"`

	// 异常事件的上报时间
	EventTime *uint64 `json:"EventTime,omitempty" name:"EventTime"`
}

type AudioParams added in v1.0.400

type AudioParams struct {

	// 音频采样率:
	// 1:48000Hz(默认);
	// 2:44100Hz
	// 3:16000Hz。
	SampleRate *uint64 `json:"SampleRate,omitempty" name:"SampleRate"`

	// 声道数:
	// 1:单声道;
	// 2:双声道(默认)。
	Channel *uint64 `json:"Channel,omitempty" name:"Channel"`

	// 音频码率: 取值范围[32000, 128000] ,单位bps,默认64000bps。
	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 added in v1.0.400

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

CreateCloudRecording ###接口说明:

启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制有或者多路视频画面混流一路。

###您可以通过此接口实现如下目标:

* 指定订阅流参数(RecordParams)来指定需要录制的主播的黑名单或者白名单。

* 指定第三方存储的参数(StorageParams)来指定上传到您希望的云存储

* 指定混流模式下的音视频转码详细参数(MixTranscodeParams),包括视频分辨率、视频码率、视频帧率、以及声音质量等

* 指定混流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。

###关键名词:

* 单流录制:分别录制房间的订阅UserId的音频和视频。录制服务会实时将录制文件(M3U8/TS)上传至云存储。

* 混流录制:将房间内订阅UserId的音视频混录成一个音视频文件,并将录制文件(M3U8/TS)上传至云存储。

可能返回的错误码:

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 added in v1.0.400

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

CreateCloudRecording ###接口说明:

启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制有或者多路视频画面混流一路。

###您可以通过此接口实现如下目标:

* 指定订阅流参数(RecordParams)来指定需要录制的主播的黑名单或者白名单。

* 指定第三方存储的参数(StorageParams)来指定上传到您希望的云存储

* 指定混流模式下的音视频转码详细参数(MixTranscodeParams),包括视频分辨率、视频码率、视频帧率、以及声音质量等

* 指定混流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。

###关键名词:

* 单流录制:分别录制房间的订阅UserId的音频和视频。录制服务会实时将录制文件(M3U8/TS)上传至云存储。

* 混流录制:将房间内订阅UserId的音视频混录成一个音视频文件,并将录制文件(M3U8/TS)上传至云存储。

可能返回的错误码:

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

func (c *Client) CreatePicture(request *CreatePictureRequest) (response *CreatePictureResponse, err error)

CreatePicture 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。

可能返回的错误码:

AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER_CHECKCONTENTFAILED = "InvalidParameter.CheckContentFailed"
INVALIDPARAMETER_CHECKSUFFIXFAILED = "InvalidParameter.CheckSuffixFailed"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) CreatePictureWithContext added in v1.0.324

func (c *Client) CreatePictureWithContext(ctx context.Context, request *CreatePictureRequest) (response *CreatePictureResponse, err error)

CreatePicture 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。

可能返回的错误码:

AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER_CHECKCONTENTFAILED = "InvalidParameter.CheckContentFailed"
INVALIDPARAMETER_CHECKSUFFIXFAILED = "InvalidParameter.CheckSuffixFailed"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) CreateTroubleInfo

func (c *Client) CreateTroubleInfo(request *CreateTroubleInfoRequest) (response *CreateTroubleInfoResponse, err error)

CreateTroubleInfo 创建异常信息

可能返回的错误码:

AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
INTERNALERROR = "InternalError"
INTERNALERROR_BACKENDFAIL = "InternalError.BackendFail"
INTERNALERROR_BACKENDTIMEOUT = "InternalError.BackendTimeOut"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"

func (*Client) CreateTroubleInfoWithContext added in v1.0.324

func (c *Client) CreateTroubleInfoWithContext(ctx context.Context, request *CreateTroubleInfoRequest) (response *CreateTroubleInfoResponse, err error)

CreateTroubleInfo 创建异常信息

可能返回的错误码:

AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
INTERNALERROR = "InternalError"
INTERNALERROR_BACKENDFAIL = "InternalError.BackendFail"
INTERNALERROR_BACKENDTIMEOUT = "InternalError.BackendTimeOut"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"

func (*Client) DeleteCloudRecording added in v1.0.400

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

DeleteCloudRecording 成功开启录制后,可以使用此接口来停止录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。

可能返回的错误码:

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 added in v1.0.400

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

DeleteCloudRecording 成功开启录制后,可以使用此接口来停止录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。

可能返回的错误码:

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

func (c *Client) DeletePicture(request *DeletePictureRequest) (response *DeletePictureResponse, err error)

DeletePicture 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PICTURENOTFOUND = "InvalidParameter.PictureNotFound"
MISSINGPARAMETER = "MissingParameter"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) DeletePictureWithContext added in v1.0.324

func (c *Client) DeletePictureWithContext(ctx context.Context, request *DeletePictureRequest) (response *DeletePictureResponse, err error)

DeletePicture 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PICTURENOTFOUND = "InvalidParameter.PictureNotFound"
MISSINGPARAMETER = "MissingParameter"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) DescribeAbnormalEvent

func (c *Client) DescribeAbnormalEvent(request *DescribeAbnormalEventRequest) (response *DescribeAbnormalEventResponse, err error)

DescribeAbnormalEvent 查询SDKAppID下用户的异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询15天内数据,查询起止时间不超过1个小时。支持跨天查询。异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916

可能返回的错误码:

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

func (*Client) DescribeAbnormalEventWithContext added in v1.0.324

func (c *Client) DescribeAbnormalEventWithContext(ctx context.Context, request *DescribeAbnormalEventRequest) (response *DescribeAbnormalEventResponse, err error)

DescribeAbnormalEvent 查询SDKAppID下用户的异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询15天内数据,查询起止时间不超过1个小时。支持跨天查询。异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916

可能返回的错误码:

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

func (*Client) DescribeCallDetail

func (c *Client) DescribeCallDetail(request *DescribeCallDetailRequest) (response *DescribeCallDetailResponse, err error)

DescribeCallDetail 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType,UserIds为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。

**注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。

可能返回的错误码:

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

func (*Client) DescribeCallDetailWithContext added in v1.0.324

func (c *Client) DescribeCallDetailWithContext(ctx context.Context, request *DescribeCallDetailRequest) (response *DescribeCallDetailResponse, err error)

DescribeCallDetail 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType,UserIds为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。

**注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。

可能返回的错误码:

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

func (*Client) DescribeCloudRecording added in v1.0.400

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

DescribeCloudRecording 成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。

可能返回的错误码:

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 added in v1.0.400

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

DescribeCloudRecording 成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。

可能返回的错误码:

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

func (c *Client) DescribeDetailEvent(request *DescribeDetailEventRequest) (response *DescribeDetailEventResponse, err error)

DescribeDetailEvent 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。

可能返回的错误码:

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

func (*Client) DescribeDetailEventWithContext added in v1.0.324

func (c *Client) DescribeDetailEventWithContext(ctx context.Context, request *DescribeDetailEventRequest) (response *DescribeDetailEventResponse, err error)

DescribeDetailEvent 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。

可能返回的错误码:

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

func (*Client) DescribeExternalTrtcMeasure added in v1.0.414

func (c *Client) DescribeExternalTrtcMeasure(request *DescribeExternalTrtcMeasureRequest) (response *DescribeExternalTrtcMeasureResponse, err error)

DescribeExternalTrtcMeasure 获取Trtc的用量统计数据。走计费渠道二期 只允许查两天的数据

可能返回的错误码:

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

func (*Client) DescribeExternalTrtcMeasureWithContext added in v1.0.414

func (c *Client) DescribeExternalTrtcMeasureWithContext(ctx context.Context, request *DescribeExternalTrtcMeasureRequest) (response *DescribeExternalTrtcMeasureResponse, err error)

DescribeExternalTrtcMeasure 获取Trtc的用量统计数据。走计费渠道二期 只允许查两天的数据

可能返回的错误码:

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

func (*Client) DescribeHistoryScale

func (c *Client) DescribeHistoryScale(request *DescribeHistoryScaleRequest) (response *DescribeHistoryScaleResponse, err error)

DescribeHistoryScale 可查询sdkqppid 每天的房间数和用户数,每分钟1次,可查询最近14天的数据。当天未结束,无法查到当天的房间数与用户数。

可能返回的错误码:

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

func (*Client) DescribeHistoryScaleWithContext added in v1.0.324

func (c *Client) DescribeHistoryScaleWithContext(ctx context.Context, request *DescribeHistoryScaleRequest) (response *DescribeHistoryScaleResponse, err error)

DescribeHistoryScale 可查询sdkqppid 每天的房间数和用户数,每分钟1次,可查询最近14天的数据。当天未结束,无法查到当天的房间数与用户数。

可能返回的错误码:

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

func (*Client) DescribePicture

func (c *Client) DescribePicture(request *DescribePictureRequest) (response *DescribePictureResponse, err error)

DescribePicture 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。

可能返回的错误码:

AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
MISSINGPARAMETER = "MissingParameter"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) DescribePictureWithContext added in v1.0.324

func (c *Client) DescribePictureWithContext(ctx context.Context, request *DescribePictureRequest) (response *DescribePictureResponse, err error)

DescribePicture 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。

可能返回的错误码:

AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
MISSINGPARAMETER = "MissingParameter"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) DescribeRecordStatistic

func (c *Client) DescribeRecordStatistic(request *DescribeRecordStatisticRequest) (response *DescribeRecordStatisticResponse, err error)

DescribeRecordStatistic 查询云端录制计费时长。

- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。

- 单次查询统计区间最多不能超过31天。

- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。

- 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。

可能返回的错误码:

AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPID = "InvalidParameter.AppId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeRecordStatisticWithContext added in v1.0.324

func (c *Client) DescribeRecordStatisticWithContext(ctx context.Context, request *DescribeRecordStatisticRequest) (response *DescribeRecordStatisticResponse, err error)

DescribeRecordStatistic 查询云端录制计费时长。

- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。

- 单次查询统计区间最多不能超过31天。

- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。

- 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。

可能返回的错误码:

AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPID = "InvalidParameter.AppId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeRoomInformation

func (c *Client) DescribeRoomInformation(request *DescribeRoomInformationRequest) (response *DescribeRoomInformationResponse, err error)

DescribeRoomInformation 查询sdkappid下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。

**注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。

可能返回的错误码:

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

func (*Client) DescribeRoomInformationWithContext added in v1.0.324

func (c *Client) DescribeRoomInformationWithContext(ctx context.Context, request *DescribeRoomInformationRequest) (response *DescribeRoomInformationResponse, err error)

DescribeRoomInformation 查询sdkappid下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。

**注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。

可能返回的错误码:

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

func (*Client) DescribeTrtcMcuTranscodeTime

func (c *Client) DescribeTrtcMcuTranscodeTime(request *DescribeTrtcMcuTranscodeTimeRequest) (response *DescribeTrtcMcuTranscodeTimeResponse, err error)

DescribeTrtcMcuTranscodeTime 查询旁路转码计费时长。

- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。

- 单次查询统计区间最多不能超过31天。

- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。

- 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeTrtcMcuTranscodeTimeWithContext added in v1.0.324

func (c *Client) DescribeTrtcMcuTranscodeTimeWithContext(ctx context.Context, request *DescribeTrtcMcuTranscodeTimeRequest) (response *DescribeTrtcMcuTranscodeTimeResponse, err error)

DescribeTrtcMcuTranscodeTime 查询旁路转码计费时长。

- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。

- 单次查询统计区间最多不能超过31天。

- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。

- 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeUserInformation

func (c *Client) DescribeUserInformation(request *DescribeUserInformationRequest) (response *DescribeUserInformationResponse, err error)

DescribeUserInformation 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。

**注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。

可能返回的错误码:

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

func (*Client) DescribeUserInformationWithContext added in v1.0.324

func (c *Client) DescribeUserInformationWithContext(ctx context.Context, request *DescribeUserInformationRequest) (response *DescribeUserInformationResponse, err error)

DescribeUserInformation 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。

**注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。

可能返回的错误码:

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

func (*Client) DismissRoom

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

DismissRoom 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

可能返回的错误码:

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 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

可能返回的错误码:

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 added in v1.0.324

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

DismissRoomByStrRoomId 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

可能返回的错误码:

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 added in v1.0.324

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

DismissRoom 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

可能返回的错误码:

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) MeasureTrtcMcuExternal added in v1.0.414

func (c *Client) MeasureTrtcMcuExternal(request *MeasureTrtcMcuExternalRequest) (response *MeasureTrtcMcuExternalResponse, err error)

MeasureTrtcMcuExternal 查询旁路转码计费时长。

- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。

- 单次查询统计区间最多不能超过2天。

- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。

- 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。

可能返回的错误码:

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) MeasureTrtcMcuExternalWithContext added in v1.0.414

func (c *Client) MeasureTrtcMcuExternalWithContext(ctx context.Context, request *MeasureTrtcMcuExternalRequest) (response *MeasureTrtcMcuExternalResponse, err error)

MeasureTrtcMcuExternal 查询旁路转码计费时长。

- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。

- 单次查询统计区间最多不能超过2天。

- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。

- 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。

可能返回的错误码:

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) ModifyCloudRecording added in v1.0.400

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

ModifyCloudRecording 成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。

可能返回的错误码:

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 added in v1.0.400

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

ModifyCloudRecording 成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。

可能返回的错误码:

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

func (c *Client) ModifyPicture(request *ModifyPictureRequest) (response *ModifyPictureResponse, err error)

ModifyPicture 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。

可能返回的错误码:

AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
MISSINGPARAMETER = "MissingParameter"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) ModifyPictureWithContext added in v1.0.324

func (c *Client) ModifyPictureWithContext(ctx context.Context, request *ModifyPictureRequest) (response *ModifyPictureResponse, err error)

ModifyPicture 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。

可能返回的错误码:

AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated"
INTERNALERROR = "InternalError"
INTERNALERROR_DBERROR = "InternalError.DBError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
MISSINGPARAMETER = "MissingParameter"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) RemoveUser

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

RemoveUser 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

可能返回的错误码:

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 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

可能返回的错误码:

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 added in v1.0.324

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

RemoveUserByStrRoomId 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

可能返回的错误码:

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 added in v1.0.324

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

RemoveUser 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

可能返回的错误码:

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

func (c *Client) StartMCUMixTranscode(request *StartMCUMixTranscodeRequest) (response *StartMCUMixTranscodeResponse, err error)

StartMCUMixTranscode 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。

TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。房间销毁后混流自动结束。

您可以通过此接口实现如下目标:

- 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。

- 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。

- 设置录制文件名,用于二次回放。

- 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。

目前已经支持了如下几种布局模板:

- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。

- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。

- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。

- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置,最多支持2个画面。

- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。

注意:

1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**

2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。

3、客户端混流和服务端混流不能混用。

可能返回的错误码:

FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection"
FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_GETROOMFROMCACHEERROR = "InternalError.GetRoomFromCacheError"
INTERNALERROR_INTERNALERROR = "InternalError.InternalError"
INVALIDPARAMETER_AUDIOENCODEPARAMS = "InvalidParameter.AudioEncodeParams"
INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams"
INVALIDPARAMETER_MAINVIDEORIGHTALIGN = "InvalidParameter.MainVideoRightAlign"
INVALIDPARAMETER_MAINVIDEOSTREAMTYPE = "InvalidParameter.MainVideoStreamType"
INVALIDPARAMETER_OUTPUTPARAMS = "InvalidParameter.OutputParams"
INVALIDPARAMETER_PRESETLAYOUTCONFIG = "InvalidParameter.PresetLayoutConfig"
INVALIDPARAMETER_PUBLISHCDNURLS = "InvalidParameter.PublishCdnUrls"
INVALIDPARAMETER_PUREAUDIOSTREAM = "InvalidParameter.PureAudioStream"
INVALIDPARAMETER_RECORDAUDIOONLY = "InvalidParameter.RecordAudioOnly"
INVALIDPARAMETER_RECORDID = "InvalidParameter.RecordId"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_SMALLVIDEOLAYOUTPARAMS = "InvalidParameter.SmallVideoLayoutParams"
INVALIDPARAMETER_SMALLVIDEOSTREAMTYPE = "InvalidParameter.SmallVideoStreamType"
INVALIDPARAMETER_STREAMID = "InvalidParameter.StreamId"
INVALIDPARAMETER_VIDEORESOLUTION = "InvalidParameter.VideoResolution"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_AUDIOENCODEPARAMS = "MissingParameter.AudioEncodeParams"
MISSINGPARAMETER_BIZID = "MissingParameter.BizId"
MISSINGPARAMETER_ENCODEPARAMS = "MissingParameter.EncodeParams"
MISSINGPARAMETER_OUTPUTPARAMS = "MissingParameter.OutputParams"
MISSINGPARAMETER_PRESETLAYOUTCONFIG = "MissingParameter.PresetLayoutConfig"
MISSINGPARAMETER_PUBLISHCDNPARAMS = "MissingParameter.PublishCdnParams"
MISSINGPARAMETER_PUBLISHCDNURLS = "MissingParameter.PublishCdnUrls"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_STREAMID = "MissingParameter.StreamId"
MISSINGPARAMETER_VIDEOENCODEPARAMS = "MissingParameter.VideoEncodeParams"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) StartMCUMixTranscodeByStrRoomId

func (c *Client) StartMCUMixTranscodeByStrRoomId(request *StartMCUMixTranscodeByStrRoomIdRequest) (response *StartMCUMixTranscodeByStrRoomIdResponse, err error)

StartMCUMixTranscodeByStrRoomId 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。

TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。

您可以通过此接口实现如下目标:

- 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。

- 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。

- 设置录制文件名,用于二次回放。

- 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。

目前已经支持了如下几种布局模板:

- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。

- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。

- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。

- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。

- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。

注意:

1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**

2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。

3、客户端混流和服务端混流不能混用。

可能返回的错误码:

FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection"
FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_AUDIOENCODEPARAMS = "InvalidParameter.AudioEncodeParams"
INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams"
INVALIDPARAMETER_MAINVIDEOSTREAMTYPE = "InvalidParameter.MainVideoStreamType"
INVALIDPARAMETER_OUTPUTPARAMS = "InvalidParameter.OutputParams"
INVALIDPARAMETER_PRESETLAYOUTCONFIG = "InvalidParameter.PresetLayoutConfig"
INVALIDPARAMETER_PUBLISHCDNURLS = "InvalidParameter.PublishCdnUrls"
INVALIDPARAMETER_PUREAUDIOSTREAM = "InvalidParameter.PureAudioStream"
INVALIDPARAMETER_RECORDAUDIOONLY = "InvalidParameter.RecordAudioOnly"
INVALIDPARAMETER_RECORDID = "InvalidParameter.RecordId"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_SMALLVIDEOLAYOUTPARAMS = "InvalidParameter.SmallVideoLayoutParams"
INVALIDPARAMETER_SMALLVIDEOSTREAMTYPE = "InvalidParameter.SmallVideoStreamType"
INVALIDPARAMETER_STREAMID = "InvalidParameter.StreamId"
INVALIDPARAMETER_VIDEORESOLUTION = "InvalidParameter.VideoResolution"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_AUDIOENCODEPARAMS = "MissingParameter.AudioEncodeParams"
MISSINGPARAMETER_BIZID = "MissingParameter.BizId"
MISSINGPARAMETER_ENCODEPARAMS = "MissingParameter.EncodeParams"
MISSINGPARAMETER_OUTPUTPARAMS = "MissingParameter.OutputParams"
MISSINGPARAMETER_PRESETLAYOUTCONFIG = "MissingParameter.PresetLayoutConfig"
MISSINGPARAMETER_PUBLISHCDNPARAMS = "MissingParameter.PublishCdnParams"
MISSINGPARAMETER_PUBLISHCDNURLS = "MissingParameter.PublishCdnUrls"
MISSINGPARAMETER_STREAMID = "MissingParameter.StreamId"
MISSINGPARAMETER_VIDEOENCODEPARAMS = "MissingParameter.VideoEncodeParams"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) StartMCUMixTranscodeByStrRoomIdWithContext added in v1.0.324

func (c *Client) StartMCUMixTranscodeByStrRoomIdWithContext(ctx context.Context, request *StartMCUMixTranscodeByStrRoomIdRequest) (response *StartMCUMixTranscodeByStrRoomIdResponse, err error)

StartMCUMixTranscodeByStrRoomId 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。

TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。

您可以通过此接口实现如下目标:

- 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。

- 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。

- 设置录制文件名,用于二次回放。

- 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。

目前已经支持了如下几种布局模板:

- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。

- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。

- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。

- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。

- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。

注意:

1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**

2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。

3、客户端混流和服务端混流不能混用。

可能返回的错误码:

FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection"
FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_AUDIOENCODEPARAMS = "InvalidParameter.AudioEncodeParams"
INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams"
INVALIDPARAMETER_MAINVIDEOSTREAMTYPE = "InvalidParameter.MainVideoStreamType"
INVALIDPARAMETER_OUTPUTPARAMS = "InvalidParameter.OutputParams"
INVALIDPARAMETER_PRESETLAYOUTCONFIG = "InvalidParameter.PresetLayoutConfig"
INVALIDPARAMETER_PUBLISHCDNURLS = "InvalidParameter.PublishCdnUrls"
INVALIDPARAMETER_PUREAUDIOSTREAM = "InvalidParameter.PureAudioStream"
INVALIDPARAMETER_RECORDAUDIOONLY = "InvalidParameter.RecordAudioOnly"
INVALIDPARAMETER_RECORDID = "InvalidParameter.RecordId"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_SMALLVIDEOLAYOUTPARAMS = "InvalidParameter.SmallVideoLayoutParams"
INVALIDPARAMETER_SMALLVIDEOSTREAMTYPE = "InvalidParameter.SmallVideoStreamType"
INVALIDPARAMETER_STREAMID = "InvalidParameter.StreamId"
INVALIDPARAMETER_VIDEORESOLUTION = "InvalidParameter.VideoResolution"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_AUDIOENCODEPARAMS = "MissingParameter.AudioEncodeParams"
MISSINGPARAMETER_BIZID = "MissingParameter.BizId"
MISSINGPARAMETER_ENCODEPARAMS = "MissingParameter.EncodeParams"
MISSINGPARAMETER_OUTPUTPARAMS = "MissingParameter.OutputParams"
MISSINGPARAMETER_PRESETLAYOUTCONFIG = "MissingParameter.PresetLayoutConfig"
MISSINGPARAMETER_PUBLISHCDNPARAMS = "MissingParameter.PublishCdnParams"
MISSINGPARAMETER_PUBLISHCDNURLS = "MissingParameter.PublishCdnUrls"
MISSINGPARAMETER_STREAMID = "MissingParameter.StreamId"
MISSINGPARAMETER_VIDEOENCODEPARAMS = "MissingParameter.VideoEncodeParams"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) StartMCUMixTranscodeWithContext added in v1.0.324

func (c *Client) StartMCUMixTranscodeWithContext(ctx context.Context, request *StartMCUMixTranscodeRequest) (response *StartMCUMixTranscodeResponse, err error)

StartMCUMixTranscode 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。

TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。房间销毁后混流自动结束。

您可以通过此接口实现如下目标:

- 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。

- 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。

- 设置录制文件名,用于二次回放。

- 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。

目前已经支持了如下几种布局模板:

- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。

- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。

- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。

- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置,最多支持2个画面。

- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。

注意:

1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**

2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。

3、客户端混流和服务端混流不能混用。

可能返回的错误码:

FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection"
FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_GETROOMFROMCACHEERROR = "InternalError.GetRoomFromCacheError"
INTERNALERROR_INTERNALERROR = "InternalError.InternalError"
INVALIDPARAMETER_AUDIOENCODEPARAMS = "InvalidParameter.AudioEncodeParams"
INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams"
INVALIDPARAMETER_MAINVIDEORIGHTALIGN = "InvalidParameter.MainVideoRightAlign"
INVALIDPARAMETER_MAINVIDEOSTREAMTYPE = "InvalidParameter.MainVideoStreamType"
INVALIDPARAMETER_OUTPUTPARAMS = "InvalidParameter.OutputParams"
INVALIDPARAMETER_PRESETLAYOUTCONFIG = "InvalidParameter.PresetLayoutConfig"
INVALIDPARAMETER_PUBLISHCDNURLS = "InvalidParameter.PublishCdnUrls"
INVALIDPARAMETER_PUREAUDIOSTREAM = "InvalidParameter.PureAudioStream"
INVALIDPARAMETER_RECORDAUDIOONLY = "InvalidParameter.RecordAudioOnly"
INVALIDPARAMETER_RECORDID = "InvalidParameter.RecordId"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_SMALLVIDEOLAYOUTPARAMS = "InvalidParameter.SmallVideoLayoutParams"
INVALIDPARAMETER_SMALLVIDEOSTREAMTYPE = "InvalidParameter.SmallVideoStreamType"
INVALIDPARAMETER_STREAMID = "InvalidParameter.StreamId"
INVALIDPARAMETER_VIDEORESOLUTION = "InvalidParameter.VideoResolution"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_AUDIOENCODEPARAMS = "MissingParameter.AudioEncodeParams"
MISSINGPARAMETER_BIZID = "MissingParameter.BizId"
MISSINGPARAMETER_ENCODEPARAMS = "MissingParameter.EncodeParams"
MISSINGPARAMETER_OUTPUTPARAMS = "MissingParameter.OutputParams"
MISSINGPARAMETER_PRESETLAYOUTCONFIG = "MissingParameter.PresetLayoutConfig"
MISSINGPARAMETER_PUBLISHCDNPARAMS = "MissingParameter.PublishCdnParams"
MISSINGPARAMETER_PUBLISHCDNURLS = "MissingParameter.PublishCdnUrls"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
MISSINGPARAMETER_STREAMID = "MissingParameter.StreamId"
MISSINGPARAMETER_VIDEOENCODEPARAMS = "MissingParameter.VideoEncodeParams"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

func (*Client) StopMCUMixTranscode

func (c *Client) StopMCUMixTranscode(request *StopMCUMixTranscodeRequest) (response *StopMCUMixTranscodeResponse, err error)

StopMCUMixTranscode 接口说明:结束云端混流

可能返回的错误码:

FAILEDOPERATION_MIXSESSIONNOTEXIST = "FailedOperation.MixSessionNotExist"
FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection"
FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_GETROOMFROMCACHEERROR = "InternalError.GetRoomFromCacheError"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
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) StopMCUMixTranscodeByStrRoomId

func (c *Client) StopMCUMixTranscodeByStrRoomId(request *StopMCUMixTranscodeByStrRoomIdRequest) (response *StopMCUMixTranscodeByStrRoomIdResponse, err error)

StopMCUMixTranscodeByStrRoomId 接口说明:结束云端混流

可能返回的错误码:

FAILEDOPERATION_MIXSESSIONNOTEXIST = "FailedOperation.MixSessionNotExist"
FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection"
FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
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) StopMCUMixTranscodeByStrRoomIdWithContext added in v1.0.324

func (c *Client) StopMCUMixTranscodeByStrRoomIdWithContext(ctx context.Context, request *StopMCUMixTranscodeByStrRoomIdRequest) (response *StopMCUMixTranscodeByStrRoomIdResponse, err error)

StopMCUMixTranscodeByStrRoomId 接口说明:结束云端混流

可能返回的错误码:

FAILEDOPERATION_MIXSESSIONNOTEXIST = "FailedOperation.MixSessionNotExist"
FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection"
FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
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) StopMCUMixTranscodeWithContext added in v1.0.324

func (c *Client) StopMCUMixTranscodeWithContext(ctx context.Context, request *StopMCUMixTranscodeRequest) (response *StopMCUMixTranscodeResponse, err error)

StopMCUMixTranscode 接口说明:结束云端混流

可能返回的错误码:

FAILEDOPERATION_MIXSESSIONNOTEXIST = "FailedOperation.MixSessionNotExist"
FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection"
FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_GETROOMFROMCACHEERROR = "InternalError.GetRoomFromCacheError"
INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError"
INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId"
MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId"
MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId"
UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"

type CloudStorage added in v1.0.400

type CloudStorage struct {

	// 第三方云储存的供应商:
	// 0:腾讯云存储 COS,暂不支持其他家。
	Vendor *uint64 `json:"Vendor,omitempty" name:"Vendor"`

	// 第三方云存储的地域信息。
	Region *string `json:"Region,omitempty" name:"Region"`

	// 第三方存储桶信息。
	Bucket *string `json:"Bucket,omitempty" name:"Bucket"`

	// 第三方存储的access_key账号信息。
	AccessKey *string `json:"AccessKey,omitempty" name:"AccessKey"`

	// 第三方存储的secret_key账号信息。
	SecretKey *string `json:"SecretKey,omitempty" name:"SecretKey"`

	// 第三方云存储bucket 的指定位置,由字符串数组组成。合法的字符串范围a~z,A~Z,0~9,'_'和'-',举个例子,录制文件xxx.m3u8在 ["prefix1", "prefix2"]作用下,会变成prefix1/prefix2/TaskId/xxx.m3u8。
	FileNamePrefix []*string `json:"FileNamePrefix,omitempty" name:"FileNamePrefix"`
}

type CloudVod added in v1.0.400

type CloudVod struct {

	// 腾讯云点播相关参数。
	TencentVod *TencentVod `json:"TencentVod,omitempty" name:"TencentVod"`
}

type CreateCloudRecordingRequest added in v1.0.400

type CreateCloudRecordingRequest struct {
	*tchttp.BaseRequest

	// TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// 录制服务在TRTC房间使用的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者录制服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// 云端录制加入房间的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
	UserSig *string `json:"UserSig,omitempty" name:"UserSig"`

	// 云端录制控制参数。
	RecordParams *RecordParams `json:"RecordParams,omitempty" name:"RecordParams"`

	// 云端录制文件上传到云存储的参数。
	StorageParams *StorageParams `json:"StorageParams,omitempty" name:"StorageParams"`

	// TRTC房间号的类型,必须和录制的房间所对应的RoomId类型相同:
	// 0: 字符串类型的RoomId
	// 1: 32位整型的RoomId(默认)
	RoomIdType *uint64 `json:"RoomIdType,omitempty" name:"RoomIdType"`

	// 混流的转码参数,录制模式为混流的时候可以设置。
	MixTranscodeParams *MixTranscodeParams `json:"MixTranscodeParams,omitempty" name:"MixTranscodeParams"`

	// 混流的布局参数,录制模式为混流的时候可以设置。
	MixLayoutParams *MixLayoutParams `json:"MixLayoutParams,omitempty" name:"MixLayoutParams"`

	// 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。
	ResourceExpiredHour *uint64 `json:"ResourceExpiredHour,omitempty" name:"ResourceExpiredHour"`

	// TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey](https://cloud.tencent.com/document/product/647/32240) 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。
	PrivateMapKey *string `json:"PrivateMapKey,omitempty" name:"PrivateMapKey"`
}

func NewCreateCloudRecordingRequest added in v1.0.400

func NewCreateCloudRecordingRequest() (request *CreateCloudRecordingRequest)

func (*CreateCloudRecordingRequest) FromJsonString added in v1.0.400

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 added in v1.0.400

func (r *CreateCloudRecordingRequest) ToJsonString() string

type CreateCloudRecordingResponse added in v1.0.400

type CreateCloudRecordingResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。任务 ID需要业务保存下来,作为下次针对这个录制任务操作的参数。
		TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateCloudRecordingResponse added in v1.0.400

func NewCreateCloudRecordingResponse() (response *CreateCloudRecordingResponse)

func (*CreateCloudRecordingResponse) FromJsonString added in v1.0.400

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 added in v1.0.400

func (r *CreateCloudRecordingResponse) ToJsonString() string

type CreatePictureRequest

type CreatePictureRequest struct {
	*tchttp.BaseRequest

	// 应用id
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 图片内容经base64编码后的string格式
	Content *string `json:"Content,omitempty" name:"Content"`

	// 图片后缀名
	Suffix *string `json:"Suffix,omitempty" name:"Suffix"`

	// 图片长度
	Height *uint64 `json:"Height,omitempty" name:"Height"`

	// 图片宽度
	Width *uint64 `json:"Width,omitempty" name:"Width"`

	// 显示位置x轴方向
	XPosition *uint64 `json:"XPosition,omitempty" name:"XPosition"`

	// 显示位置y轴方向
	YPosition *uint64 `json:"YPosition,omitempty" name:"YPosition"`
}

func NewCreatePictureRequest

func NewCreatePictureRequest() (request *CreatePictureRequest)

func (*CreatePictureRequest) FromJsonString

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

func (r *CreatePictureRequest) ToJsonString() string

type CreatePictureResponse

type CreatePictureResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 图片id
		PictureId *uint64 `json:"PictureId,omitempty" name:"PictureId"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreatePictureResponse

func NewCreatePictureResponse() (response *CreatePictureResponse)

func (*CreatePictureResponse) FromJsonString

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

func (r *CreatePictureResponse) ToJsonString() string

type CreateTroubleInfoRequest

type CreateTroubleInfoRequest struct {
	*tchttp.BaseRequest

	// 应用的ID
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

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

	// 老师用户ID
	TeacherUserId *string `json:"TeacherUserId,omitempty" name:"TeacherUserId"`

	// 学生用户ID
	StudentUserId *string `json:"StudentUserId,omitempty" name:"StudentUserId"`

	// 体验异常端(老师或学生)的用户 ID。
	TroubleUserId *string `json:"TroubleUserId,omitempty" name:"TroubleUserId"`

	// 异常类型。
	// 1. 仅视频异常
	// 2. 仅声音异常
	// 3. 音视频都异常
	// 5. 进房异常
	// 4. 切课
	// 6. 求助
	// 7. 问题反馈
	// 8. 投诉
	TroubleType *uint64 `json:"TroubleType,omitempty" name:"TroubleType"`

	// 异常发生的UNIX 时间戳,单位为秒。
	TroubleTime *uint64 `json:"TroubleTime,omitempty" name:"TroubleTime"`

	// 异常详情
	TroubleMsg *string `json:"TroubleMsg,omitempty" name:"TroubleMsg"`
}

func NewCreateTroubleInfoRequest

func NewCreateTroubleInfoRequest() (request *CreateTroubleInfoRequest)

func (*CreateTroubleInfoRequest) FromJsonString

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

func (r *CreateTroubleInfoRequest) ToJsonString() string

type CreateTroubleInfoResponse

type CreateTroubleInfoResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateTroubleInfoResponse

func NewCreateTroubleInfoResponse() (response *CreateTroubleInfoResponse)

func (*CreateTroubleInfoResponse) FromJsonString

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

func (r *CreateTroubleInfoResponse) ToJsonString() string

type DeleteCloudRecordingRequest added in v1.0.400

type DeleteCloudRecordingRequest struct {
	*tchttp.BaseRequest

	// TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 录制任务的唯一Id,在启动录制成功后会返回。
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`
}

func NewDeleteCloudRecordingRequest added in v1.0.400

func NewDeleteCloudRecordingRequest() (request *DeleteCloudRecordingRequest)

func (*DeleteCloudRecordingRequest) FromJsonString added in v1.0.400

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 added in v1.0.400

func (r *DeleteCloudRecordingRequest) ToJsonString() string

type DeleteCloudRecordingResponse added in v1.0.400

type DeleteCloudRecordingResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。
		TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteCloudRecordingResponse added in v1.0.400

func NewDeleteCloudRecordingResponse() (response *DeleteCloudRecordingResponse)

func (*DeleteCloudRecordingResponse) FromJsonString added in v1.0.400

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 added in v1.0.400

func (r *DeleteCloudRecordingResponse) ToJsonString() string

type DeletePictureRequest

type DeletePictureRequest struct {
	*tchttp.BaseRequest

	// 图片id
	PictureId *uint64 `json:"PictureId,omitempty" name:"PictureId"`

	// 应用id
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`
}

func NewDeletePictureRequest

func NewDeletePictureRequest() (request *DeletePictureRequest)

func (*DeletePictureRequest) FromJsonString

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

func (r *DeletePictureRequest) ToJsonString() string

type DeletePictureResponse

type DeletePictureResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeletePictureResponse

func NewDeletePictureResponse() (response *DeletePictureResponse)

func (*DeletePictureResponse) FromJsonString

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

func (r *DeletePictureResponse) ToJsonString() string

type DescribeAbnormalEventRequest

type DescribeAbnormalEventRequest struct {
	*tchttp.BaseRequest

	// 用户SDKAppID,查询SDKAppID下任意20条异常体验事件(可能不同房间)
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 查询开始时间,本地unix时间戳(1592448600s)
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间,本地unix时间戳(1592449080s)
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`

	// 房间号,查询房间内任意20条以内异常体验事件
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`
}

func NewDescribeAbnormalEventRequest

func NewDescribeAbnormalEventRequest() (request *DescribeAbnormalEventRequest)

func (*DescribeAbnormalEventRequest) FromJsonString

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

func (r *DescribeAbnormalEventRequest) ToJsonString() string

type DescribeAbnormalEventResponse

type DescribeAbnormalEventResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的数据总条数
		Total *uint64 `json:"Total,omitempty" name:"Total"`

		// 异常体验列表
		AbnormalExperienceList []*AbnormalExperience `json:"AbnormalExperienceList,omitempty" name:"AbnormalExperienceList"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeAbnormalEventResponse

func NewDescribeAbnormalEventResponse() (response *DescribeAbnormalEventResponse)

func (*DescribeAbnormalEventResponse) FromJsonString

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

func (r *DescribeAbnormalEventResponse) ToJsonString() string

type DescribeCallDetailRequest

type DescribeCallDetailRequest struct {
	*tchttp.BaseRequest

	// 通话 ID(唯一标识一次通话): sdkappid_roomgString(房间号_createTime(房间创建时间,unix时间戳,单位为s)例:1400353843_218695_1590065777。通过 DescribeRoomInformation(查询房间列表)接口获取(链接:https://cloud.tencent.com/document/product/647/44050
	CommId *string `json:"CommId,omitempty" name:"CommId"`

	// 查询开始时间,14天内。本地unix时间戳(1590065777s),查询实时数据时,查询起止时间不超过1个小时。
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间,本地unix时间戳(1590065877s)
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`

	// 用户SDKAppID(1400353843)
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 需查询的用户数组,不填默认返回6个用户,最多可填6个用户
	UserIds []*string `json:"UserIds,omitempty" name:"UserIds"`

	// 需查询的指标,不填则只返回用户列表,填all则返回所有指标。
	// appCpu:APP CPU使用率;
	// sysCpu:系统 CPU使用率;
	// aBit:上/下行音频码率;单位:bps
	// aBlock:音频卡顿时长;单位:ms
	// bigvBit:上/下行视频码率;单位:bps
	// bigvCapFps:视频采集帧率;
	// bigvEncFps:视频发送帧率;
	// bigvDecFps:渲染帧率;
	// bigvBlock:视频卡顿时长;单位:ms
	// aLoss:上/下行音频丢包率;
	// bigvLoss:上/下行视频丢包率;
	// bigvWidth:上/下行分辨率宽;
	// bigvHeight:上/下行分辨率高
	DataType []*string `json:"DataType,omitempty" name:"DataType"`

	// 设置分页index,从0开始(PageNumber和PageSize 其中一个不填均默认返回6条数据)
	PageNumber *string `json:"PageNumber,omitempty" name:"PageNumber"`

	// 设置分页大小(PageNumber和PageSize 其中一个不填均默认返回6条数据,DataType,UserIds不为null,PageSize最大不超过6,DataType,UserIds为null,PageSize最大不超过100)
	PageSize *string `json:"PageSize,omitempty" name:"PageSize"`
}

func NewDescribeCallDetailRequest

func NewDescribeCallDetailRequest() (request *DescribeCallDetailRequest)

func (*DescribeCallDetailRequest) FromJsonString

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

func (r *DescribeCallDetailRequest) ToJsonString() string

type DescribeCallDetailResponse

type DescribeCallDetailResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的用户总条数
		Total *uint64 `json:"Total,omitempty" name:"Total"`

		// 用户信息列表
		// 注意:此字段可能返回 null,表示取不到有效值。
		UserList []*UserInformation `json:"UserList,omitempty" name:"UserList"`

		// 质量数据
		// 注意:此字段可能返回 null,表示取不到有效值。
		Data []*QualityData `json:"Data,omitempty" name:"Data"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeCallDetailResponse

func NewDescribeCallDetailResponse() (response *DescribeCallDetailResponse)

func (*DescribeCallDetailResponse) FromJsonString

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

func (r *DescribeCallDetailResponse) ToJsonString() string

type DescribeCloudRecordingRequest added in v1.0.400

type DescribeCloudRecordingRequest struct {
	*tchttp.BaseRequest

	// TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 录制任务的唯一Id,在启动录制成功后会返回。
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`
}

func NewDescribeCloudRecordingRequest added in v1.0.400

func NewDescribeCloudRecordingRequest() (request *DescribeCloudRecordingRequest)

func (*DescribeCloudRecordingRequest) FromJsonString added in v1.0.400

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 added in v1.0.400

func (r *DescribeCloudRecordingRequest) ToJsonString() string

type DescribeCloudRecordingResponse added in v1.0.400

type DescribeCloudRecordingResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 录制任务的唯一Id。
		TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

		// 云端录制任务的状态信息。
		// Idle:表示当前录制任务空闲中
		// InProgress:表示当前录制任务正在进行中。
		// Exited:表示当前录制任务正在退出的过程中。
		Status *string `json:"Status,omitempty" name:"Status"`

		// 录制文件信息。
		// 注意:此字段可能返回 null,表示取不到有效值。
		StorageFileList []*StorageFile `json:"StorageFileList,omitempty" name:"StorageFileList"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeCloudRecordingResponse added in v1.0.400

func NewDescribeCloudRecordingResponse() (response *DescribeCloudRecordingResponse)

func (*DescribeCloudRecordingResponse) FromJsonString added in v1.0.400

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 added in v1.0.400

func (r *DescribeCloudRecordingResponse) ToJsonString() string

type DescribeDetailEventRequest

type DescribeDetailEventRequest struct {
	*tchttp.BaseRequest

	// 通话 ID(唯一标识一次通话): sdkappid_roomgString(房间号_createTime(房间创建时间,unix时间戳,单位s)。通过 DescribeRoomInformation(查询房间列表)接口获取。(链接:https://cloud.tencent.com/document/product/647/44050
	CommId *string `json:"CommId,omitempty" name:"CommId"`

	// 查询开始时间,14天内。本地unix时间戳(1588055615s)
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间,本地unix时间戳(1588058615s)
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`

	// 用户id
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// 房间号
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`
}

func NewDescribeDetailEventRequest

func NewDescribeDetailEventRequest() (request *DescribeDetailEventRequest)

func (*DescribeDetailEventRequest) FromJsonString

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

func (r *DescribeDetailEventRequest) ToJsonString() string

type DescribeDetailEventResponse

type DescribeDetailEventResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的事件列表,若没有数据,会返回空数组。
		Data []*EventList `json:"Data,omitempty" name:"Data"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeDetailEventResponse

func NewDescribeDetailEventResponse() (response *DescribeDetailEventResponse)

func (*DescribeDetailEventResponse) FromJsonString

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

func (r *DescribeDetailEventResponse) ToJsonString() string

type DescribeExternalTrtcMeasureRequest added in v1.0.414

type DescribeExternalTrtcMeasureRequest struct {
	*tchttp.BaseRequest

	// 查询开始日期。
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束日期。
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// 对应的应用。如果没有这个参数,表示获取用户名下全部实时音视频应用的汇总。
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`
}

func NewDescribeExternalTrtcMeasureRequest added in v1.0.414

func NewDescribeExternalTrtcMeasureRequest() (request *DescribeExternalTrtcMeasureRequest)

func (*DescribeExternalTrtcMeasureRequest) FromJsonString added in v1.0.414

func (r *DescribeExternalTrtcMeasureRequest) 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 (*DescribeExternalTrtcMeasureRequest) ToJsonString added in v1.0.414

func (r *DescribeExternalTrtcMeasureRequest) ToJsonString() string

type DescribeExternalTrtcMeasureResponse added in v1.0.414

type DescribeExternalTrtcMeasureResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 每个SdkAppId的时长使用信息
		SdkAppIdTrtrTimeUsages []*SdkAppIdNewTrtcTimeUsage `json:"SdkAppIdTrtrTimeUsages,omitempty" name:"SdkAppIdTrtrTimeUsages"`

		// 主播的用量统计方式。取值"InRoomTime":房间时长,"SubscribeTime":"订阅时长","Bandwidth":带宽
		AnchorUsageMode *string `json:"AnchorUsageMode,omitempty" name:"AnchorUsageMode"`

		// 观众的用量统计方式。取值"InRoomTime":在房间时长,"SubscribeTime":"订阅时长","Bandwidth":带宽,"MergeWithAnchor":"不区分麦上麦下"
		AudienceUsageMode *string `json:"AudienceUsageMode,omitempty" name:"AudienceUsageMode"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeExternalTrtcMeasureResponse added in v1.0.414

func NewDescribeExternalTrtcMeasureResponse() (response *DescribeExternalTrtcMeasureResponse)

func (*DescribeExternalTrtcMeasureResponse) FromJsonString added in v1.0.414

func (r *DescribeExternalTrtcMeasureResponse) 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 (*DescribeExternalTrtcMeasureResponse) ToJsonString added in v1.0.414

func (r *DescribeExternalTrtcMeasureResponse) ToJsonString() string

type DescribeHistoryScaleRequest

type DescribeHistoryScaleRequest struct {
	*tchttp.BaseRequest

	// 用户sdkappid(1400188366)
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 查询开始时间,5天内。本地unix时间戳(1587571000s)
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间,本地unix时间戳(1588034999s)
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
}

func NewDescribeHistoryScaleRequest

func NewDescribeHistoryScaleRequest() (request *DescribeHistoryScaleRequest)

func (*DescribeHistoryScaleRequest) FromJsonString

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

func (r *DescribeHistoryScaleRequest) ToJsonString() string

type DescribeHistoryScaleResponse

type DescribeHistoryScaleResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的数据条数
		Total *uint64 `json:"Total,omitempty" name:"Total"`

		// 返回的数据
		// 注意:此字段可能返回 null,表示取不到有效值。
		ScaleList []*ScaleInfomation `json:"ScaleList,omitempty" name:"ScaleList"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeHistoryScaleResponse

func NewDescribeHistoryScaleResponse() (response *DescribeHistoryScaleResponse)

func (*DescribeHistoryScaleResponse) FromJsonString

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

func (r *DescribeHistoryScaleResponse) ToJsonString() string

type DescribePictureRequest

type DescribePictureRequest struct {
	*tchttp.BaseRequest

	// 应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 图片ID,不填时返回该应用下所有图片
	PictureId *uint64 `json:"PictureId,omitempty" name:"PictureId"`

	// 每页数量,不填时默认为10
	PageSize *uint64 `json:"PageSize,omitempty" name:"PageSize"`

	// 页码,不填时默认为1
	PageNo *uint64 `json:"PageNo,omitempty" name:"PageNo"`
}

func NewDescribePictureRequest

func NewDescribePictureRequest() (request *DescribePictureRequest)

func (*DescribePictureRequest) FromJsonString

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

func (r *DescribePictureRequest) ToJsonString() string

type DescribePictureResponse

type DescribePictureResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的图片记录数
		Total *uint64 `json:"Total,omitempty" name:"Total"`

		// 图片信息列表
		PictureInfo []*PictureInfo `json:"PictureInfo,omitempty" name:"PictureInfo"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribePictureResponse

func NewDescribePictureResponse() (response *DescribePictureResponse)

func (*DescribePictureResponse) FromJsonString

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

func (r *DescribePictureResponse) ToJsonString() string

type DescribeRecordStatisticRequest

type DescribeRecordStatisticRequest struct {
	*tchttp.BaseRequest

	// 查询开始日期,格式为YYYY-MM-DD。
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束日期,格式为YYYY-MM-DD。
	// 单次查询统计区间最多不能超过31天。
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`
}

func NewDescribeRecordStatisticRequest

func NewDescribeRecordStatisticRequest() (request *DescribeRecordStatisticRequest)

func (*DescribeRecordStatisticRequest) FromJsonString

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

func (r *DescribeRecordStatisticRequest) ToJsonString() string

type DescribeRecordStatisticResponse

type DescribeRecordStatisticResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 应用的用量信息数组。
		SdkAppIdUsages []*SdkAppIdRecordUsage `json:"SdkAppIdUsages,omitempty" name:"SdkAppIdUsages"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeRecordStatisticResponse

func NewDescribeRecordStatisticResponse() (response *DescribeRecordStatisticResponse)

func (*DescribeRecordStatisticResponse) FromJsonString

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

func (r *DescribeRecordStatisticResponse) ToJsonString() string

type DescribeRoomInformationRequest

type DescribeRoomInformationRequest struct {
	*tchttp.BaseRequest

	// 用户sdkappid
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 查询开始时间,14天内。本地unix时间戳(1588031999)
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间,本地unix时间戳(1588034999)
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`

	// 字符串房间号
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// 分页index,从0开始(PageNumber和PageSize 其中一个不填均默认返回10条数据)
	PageNumber *string `json:"PageNumber,omitempty" name:"PageNumber"`

	// 分页大小(PageNumber和PageSize 其中一个不填均默认返回10条数据,最大不超过100)
	PageSize *string `json:"PageSize,omitempty" name:"PageSize"`
}

func NewDescribeRoomInformationRequest

func NewDescribeRoomInformationRequest() (request *DescribeRoomInformationRequest)

func (*DescribeRoomInformationRequest) FromJsonString

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

func (r *DescribeRoomInformationRequest) ToJsonString() string

type DescribeRoomInformationResponse

type DescribeRoomInformationResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回当页数据总数
		Total *int64 `json:"Total,omitempty" name:"Total"`

		// 房间信息列表
		RoomList []*RoomState `json:"RoomList,omitempty" name:"RoomList"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeRoomInformationResponse

func NewDescribeRoomInformationResponse() (response *DescribeRoomInformationResponse)

func (*DescribeRoomInformationResponse) FromJsonString

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

func (r *DescribeRoomInformationResponse) ToJsonString() string

type DescribeTrtcMcuTranscodeTimeRequest

type DescribeTrtcMcuTranscodeTimeRequest struct {
	*tchttp.BaseRequest

	// 查询开始时间,格式为YYYY-MM-DD。
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间,格式为YYYY-MM-DD。
	// 单次查询统计区间最多不能超过31天。
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`
}

func NewDescribeTrtcMcuTranscodeTimeRequest

func NewDescribeTrtcMcuTranscodeTimeRequest() (request *DescribeTrtcMcuTranscodeTimeRequest)

func (*DescribeTrtcMcuTranscodeTimeRequest) FromJsonString

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

func (r *DescribeTrtcMcuTranscodeTimeRequest) ToJsonString() string

type DescribeTrtcMcuTranscodeTimeResponse

type DescribeTrtcMcuTranscodeTimeResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 应用的用量信息数组。
		Usages []*OneSdkAppIdTranscodeTimeUsagesInfo `json:"Usages,omitempty" name:"Usages"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeTrtcMcuTranscodeTimeResponse

func NewDescribeTrtcMcuTranscodeTimeResponse() (response *DescribeTrtcMcuTranscodeTimeResponse)

func (*DescribeTrtcMcuTranscodeTimeResponse) FromJsonString

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

func (r *DescribeTrtcMcuTranscodeTimeResponse) ToJsonString() string

type DescribeUserInformationRequest

type DescribeUserInformationRequest struct {
	*tchttp.BaseRequest

	// 通话 ID(唯一标识一次通话): sdkappid_roomgString(房间号_createTime(房间创建时间,unix时间戳,单位为s)例:1400353843_218695_1590065777。通过 DescribeRoomInformation(查询房间列表)接口获取(链接:https://cloud.tencent.com/document/product/647/44050
	CommId *string `json:"CommId,omitempty" name:"CommId"`

	// 查询开始时间,14天内。本地unix时间戳(1590065777)
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间,本地unix时间戳(1590065877)
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`

	// 用户SDKAppID(1400353843)
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 需查询的用户数组,不填默认返回6个用户,最多可填6个用户
	UserIds []*string `json:"UserIds,omitempty" name:"UserIds"`

	// 设置分页index,从0开始(PageNumber和PageSize 其中一个不填均默认返回6条数据)
	PageNumber *string `json:"PageNumber,omitempty" name:"PageNumber"`

	// 设置分页大小(PageNumber和PageSize 其中一个不填均默认返回6条数据,PageSize最大不超过100)
	PageSize *string `json:"PageSize,omitempty" name:"PageSize"`
}

func NewDescribeUserInformationRequest

func NewDescribeUserInformationRequest() (request *DescribeUserInformationRequest)

func (*DescribeUserInformationRequest) FromJsonString

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

func (r *DescribeUserInformationRequest) ToJsonString() string

type DescribeUserInformationResponse

type DescribeUserInformationResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的用户总条数
		Total *uint64 `json:"Total,omitempty" name:"Total"`

		// 用户信息列表
		// 注意:此字段可能返回 null,表示取不到有效值。
		UserList []*UserInformation `json:"UserList,omitempty" name:"UserList"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeUserInformationResponse

func NewDescribeUserInformationResponse() (response *DescribeUserInformationResponse)

func (*DescribeUserInformationResponse) FromJsonString

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

func (r *DescribeUserInformationResponse) ToJsonString() string

type DismissRoomByStrRoomIdRequest

type DismissRoomByStrRoomIdRequest struct {
	*tchttp.BaseRequest

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

	// 房间号。
	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 DismissRoomByStrRoomIdResponse

type DismissRoomByStrRoomIdResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 DismissRoomRequest

type DismissRoomRequest struct {
	*tchttp.BaseRequest

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

	// 房间号。
	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 DismissRoomResponse

type DismissRoomResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 EncodeParams

type EncodeParams struct {

	// 混流-输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000],单位是Hz。
	AudioSampleRate *uint64 `json:"AudioSampleRate,omitempty" name:"AudioSampleRate"`

	// 混流-输出流音频码率。取值范围[8,500],单位为kbps。
	AudioBitrate *uint64 `json:"AudioBitrate,omitempty" name:"AudioBitrate"`

	// 混流-输出流音频声道数,取值范围[1,2],1表示混流输出音频为单声道,2表示混流输出音频为双声道。
	AudioChannels *uint64 `json:"AudioChannels,omitempty" name:"AudioChannels"`

	// 混流-输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。
	VideoWidth *uint64 `json:"VideoWidth,omitempty" name:"VideoWidth"`

	// 混流-输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。
	VideoHeight *uint64 `json:"VideoHeight,omitempty" name:"VideoHeight"`

	// 混流-输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。
	VideoBitrate *uint64 `json:"VideoBitrate,omitempty" name:"VideoBitrate"`

	// 混流-输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。
	VideoFramerate *uint64 `json:"VideoFramerate,omitempty" name:"VideoFramerate"`

	// 混流-输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。
	VideoGop *uint64 `json:"VideoGop,omitempty" name:"VideoGop"`

	// 混流-输出流背景色,取值是十进制整数。常用的颜色有:
	// 红色:0xff0000,对应的十进制整数是16724736。
	// 黄色:0xffff00。对应的十进制整数是16776960。
	// 绿色:0x33cc00。对应的十进制整数是3394560。
	// 蓝色:0x0066ff。对应的十进制整数是26367。
	// 黑色:0x000000。对应的十进制整数是0。
	// 白色:0xFFFFFF。对应的十进制整数是16777215。
	// 灰色:0x999999。对应的十进制整数是10066329。
	BackgroundColor *uint64 `json:"BackgroundColor,omitempty" name:"BackgroundColor"`

	// 混流-输出流背景图片,取值为实时音视频控制台上传的图片ID。
	BackgroundImageId *uint64 `json:"BackgroundImageId,omitempty" name:"BackgroundImageId"`

	// 混流-输出流音频编码类型,取值范围[0,1, 2],0为LC-AAC,1为HE-AAC,2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时,只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]
	AudioCodec *uint64 `json:"AudioCodec,omitempty" name:"AudioCodec"`

	// 混流-输出流背景图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。BackgroundImageUrl和BackgroundImageId参数都填时,以BackgroundImageUrl为准。图片大小限制不超过2MB。
	BackgroundImageUrl *string `json:"BackgroundImageUrl,omitempty" name:"BackgroundImageUrl"`
}

type EventList

type EventList struct {

	// 数据内容
	Content []*EventMessage `json:"Content,omitempty" name:"Content"`

	// 发送端的userId
	PeerId *string `json:"PeerId,omitempty" name:"PeerId"`
}

type EventMessage

type EventMessage struct {

	// 视频流类型:
	// 0:与视频无关的事件;
	// 2:视频为大画面;
	// 3:视频为小画面;
	// 7:视频为旁路画面;
	Type *uint64 `json:"Type,omitempty" name:"Type"`

	// 事件上报的时间戳,unix时间(1589891188801ms)
	Time *uint64 `json:"Time,omitempty" name:"Time"`

	// 事件Id:分为sdk的事件和webrtc的事件,详情见:附录/事件 ID 映射表:https://cloud.tencent.com/document/product/647/44916
	EventId *uint64 `json:"EventId,omitempty" name:"EventId"`

	// 事件的第一个参数,如视频分辨率宽
	ParamOne *int64 `json:"ParamOne,omitempty" name:"ParamOne"`

	// 事件的第二个参数,如视频分辨率高
	ParamTwo *int64 `json:"ParamTwo,omitempty" name:"ParamTwo"`
}

type LayoutParams

type LayoutParams struct {

	// 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
	Template *uint64 `json:"Template,omitempty" name:"Template"`

	// 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
	MainVideoUserId *string `json:"MainVideoUserId,omitempty" name:"MainVideoUserId"`

	// 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
	MainVideoStreamType *uint64 `json:"MainVideoStreamType,omitempty" name:"MainVideoStreamType"`

	// 画中画模板中有效,代表小画面的布局参数。
	SmallVideoLayoutParams *SmallVideoLayoutParams `json:"SmallVideoLayoutParams,omitempty" name:"SmallVideoLayoutParams"`

	// 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
	MainVideoRightAlign *uint64 `json:"MainVideoRightAlign,omitempty" name:"MainVideoRightAlign"`

	// 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。
	MixVideoUids []*string `json:"MixVideoUids,omitempty" name:"MixVideoUids"`

	// 自定义模板中有效,指定用户视频在混合画面中的位置。
	PresetLayoutConfig []*PresetLayoutConfig `json:"PresetLayoutConfig,omitempty" name:"PresetLayoutConfig"`

	// 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
	PlaceHolderMode *uint64 `json:"PlaceHolderMode,omitempty" name:"PlaceHolderMode"`

	// 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
	PureAudioHoldPlaceMode *uint64 `json:"PureAudioHoldPlaceMode,omitempty" name:"PureAudioHoldPlaceMode"`

	// 水印参数。
	WaterMarkParams *WaterMarkParams `json:"WaterMarkParams,omitempty" name:"WaterMarkParams"`
}

type MeasureTrtcMcuExternalRequest added in v1.0.414

type MeasureTrtcMcuExternalRequest struct {
	*tchttp.BaseRequest

	// 查询开始时间,格式为YYYY-MM-DD。
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间,格式为YYYY-MM-DD。
	// 单次查询统计区间最多不能超过2天。
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`
}

func NewMeasureTrtcMcuExternalRequest added in v1.0.414

func NewMeasureTrtcMcuExternalRequest() (request *MeasureTrtcMcuExternalRequest)

func (*MeasureTrtcMcuExternalRequest) FromJsonString added in v1.0.414

func (r *MeasureTrtcMcuExternalRequest) 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 (*MeasureTrtcMcuExternalRequest) ToJsonString added in v1.0.414

func (r *MeasureTrtcMcuExternalRequest) ToJsonString() string

type MeasureTrtcMcuExternalResponse added in v1.0.414

type MeasureTrtcMcuExternalResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 应用的用量信息数组。
		// 注意:此字段可能返回 null,表示取不到有效值。
		Usages []*OneSdkAppIdTranscodeTimeUsagesNewInfo `json:"Usages,omitempty" name:"Usages"`

		// 用户计费类型
		// 注意:此字段可能返回 null,表示取不到有效值。
		Type *string `json:"Type,omitempty" name:"Type"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewMeasureTrtcMcuExternalResponse added in v1.0.414

func NewMeasureTrtcMcuExternalResponse() (response *MeasureTrtcMcuExternalResponse)

func (*MeasureTrtcMcuExternalResponse) FromJsonString added in v1.0.414

func (r *MeasureTrtcMcuExternalResponse) 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 (*MeasureTrtcMcuExternalResponse) ToJsonString added in v1.0.414

func (r *MeasureTrtcMcuExternalResponse) ToJsonString() string

type MixLayout added in v1.0.400

type MixLayout struct {

	// 画布上该画面左上角的 y 轴坐标,取值范围 [0, 1920],不能超过画布的高。
	Top *uint64 `json:"Top,omitempty" name:"Top"`

	// 画布上该画面左上角的 x 轴坐标,取值范围 [0, 1920],不能超过画布的宽。
	Left *uint64 `json:"Left,omitempty" name:"Left"`

	// 画布上该画面宽度的相对值,取值范围 [0, 1920],与Left相加不应超过画布的宽。
	Width *uint64 `json:"Width,omitempty" name:"Width"`

	// 画布上该画面高度的相对值,取值范围 [0, 1920],与Top相加不应超过画布的高。
	Height *uint64 `json:"Height,omitempty" name:"Height"`

	// 字符串内容为待显示在该画面的主播对应的UserId,如果不指定,会按照主播加入房间的顺序匹配。
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// 画布的透明度值,取值范围[0, 255]。0表示不透明,255表示全透明。默认值为0。
	Alpha *uint64 `json:"Alpha,omitempty" name:"Alpha"`

	// 0 :拉伸模式,这个模式下整个视频内容会全部显示,并填满子画面,在源视频和目的视频宽高比不一致的时候,画面不会缺少内容,但是画面可能产生形变;
	//
	// 1 :剪裁模式(默认),这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸,并填满子画面画布,在源视频和目的视频宽高比不一致的时候,画面保持不变形,但是会被剪裁;
	//
	// 2 :填黑模式,这个模式下会严格保持源视频的宽高比进行等比缩放,在源视频和目的视频宽高比不一致的时候,画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景;
	//
	// 3 :智能拉伸模式,这个模式类似剪裁模式,区别是在源视频和目的视频宽高比不一致的时候,限制了最大剪裁比例为画面的宽度或者高度的20%;
	RenderMode *uint64 `json:"RenderMode,omitempty" name:"RenderMode"`

	// 对应订阅流的主辅路标识:
	// 0:主流(默认);
	// 1:辅流;
	MediaId *uint64 `json:"MediaId,omitempty" name:"MediaId"`

	// 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。
	ImageLayer *uint64 `json:"ImageLayer,omitempty" name:"ImageLayer"`

	// 下载的url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。
	SubBackgroundImage *string `json:"SubBackgroundImage,omitempty" name:"SubBackgroundImage"`
}

type MixLayoutParams added in v1.0.400

type MixLayoutParams struct {

	// 布局模式:
	// 1:悬浮布局;
	// 2:屏幕分享布局;
	// 3:九宫格布局(默认);
	// 4:自定义布局;
	//
	// 悬浮布局:默认第一个进入房间的主播(也可以指定一个主播)的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列,显示为小画面,小画面悬浮于大画面之上。当画面数量小于等于17个时,每行4个(4 x 4排列)。当画面数量大于17个时,重新布局小画面为每行5个(5 x 5)排列。最多支持25个画面,如果用户只发送音频,仍然会占用画面位置。
	//
	// 屏幕分享布局:指定一个主播在屏幕左侧的大画面位置(如果不指定,那么大画面位置为背景色),其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候,右侧每列最多8人,最多占据两列。当画面数量多于17个的时候,超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面,如果主播只发送音频,仍然会占用画面位置。
	//
	// 九宫格布局:根据主播的数量自动调整每个画面的大小,每个主播的画面大小一致,最多支持25个画面。
	//
	// 自定义布局:根据需要在MixLayoutList内定制每个主播画面的布局。
	MixLayoutMode *uint64 `json:"MixLayoutMode,omitempty" name:"MixLayoutMode"`

	// 如果MixLayoutMode 选择为4自定义布局模式的话,设置此参数为每个主播所对应的布局画面的详细信息,最大不超过25个。
	MixLayoutList []*MixLayout `json:"MixLayoutList,omitempty" name:"MixLayoutList"`

	// 录制背景颜色,RGB的颜色表的16进制表示,每个颜色通过8bit长度标识,默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500,格式规范:‘#‘开头,后面跟固定RGB的颜色值
	BackGroundColor *string `json:"BackGroundColor,omitempty" name:"BackGroundColor"`

	// 在布局模式为1:悬浮布局和 2:屏幕分享布局时,设定为显示大视频画面的UserId。不填的话:悬浮布局默认是第一个进房间的主播,屏幕分享布局默认是背景色
	MaxResolutionUserId *string `json:"MaxResolutionUserId,omitempty" name:"MaxResolutionUserId"`

	// 主辅路标识,
	// 0:主流(默认);
	// 1:辅流(屏幕分享);
	// 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路,MixLayoutList内代表的是自定义用户的主辅路。
	MediaId *uint64 `json:"MediaId,omitempty" name:"MediaId"`

	// 下载的url地址, 只支持jpg, png,大小限制不超过5M。
	BackgroundImageUrl *string `json:"BackgroundImageUrl,omitempty" name:"BackgroundImageUrl"`

	// 设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
	PlaceHolderMode *uint64 `json:"PlaceHolderMode,omitempty" name:"PlaceHolderMode"`

	// 背景画面宽高比不一致的时候处理方案,与MixLayoufList定义的RenderMode一致。
	BackgroundImageRenderMode *uint64 `json:"BackgroundImageRenderMode,omitempty" name:"BackgroundImageRenderMode"`

	// 下载的url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。
	DefaultSubBackgroundImage *string `json:"DefaultSubBackgroundImage,omitempty" name:"DefaultSubBackgroundImage"`

	// 水印布局参数, 最多支持25个。
	WaterMarkList []*WaterMark `json:"WaterMarkList,omitempty" name:"WaterMarkList"`
}

type MixTranscodeParams added in v1.0.400

type MixTranscodeParams struct {

	// 录制视频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。
	VideoParams *VideoParams `json:"VideoParams,omitempty" name:"VideoParams"`

	// 录制音频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。
	AudioParams *AudioParams `json:"AudioParams,omitempty" name:"AudioParams"`
}

type ModifyCloudRecordingRequest added in v1.0.400

type ModifyCloudRecordingRequest struct {
	*tchttp.BaseRequest

	// TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 录制任务的唯一Id,在启动录制成功后会返回。
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// 需要更新的混流的布局参数。
	MixLayoutParams *MixLayoutParams `json:"MixLayoutParams,omitempty" name:"MixLayoutParams"`

	// 指定订阅流白名单或者黑名单。
	SubscribeStreamUserIds *SubscribeStreamUserIds `json:"SubscribeStreamUserIds,omitempty" name:"SubscribeStreamUserIds"`
}

func NewModifyCloudRecordingRequest added in v1.0.400

func NewModifyCloudRecordingRequest() (request *ModifyCloudRecordingRequest)

func (*ModifyCloudRecordingRequest) FromJsonString added in v1.0.400

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 added in v1.0.400

func (r *ModifyCloudRecordingRequest) ToJsonString() string

type ModifyCloudRecordingResponse added in v1.0.400

type ModifyCloudRecordingResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。
		TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewModifyCloudRecordingResponse added in v1.0.400

func NewModifyCloudRecordingResponse() (response *ModifyCloudRecordingResponse)

func (*ModifyCloudRecordingResponse) FromJsonString added in v1.0.400

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 added in v1.0.400

func (r *ModifyCloudRecordingResponse) ToJsonString() string

type ModifyPictureRequest

type ModifyPictureRequest struct {
	*tchttp.BaseRequest

	// 图片id
	PictureId *uint64 `json:"PictureId,omitempty" name:"PictureId"`

	// 应用id
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 图片长度
	Height *uint64 `json:"Height,omitempty" name:"Height"`

	// 图片宽度
	Width *uint64 `json:"Width,omitempty" name:"Width"`

	// 显示位置x轴方向
	XPosition *uint64 `json:"XPosition,omitempty" name:"XPosition"`

	// 显示位置y轴方向
	YPosition *uint64 `json:"YPosition,omitempty" name:"YPosition"`
}

func NewModifyPictureRequest

func NewModifyPictureRequest() (request *ModifyPictureRequest)

func (*ModifyPictureRequest) FromJsonString

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

func (r *ModifyPictureRequest) ToJsonString() string

type ModifyPictureResponse

type ModifyPictureResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewModifyPictureResponse

func NewModifyPictureResponse() (response *ModifyPictureResponse)

func (*ModifyPictureResponse) FromJsonString

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

func (r *ModifyPictureResponse) ToJsonString() string

type OneSdkAppIdTranscodeTimeUsagesInfo

type OneSdkAppIdTranscodeTimeUsagesInfo struct {

	// 旁路转码时长查询结果数组
	SdkAppIdTranscodeTimeUsages []*SdkAppIdTrtcMcuTranscodeTimeUsage `json:"SdkAppIdTranscodeTimeUsages,omitempty" name:"SdkAppIdTranscodeTimeUsages"`

	// 查询记录数量
	TotalNum *uint64 `json:"TotalNum,omitempty" name:"TotalNum"`

	// 所查询的应用ID,可能值为:1-应用的应用ID,2-total,显示为total则表示查询的是所有应用的用量合计值。
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`
}

type OneSdkAppIdTranscodeTimeUsagesNewInfo added in v1.0.418

type OneSdkAppIdTranscodeTimeUsagesNewInfo struct {

	// 旁路转码时长查询结果数组
	SdkAppIdTranscodeTimeUsages []*SdkAppIdTrtcMcuTranscodeTimeNewUsage `json:"SdkAppIdTranscodeTimeUsages,omitempty" name:"SdkAppIdTranscodeTimeUsages"`

	// 查询记录数量
	TotalNum *uint64 `json:"TotalNum,omitempty" name:"TotalNum"`

	// 所查询的应用ID,可能值为:1-应用的应用ID,2-total,显示为total则表示查询的是所有应用的用量合计值。
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`
}

type OutputParams

type OutputParams struct {

	// 直播流 ID,由用户自定义设置,该流 ID 不能与用户旁路的流 ID 相同。
	StreamId *string `json:"StreamId,omitempty" name:"StreamId"`

	// 取值范围[0,1], 填0:直播流为音视频(默认); 填1:直播流为纯音频
	PureAudioStream *uint64 `json:"PureAudioStream,omitempty" name:"PureAudioStream"`

	// 自定义录制文件名称前缀。请先在实时音视频控制台开通录制功能,https://cloud.tencent.com/document/product/647/50768
	RecordId *string `json:"RecordId,omitempty" name:"RecordId"`

	// 取值范围[0,1],填0无实际含义; 填1:指定录制文件格式为mp3。此参数不建议使用,建议在实时音视频控制台配置纯音频录制模板。
	RecordAudioOnly *uint64 `json:"RecordAudioOnly,omitempty" name:"RecordAudioOnly"`
}

type PictureInfo

type PictureInfo struct {

	// 图片长度
	Height *uint64 `json:"Height,omitempty" name:"Height"`

	// 图片宽度
	Width *uint64 `json:"Width,omitempty" name:"Width"`

	// 显示位置x轴方向
	XPosition *uint64 `json:"XPosition,omitempty" name:"XPosition"`

	// 显示位置y轴方向
	YPosition *uint64 `json:"YPosition,omitempty" name:"YPosition"`

	// 应用id
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 图片id
	PictureId *uint64 `json:"PictureId,omitempty" name:"PictureId"`
}

type PresetLayoutConfig

type PresetLayoutConfig struct {

	// 指定显示在该画面上的用户ID。如果不指定用户ID,会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// 当该画面指定用户时,代表用户的流类型。0为摄像头,1为屏幕分享。小画面为web用户时此值填0。
	StreamType *uint64 `json:"StreamType,omitempty" name:"StreamType"`

	// 该画面在输出时的宽度,单位为像素值,不填默认为0。
	ImageWidth *uint64 `json:"ImageWidth,omitempty" name:"ImageWidth"`

	// 该画面在输出时的高度,单位为像素值,不填默认为0。
	ImageHeight *uint64 `json:"ImageHeight,omitempty" name:"ImageHeight"`

	// 该画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
	LocationX *uint64 `json:"LocationX,omitempty" name:"LocationX"`

	// 该画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
	LocationY *uint64 `json:"LocationY,omitempty" name:"LocationY"`

	// 该画面在输出时的层级,不填默认为0。
	ZOrder *uint64 `json:"ZOrder,omitempty" name:"ZOrder"`

	// 该画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底。不填默认为0。
	RenderMode *uint64 `json:"RenderMode,omitempty" name:"RenderMode"`

	// 该当前位置用户混入的流类型:0为混入音视频,1为只混入视频,2为只混入音频。默认为0,建议配合指定用户ID使用。
	MixInputType *uint64 `json:"MixInputType,omitempty" name:"MixInputType"`

	// 占位图ID。启用占位图功能时,在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M,在实时音视频控制台上传并生成,https://cloud.tencent.com/document/product/647/50769
	PlaceImageId *uint64 `json:"PlaceImageId,omitempty" name:"PlaceImageId"`
}

type PublishCdnParams

type PublishCdnParams struct {

	// 腾讯云直播BizId。
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// 第三方CDN转推的目的地址,同时只支持转推一个第三方CDN地址。
	PublishCdnUrls []*string `json:"PublishCdnUrls,omitempty" name:"PublishCdnUrls"`
}

type QualityData

type QualityData struct {

	// 数据内容
	Content []*TimeValue `json:"Content,omitempty" name:"Content"`

	// 用户ID
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// 对端Id,为空时表示上行数据
	// 注意:此字段可能返回 null,表示取不到有效值。
	PeerId *string `json:"PeerId,omitempty" name:"PeerId"`

	// 数据类型
	DataType *string `json:"DataType,omitempty" name:"DataType"`
}

type RecordParams added in v1.0.400

type RecordParams struct {

	// 录制模式:
	// 1:单流录制,分别录制房间的订阅UserId的音频和视频,将录制文件(M3U8/TS)上传至云存储;
	// 2:混流录制,将房间内订阅UserId的音视频混录成一个音视频文件,将录制文件[M3U8/TS]上传至云存储;
	RecordMode *uint64 `json:"RecordMode,omitempty" name:"RecordMode"`

	// 房间内持续没有主播的状态超过MaxIdleTime的时长,自动停止录制,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。
	MaxIdleTime *uint64 `json:"MaxIdleTime,omitempty" name:"MaxIdleTime"`

	// 录制的媒体流类型:
	// 0:录制音频+视频流(默认);
	// 1:仅录制音频流;
	// 2:仅录制视频流,
	StreamType *uint64 `json:"StreamType,omitempty" name:"StreamType"`

	// 指定订阅流白名单或者黑名单。
	SubscribeStreamUserIds *SubscribeStreamUserIds `json:"SubscribeStreamUserIds,omitempty" name:"SubscribeStreamUserIds"`

	// 输出文件的格式。0:(默认)输出文件为hls格式。1:输出文件格式为hls+mp4(hls录制完成后转mp4文件)
	OutputFormat *uint64 `json:"OutputFormat,omitempty" name:"OutputFormat"`
}

type RecordUsage

type RecordUsage struct {

	// 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。
	TimeKey *string `json:"TimeKey,omitempty" name:"TimeKey"`

	// 视频时长-标清SD,单位:秒。
	Class1VideoTime *uint64 `json:"Class1VideoTime,omitempty" name:"Class1VideoTime"`

	// 视频时长-高清HD,单位:秒。
	Class2VideoTime *uint64 `json:"Class2VideoTime,omitempty" name:"Class2VideoTime"`

	// 视频时长-超清HD,单位:秒。
	Class3VideoTime *uint64 `json:"Class3VideoTime,omitempty" name:"Class3VideoTime"`

	// 语音时长,单位:秒。
	AudioTime *uint64 `json:"AudioTime,omitempty" name:"AudioTime"`
}

type RemoveUserByStrRoomIdRequest

type RemoveUserByStrRoomIdRequest struct {
	*tchttp.BaseRequest

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

	// 房间号。
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// 要移出的用户列表,最多10个。
	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 RemoveUserByStrRoomIdResponse

type RemoveUserByStrRoomIdResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 RemoveUserRequest

type RemoveUserRequest struct {
	*tchttp.BaseRequest

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

	// 房间号。
	RoomId *uint64 `json:"RoomId,omitempty" name:"RoomId"`

	// 要移出的用户列表,最多10个。
	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 RemoveUserResponse

type RemoveUserResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 RoomState

type RoomState struct {

	// 通话ID(唯一标识一次通话)
	CommId *string `json:"CommId,omitempty" name:"CommId"`

	// 房间号
	RoomString *string `json:"RoomString,omitempty" name:"RoomString"`

	// 房间创建时间
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// 房间销毁时间
	DestroyTime *uint64 `json:"DestroyTime,omitempty" name:"DestroyTime"`

	// 房间是否已经结束
	IsFinished *bool `json:"IsFinished,omitempty" name:"IsFinished"`

	// 房间创建者Id
	UserId *string `json:"UserId,omitempty" name:"UserId"`
}

type ScaleInfomation

type ScaleInfomation struct {

	// 每天开始的时间
	Time *uint64 `json:"Time,omitempty" name:"Time"`

	// 房间人数,用户重复进入同一个房间为1次
	// 注意:此字段可能返回 null,表示取不到有效值。
	UserNumber *uint64 `json:"UserNumber,omitempty" name:"UserNumber"`

	// 房间人次,用户每次进入房间为一次
	// 注意:此字段可能返回 null,表示取不到有效值。
	UserCount *uint64 `json:"UserCount,omitempty" name:"UserCount"`

	// sdkappid下一天内的房间数
	// 注意:此字段可能返回 null,表示取不到有效值。
	RoomNumbers *uint64 `json:"RoomNumbers,omitempty" name:"RoomNumbers"`
}

type SdkAppIdNewTrtcTimeUsage added in v1.0.414

type SdkAppIdNewTrtcTimeUsage struct {

	// SdkAppId的值。
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 统计的时间点数据。
	TrtcTimeUsages []*TrtcTimeNewUsage `json:"TrtcTimeUsages,omitempty" name:"TrtcTimeUsages"`

	// 统计的麦下用量的时间点数据。
	AudienceTrtcTimeUsages []*TrtcTimeNewUsage `json:"AudienceTrtcTimeUsages,omitempty" name:"AudienceTrtcTimeUsages"`
}

type SdkAppIdRecordUsage

type SdkAppIdRecordUsage struct {

	// SdkAppId的值。
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 统计的时间点数据。
	Usages []*RecordUsage `json:"Usages,omitempty" name:"Usages"`
}

type SdkAppIdTrtcMcuTranscodeTimeNewUsage added in v1.0.418

type SdkAppIdTrtcMcuTranscodeTimeNewUsage struct {

	// 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。
	TimeKey *string `json:"TimeKey,omitempty" name:"TimeKey"`

	// 语音时长,单位:秒。
	AudioTime *uint64 `json:"AudioTime,omitempty" name:"AudioTime"`

	// 视频时长-标清SD,单位:秒。
	VideoTimeH264SD *uint64 `json:"VideoTimeH264SD,omitempty" name:"VideoTimeH264SD"`

	// 视频时长-高清HD,单位:秒。
	VideoTimeH264HD *uint64 `json:"VideoTimeH264HD,omitempty" name:"VideoTimeH264HD"`

	// 视频时长-全高清FHD,单位:秒。
	VideoTimeH264FHD *uint64 `json:"VideoTimeH264FHD,omitempty" name:"VideoTimeH264FHD"`

	// 视频时长-带宽,单位:mbps。
	Flux *float64 `json:"Flux,omitempty" name:"Flux"`

	// 视频时长-标清2K,单位:秒。
	VideoTimeH2642K *uint64 `json:"VideoTimeH2642K,omitempty" name:"VideoTimeH2642K"`

	// 视频时长-标清4K,单位:秒。
	VideoTimeH2644K *uint64 `json:"VideoTimeH2644K,omitempty" name:"VideoTimeH2644K"`

	// 视频时长-标清265SD,单位:秒。
	VideoTimeH265SD *uint64 `json:"VideoTimeH265SD,omitempty" name:"VideoTimeH265SD"`

	// 视频时长-高清265HD,单位:秒。
	VideoTimeH265HD *uint64 `json:"VideoTimeH265HD,omitempty" name:"VideoTimeH265HD"`

	// 视频时长-全高清265FHD,单位:秒。
	VideoTimeH265FHD *uint64 `json:"VideoTimeH265FHD,omitempty" name:"VideoTimeH265FHD"`

	// 视频时长-标清2652K,单位:秒。
	VideoTimeH2652K *uint64 `json:"VideoTimeH2652K,omitempty" name:"VideoTimeH2652K"`

	// 视频时长-标清265 4K,单位:秒。
	VideoTimeH2654K *uint64 `json:"VideoTimeH2654K,omitempty" name:"VideoTimeH2654K"`
}

type SdkAppIdTrtcMcuTranscodeTimeUsage

type SdkAppIdTrtcMcuTranscodeTimeUsage struct {

	// 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。
	TimeKey *string `json:"TimeKey,omitempty" name:"TimeKey"`

	// 语音时长,单位:秒。
	AudioTime *uint64 `json:"AudioTime,omitempty" name:"AudioTime"`

	// 视频时长-标清SD,单位:秒。
	VideoTimeSd *uint64 `json:"VideoTimeSd,omitempty" name:"VideoTimeSd"`

	// 视频时长-高清HD,单位:秒。
	VideoTimeHd *uint64 `json:"VideoTimeHd,omitempty" name:"VideoTimeHd"`

	// 视频时长-全高清FHD,单位:秒。
	VideoTimeFhd *uint64 `json:"VideoTimeFhd,omitempty" name:"VideoTimeFhd"`
}

type SmallVideoLayoutParams

type SmallVideoLayoutParams struct {

	// 代表小画面对应的用户ID。
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// 代表小画面对应的流类型,0为摄像头,1为屏幕分享。小画面为web用户时此值填0。
	StreamType *uint64 `json:"StreamType,omitempty" name:"StreamType"`

	// 小画面在输出时的宽度,单位为像素值,不填默认为0。
	ImageWidth *uint64 `json:"ImageWidth,omitempty" name:"ImageWidth"`

	// 小画面在输出时的高度,单位为像素值,不填默认为0。
	ImageHeight *uint64 `json:"ImageHeight,omitempty" name:"ImageHeight"`

	// 小画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
	LocationX *uint64 `json:"LocationX,omitempty" name:"LocationX"`

	// 小画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
	LocationY *uint64 `json:"LocationY,omitempty" name:"LocationY"`
}

type StartMCUMixTranscodeByStrRoomIdRequest

type StartMCUMixTranscodeByStrRoomIdRequest struct {
	*tchttp.BaseRequest

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

	// 字符串房间号。
	StrRoomId *string `json:"StrRoomId,omitempty" name:"StrRoomId"`

	// 混流输出控制参数。
	OutputParams *OutputParams `json:"OutputParams,omitempty" name:"OutputParams"`

	// 混流输出编码参数。
	EncodeParams *EncodeParams `json:"EncodeParams,omitempty" name:"EncodeParams"`

	// 混流输出布局参数。
	LayoutParams *LayoutParams `json:"LayoutParams,omitempty" name:"LayoutParams"`

	// 第三方CDN转推参数。
	PublishCdnParams *PublishCdnParams `json:"PublishCdnParams,omitempty" name:"PublishCdnParams"`
}

func NewStartMCUMixTranscodeByStrRoomIdRequest

func NewStartMCUMixTranscodeByStrRoomIdRequest() (request *StartMCUMixTranscodeByStrRoomIdRequest)

func (*StartMCUMixTranscodeByStrRoomIdRequest) FromJsonString

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

func (*StartMCUMixTranscodeByStrRoomIdRequest) ToJsonString

type StartMCUMixTranscodeByStrRoomIdResponse

type StartMCUMixTranscodeByStrRoomIdResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewStartMCUMixTranscodeByStrRoomIdResponse

func NewStartMCUMixTranscodeByStrRoomIdResponse() (response *StartMCUMixTranscodeByStrRoomIdResponse)

func (*StartMCUMixTranscodeByStrRoomIdResponse) FromJsonString

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

func (*StartMCUMixTranscodeByStrRoomIdResponse) ToJsonString

type StartMCUMixTranscodeRequest

type StartMCUMixTranscodeRequest struct {
	*tchttp.BaseRequest

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

	// 房间号。
	RoomId *uint64 `json:"RoomId,omitempty" name:"RoomId"`

	// 混流输出控制参数。
	OutputParams *OutputParams `json:"OutputParams,omitempty" name:"OutputParams"`

	// 混流输出编码参数。
	EncodeParams *EncodeParams `json:"EncodeParams,omitempty" name:"EncodeParams"`

	// 混流输出布局参数。
	LayoutParams *LayoutParams `json:"LayoutParams,omitempty" name:"LayoutParams"`

	// 第三方CDN转推参数。
	PublishCdnParams *PublishCdnParams `json:"PublishCdnParams,omitempty" name:"PublishCdnParams"`
}

func NewStartMCUMixTranscodeRequest

func NewStartMCUMixTranscodeRequest() (request *StartMCUMixTranscodeRequest)

func (*StartMCUMixTranscodeRequest) FromJsonString

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

func (r *StartMCUMixTranscodeRequest) ToJsonString() string

type StartMCUMixTranscodeResponse

type StartMCUMixTranscodeResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewStartMCUMixTranscodeResponse

func NewStartMCUMixTranscodeResponse() (response *StartMCUMixTranscodeResponse)

func (*StartMCUMixTranscodeResponse) FromJsonString

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

func (r *StartMCUMixTranscodeResponse) ToJsonString() string

type StopMCUMixTranscodeByStrRoomIdRequest

type StopMCUMixTranscodeByStrRoomIdRequest struct {
	*tchttp.BaseRequest

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

	// 字符串房间号。
	StrRoomId *string `json:"StrRoomId,omitempty" name:"StrRoomId"`
}

func NewStopMCUMixTranscodeByStrRoomIdRequest

func NewStopMCUMixTranscodeByStrRoomIdRequest() (request *StopMCUMixTranscodeByStrRoomIdRequest)

func (*StopMCUMixTranscodeByStrRoomIdRequest) FromJsonString

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

type StopMCUMixTranscodeByStrRoomIdResponse

type StopMCUMixTranscodeByStrRoomIdResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewStopMCUMixTranscodeByStrRoomIdResponse

func NewStopMCUMixTranscodeByStrRoomIdResponse() (response *StopMCUMixTranscodeByStrRoomIdResponse)

func (*StopMCUMixTranscodeByStrRoomIdResponse) FromJsonString

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

func (*StopMCUMixTranscodeByStrRoomIdResponse) ToJsonString

type StopMCUMixTranscodeRequest

type StopMCUMixTranscodeRequest struct {
	*tchttp.BaseRequest

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

	// 房间号。
	RoomId *uint64 `json:"RoomId,omitempty" name:"RoomId"`
}

func NewStopMCUMixTranscodeRequest

func NewStopMCUMixTranscodeRequest() (request *StopMCUMixTranscodeRequest)

func (*StopMCUMixTranscodeRequest) FromJsonString

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

func (r *StopMCUMixTranscodeRequest) ToJsonString() string

type StopMCUMixTranscodeResponse

type StopMCUMixTranscodeResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewStopMCUMixTranscodeResponse

func NewStopMCUMixTranscodeResponse() (response *StopMCUMixTranscodeResponse)

func (*StopMCUMixTranscodeResponse) FromJsonString

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

func (r *StopMCUMixTranscodeResponse) ToJsonString() string

type StorageFile added in v1.0.400

type StorageFile struct {

	// 录制文件对应的UserId,如果是混流的话的这里返回的是空串。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// 录制索引文件名。
	FileName *string `json:"FileName,omitempty" name:"FileName"`

	// 录制文件流信息。
	// video:视频录制文件
	// audio:音频录制文件
	// audio_video:音视频录制文件
	// 注意:此字段可能返回 null,表示取不到有效值。
	TrackType *string `json:"TrackType,omitempty" name:"TrackType"`

	// 录制文件开始Unix时间戳。
	BeginTimeStamp *uint64 `json:"BeginTimeStamp,omitempty" name:"BeginTimeStamp"`
}

type StorageParams added in v1.0.400

type StorageParams struct {

	// 第三方云存储的账号信息。
	CloudStorage *CloudStorage `json:"CloudStorage,omitempty" name:"CloudStorage"`

	// 第三方云点播的账号信息。
	CloudVod *CloudVod `json:"CloudVod,omitempty" name:"CloudVod"`
}

type SubscribeStreamUserIds added in v1.0.400

type SubscribeStreamUserIds struct {

	// 订阅音频流白名单,指定订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的音频流;["1.*$"], 代表订阅UserId前缀为1的音频流。默认不填订阅房间内所有的音频流,订阅列表用户数不超过32。
	SubscribeAudioUserIds []*string `json:"SubscribeAudioUserIds,omitempty" name:"SubscribeAudioUserIds"`

	// 订阅音频流黑名单,指定不订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的音频流;["1.*$"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流,订阅列表用户数不超过32。
	UnSubscribeAudioUserIds []*string `json:"UnSubscribeAudioUserIds,omitempty" name:"UnSubscribeAudioUserIds"`

	// 订阅视频流白名单,指定订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表订阅UserId  1,2,3的视频流;["1.*$"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
	SubscribeVideoUserIds []*string `json:"SubscribeVideoUserIds,omitempty" name:"SubscribeVideoUserIds"`

	// 订阅视频流黑名单,指定不订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表不订阅UserId  1,2,3的视频流;["1.*$"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
	UnSubscribeVideoUserIds []*string `json:"UnSubscribeVideoUserIds,omitempty" name:"UnSubscribeVideoUserIds"`
}

type TencentVod added in v1.0.400

type TencentVod struct {

	// 媒体后续任务处理操作,即完成媒体上传后,可自动发起任务流操作。参数值为任务流模板名,云点播支持 创建任务流模板 并为模板命名。
	Procedure *string `json:"Procedure,omitempty" name:"Procedure"`

	// 媒体文件过期时间,为当前时间的绝对过期时间;保存一天,就填"86400",永久保存就填"0",默认永久保存。
	ExpireTime *uint64 `json:"ExpireTime,omitempty" name:"ExpireTime"`

	// 指定上传园区,仅适用于对上传地域有特殊需求的用户。
	StorageRegion *string `json:"StorageRegion,omitempty" name:"StorageRegion"`

	// 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
	// 默认值:0,表示其他分类。
	ClassId *uint64 `json:"ClassId,omitempty" name:"ClassId"`

	// 点播 子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
	SubAppId *uint64 `json:"SubAppId,omitempty" name:"SubAppId"`

	// 任务流上下文,任务完成回调时透传。
	SessionContext *string `json:"SessionContext,omitempty" name:"SessionContext"`

	// 上传上下文,上传完成回调时透传。
	SourceContext *string `json:"SourceContext,omitempty" name:"SourceContext"`
}

type TimeValue

type TimeValue struct {

	// 时间,unix时间戳(1590065877s)
	Time *uint64 `json:"Time,omitempty" name:"Time"`

	// 当前时间返回参数取值,如(bigvCapFps在1590065877取值为0,则Value:0 )
	Value *float64 `json:"Value,omitempty" name:"Value"`
}

type TrtcTimeNewUsage added in v1.0.414

type TrtcTimeNewUsage struct {

	// 时间点。
	TimeKey *string `json:"TimeKey,omitempty" name:"TimeKey"`

	// 通话人数。仅供参考。在线人数以仪表盘查询结果为准。
	VoiceUserNum *uint64 `json:"VoiceUserNum,omitempty" name:"VoiceUserNum"`

	// 音视频通话时长。单位:秒。
	VideoTime *uint64 `json:"VideoTime,omitempty" name:"VideoTime"`

	// 标清视频通话时长。单位:秒。
	Class1VideoTime *uint64 `json:"Class1VideoTime,omitempty" name:"Class1VideoTime"`

	// 高清视频通话时长。单位:秒。
	Class2VideoTime *uint64 `json:"Class2VideoTime,omitempty" name:"Class2VideoTime"`

	// 超高清视频通话时长。单位:秒。
	Class3VideoTime *uint64 `json:"Class3VideoTime,omitempty" name:"Class3VideoTime"`

	// 音频通话时长。单位:秒。
	AudioTime *uint64 `json:"AudioTime,omitempty" name:"AudioTime"`

	// 带宽。单位:Mbps。
	Bandwidth *float64 `json:"Bandwidth,omitempty" name:"Bandwidth"`

	// 2k视频通话时长。单位:秒。
	Video2KTime *uint64 `json:"Video2KTime,omitempty" name:"Video2KTime"`

	// 4k视频通话时长。单位:秒。
	Video4KTime *uint64 `json:"Video4KTime,omitempty" name:"Video4KTime"`
}

type UserInformation

type UserInformation struct {

	// 房间号
	RoomStr *string `json:"RoomStr,omitempty" name:"RoomStr"`

	// 用户Id
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// 用户进房时间
	JoinTs *uint64 `json:"JoinTs,omitempty" name:"JoinTs"`

	// 用户退房时间,用户没有退房则返回当前时间
	LeaveTs *uint64 `json:"LeaveTs,omitempty" name:"LeaveTs"`

	// 终端类型
	DeviceType *string `json:"DeviceType,omitempty" name:"DeviceType"`

	// Sdk版本号
	SdkVersion *string `json:"SdkVersion,omitempty" name:"SdkVersion"`

	// 客户端IP地址
	ClientIp *string `json:"ClientIp,omitempty" name:"ClientIp"`

	// 判断用户是否已经离开房间
	Finished *bool `json:"Finished,omitempty" name:"Finished"`
}

type VideoParams added in v1.0.400

type VideoParams struct {

	// 视频的宽度值,单位为像素,默认值360。不能超过1920,与height的乘积不能超过1920*1080。
	Width *uint64 `json:"Width,omitempty" name:"Width"`

	// 视频的高度值,单位为像素,默认值640。不能超过1920,与width的乘积不能超过1920*1080。
	Height *uint64 `json:"Height,omitempty" name:"Height"`

	// 视频的帧率,范围[1, 60],默认15。
	Fps *uint64 `json:"Fps,omitempty" name:"Fps"`

	// 视频的码率,单位是bps,范围[64000, 8192000],默认550000bps。
	BitRate *uint64 `json:"BitRate,omitempty" name:"BitRate"`

	// 视频关键帧时间间隔,单位秒,默认值10秒。
	Gop *uint64 `json:"Gop,omitempty" name:"Gop"`
}

type WaterMark added in v1.0.400

type WaterMark struct {

	// 水印类型,0为图片(默认),1为文字(暂不支持)。
	WaterMarkType *uint64 `json:"WaterMarkType,omitempty" name:"WaterMarkType"`

	// 水印为图片时的参数列表,水印为图片时校验必填。
	WaterMarkImage *WaterMarkImage `json:"WaterMarkImage,omitempty" name:"WaterMarkImage"`
}

type WaterMarkImage added in v1.0.400

type WaterMarkImage struct {

	// 下载的url地址, 只支持jpg, png,大小限制不超过5M。
	WaterMarkUrl *string `json:"WaterMarkUrl,omitempty" name:"WaterMarkUrl"`

	// 画布上该画面左上角的 y 轴坐标,取值范围 [0, 2560],不能超过画布的高。
	Top *uint64 `json:"Top,omitempty" name:"Top"`

	// 画布上该画面左上角的 x 轴坐标,取值范围 [0, 2560],不能超过画布的宽。
	Left *uint64 `json:"Left,omitempty" name:"Left"`

	// 画布上该画面宽度的相对值,取值范围 [0, 2560],与Left相加不应超过画布的宽。
	Width *uint64 `json:"Width,omitempty" name:"Width"`

	// 画布上该画面高度的相对值,取值范围 [0, 2560],与Top相加不应超过画布的高。
	Height *uint64 `json:"Height,omitempty" name:"Height"`
}

type WaterMarkParams

type WaterMarkParams struct {

	// 混流-水印图片ID。取值为实时音视频控制台上传的图片ID。
	WaterMarkId *uint64 `json:"WaterMarkId,omitempty" name:"WaterMarkId"`

	// 混流-水印宽。单位为像素值。水印宽+X偏移不能超过整个画布宽。
	WaterMarkWidth *uint64 `json:"WaterMarkWidth,omitempty" name:"WaterMarkWidth"`

	// 混流-水印高。单位为像素值。水印高+Y偏移不能超过整个画布高。
	WaterMarkHeight *uint64 `json:"WaterMarkHeight,omitempty" name:"WaterMarkHeight"`

	// 水印在输出时的X偏移。单位为像素值。水印宽+X偏移不能超过整个画布宽。
	LocationX *uint64 `json:"LocationX,omitempty" name:"LocationX"`

	// 水印在输出时的Y偏移。单位为像素值。水印高+Y偏移不能超过整个画布高。
	LocationY *uint64 `json:"LocationY,omitempty" name:"LocationY"`

	// 混流-水印图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。WaterMarkUrl和WaterMarkId参数都填时,以WaterMarkUrl为准。图片大小限制不超过2MB。
	WaterMarkUrl *string `json:"WaterMarkUrl,omitempty" name:"WaterMarkUrl"`
}

Jump to

Keyboard shortcuts

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