Documentation ¶
Index ¶
- Constants
- type AbnormalEvent
- type AbnormalExperience
- type AgentParams
- type AudioEncode
- type AudioEncodeParams
- type AudioParams
- type Client
- func (c *Client) CreateCloudRecording(request *CreateCloudRecordingRequest) (response *CreateCloudRecordingResponse, err error)
- func (c *Client) CreateCloudRecordingWithContext(ctx context.Context, request *CreateCloudRecordingRequest) (response *CreateCloudRecordingResponse, err error)
- func (c *Client) CreatePicture(request *CreatePictureRequest) (response *CreatePictureResponse, err error)
- func (c *Client) CreatePictureWithContext(ctx context.Context, request *CreatePictureRequest) (response *CreatePictureResponse, err error)
- func (c *Client) DeleteCloudRecording(request *DeleteCloudRecordingRequest) (response *DeleteCloudRecordingResponse, err error)
- func (c *Client) DeleteCloudRecordingWithContext(ctx context.Context, request *DeleteCloudRecordingRequest) (response *DeleteCloudRecordingResponse, err error)
- func (c *Client) DeletePicture(request *DeletePictureRequest) (response *DeletePictureResponse, err error)
- func (c *Client) DeletePictureWithContext(ctx context.Context, request *DeletePictureRequest) (response *DeletePictureResponse, err error)
- func (c *Client) DescribeAITranscription(request *DescribeAITranscriptionRequest) (response *DescribeAITranscriptionResponse, err error)
- func (c *Client) DescribeAITranscriptionWithContext(ctx context.Context, request *DescribeAITranscriptionRequest) (response *DescribeAITranscriptionResponse, err error)
- func (c *Client) DescribeCallDetailInfo(request *DescribeCallDetailInfoRequest) (response *DescribeCallDetailInfoResponse, err error)
- func (c *Client) DescribeCallDetailInfoWithContext(ctx context.Context, request *DescribeCallDetailInfoRequest) (response *DescribeCallDetailInfoResponse, err error)
- func (c *Client) DescribeCloudRecording(request *DescribeCloudRecordingRequest) (response *DescribeCloudRecordingResponse, err error)
- func (c *Client) DescribeCloudRecordingWithContext(ctx context.Context, request *DescribeCloudRecordingRequest) (response *DescribeCloudRecordingResponse, err error)
- func (c *Client) DescribeMixTranscodingUsage(request *DescribeMixTranscodingUsageRequest) (response *DescribeMixTranscodingUsageResponse, err error)
- func (c *Client) DescribeMixTranscodingUsageWithContext(ctx context.Context, request *DescribeMixTranscodingUsageRequest) (response *DescribeMixTranscodingUsageResponse, err error)
- func (c *Client) DescribePicture(request *DescribePictureRequest) (response *DescribePictureResponse, err error)
- func (c *Client) DescribePictureWithContext(ctx context.Context, request *DescribePictureRequest) (response *DescribePictureResponse, err error)
- func (c *Client) DescribeRecordStatistic(request *DescribeRecordStatisticRequest) (response *DescribeRecordStatisticResponse, err error)
- func (c *Client) DescribeRecordStatisticWithContext(ctx context.Context, request *DescribeRecordStatisticRequest) (response *DescribeRecordStatisticResponse, err error)
- func (c *Client) DescribeRecordingUsage(request *DescribeRecordingUsageRequest) (response *DescribeRecordingUsageResponse, err error)
- func (c *Client) DescribeRecordingUsageWithContext(ctx context.Context, request *DescribeRecordingUsageRequest) (response *DescribeRecordingUsageResponse, err error)
- func (c *Client) DescribeRelayUsage(request *DescribeRelayUsageRequest) (response *DescribeRelayUsageResponse, err error)
- func (c *Client) DescribeRelayUsageWithContext(ctx context.Context, request *DescribeRelayUsageRequest) (response *DescribeRelayUsageResponse, err error)
- func (c *Client) DescribeRoomInfo(request *DescribeRoomInfoRequest) (response *DescribeRoomInfoResponse, err error)
- func (c *Client) DescribeRoomInfoWithContext(ctx context.Context, request *DescribeRoomInfoRequest) (response *DescribeRoomInfoResponse, err error)
- func (c *Client) DescribeScaleInfo(request *DescribeScaleInfoRequest) (response *DescribeScaleInfoResponse, err error)
- func (c *Client) DescribeScaleInfoWithContext(ctx context.Context, request *DescribeScaleInfoRequest) (response *DescribeScaleInfoResponse, err error)
- func (c *Client) DescribeStreamIngest(request *DescribeStreamIngestRequest) (response *DescribeStreamIngestResponse, err error)
- func (c *Client) DescribeStreamIngestWithContext(ctx context.Context, request *DescribeStreamIngestRequest) (response *DescribeStreamIngestResponse, err error)
- func (c *Client) DescribeTRTCMarketQualityData(request *DescribeTRTCMarketQualityDataRequest) (response *DescribeTRTCMarketQualityDataResponse, err error)
- func (c *Client) DescribeTRTCMarketQualityDataWithContext(ctx context.Context, request *DescribeTRTCMarketQualityDataRequest) (response *DescribeTRTCMarketQualityDataResponse, err error)
- func (c *Client) DescribeTRTCMarketQualityMetricData(request *DescribeTRTCMarketQualityMetricDataRequest) (response *DescribeTRTCMarketQualityMetricDataResponse, err error)
- func (c *Client) DescribeTRTCMarketQualityMetricDataWithContext(ctx context.Context, request *DescribeTRTCMarketQualityMetricDataRequest) (response *DescribeTRTCMarketQualityMetricDataResponse, err error)
- func (c *Client) DescribeTRTCMarketScaleData(request *DescribeTRTCMarketScaleDataRequest) (response *DescribeTRTCMarketScaleDataResponse, err error)
- func (c *Client) DescribeTRTCMarketScaleDataWithContext(ctx context.Context, request *DescribeTRTCMarketScaleDataRequest) (response *DescribeTRTCMarketScaleDataResponse, err error)
- func (c *Client) DescribeTRTCMarketScaleMetricData(request *DescribeTRTCMarketScaleMetricDataRequest) (response *DescribeTRTCMarketScaleMetricDataResponse, err error)
- func (c *Client) DescribeTRTCMarketScaleMetricDataWithContext(ctx context.Context, request *DescribeTRTCMarketScaleMetricDataRequest) (response *DescribeTRTCMarketScaleMetricDataResponse, err error)
- func (c *Client) DescribeTRTCRealTimeQualityData(request *DescribeTRTCRealTimeQualityDataRequest) (response *DescribeTRTCRealTimeQualityDataResponse, err error)
- func (c *Client) DescribeTRTCRealTimeQualityDataWithContext(ctx context.Context, request *DescribeTRTCRealTimeQualityDataRequest) (response *DescribeTRTCRealTimeQualityDataResponse, err error)
- func (c *Client) DescribeTRTCRealTimeQualityMetricData(request *DescribeTRTCRealTimeQualityMetricDataRequest) (response *DescribeTRTCRealTimeQualityMetricDataResponse, err error)
- func (c *Client) DescribeTRTCRealTimeQualityMetricDataWithContext(ctx context.Context, request *DescribeTRTCRealTimeQualityMetricDataRequest) (response *DescribeTRTCRealTimeQualityMetricDataResponse, err error)
- func (c *Client) DescribeTRTCRealTimeScaleData(request *DescribeTRTCRealTimeScaleDataRequest) (response *DescribeTRTCRealTimeScaleDataResponse, err error)
- func (c *Client) DescribeTRTCRealTimeScaleDataWithContext(ctx context.Context, request *DescribeTRTCRealTimeScaleDataRequest) (response *DescribeTRTCRealTimeScaleDataResponse, err error)
- func (c *Client) DescribeTRTCRealTimeScaleMetricData(request *DescribeTRTCRealTimeScaleMetricDataRequest) (response *DescribeTRTCRealTimeScaleMetricDataResponse, err error)
- func (c *Client) DescribeTRTCRealTimeScaleMetricDataWithContext(ctx context.Context, request *DescribeTRTCRealTimeScaleMetricDataRequest) (response *DescribeTRTCRealTimeScaleMetricDataResponse, err error)
- func (c *Client) DescribeTrtcMcuTranscodeTime(request *DescribeTrtcMcuTranscodeTimeRequest) (response *DescribeTrtcMcuTranscodeTimeResponse, err error)
- func (c *Client) DescribeTrtcMcuTranscodeTimeWithContext(ctx context.Context, request *DescribeTrtcMcuTranscodeTimeRequest) (response *DescribeTrtcMcuTranscodeTimeResponse, err error)
- func (c *Client) DescribeTrtcRoomUsage(request *DescribeTrtcRoomUsageRequest) (response *DescribeTrtcRoomUsageResponse, err error)
- func (c *Client) DescribeTrtcRoomUsageWithContext(ctx context.Context, request *DescribeTrtcRoomUsageRequest) (response *DescribeTrtcRoomUsageResponse, err error)
- func (c *Client) DescribeTrtcUsage(request *DescribeTrtcUsageRequest) (response *DescribeTrtcUsageResponse, err error)
- func (c *Client) DescribeTrtcUsageWithContext(ctx context.Context, request *DescribeTrtcUsageRequest) (response *DescribeTrtcUsageResponse, err error)
- func (c *Client) DescribeUnusualEvent(request *DescribeUnusualEventRequest) (response *DescribeUnusualEventResponse, err error)
- func (c *Client) DescribeUnusualEventWithContext(ctx context.Context, request *DescribeUnusualEventRequest) (response *DescribeUnusualEventResponse, err error)
- func (c *Client) DescribeUserEvent(request *DescribeUserEventRequest) (response *DescribeUserEventResponse, err error)
- func (c *Client) DescribeUserEventWithContext(ctx context.Context, request *DescribeUserEventRequest) (response *DescribeUserEventResponse, err error)
- func (c *Client) DescribeUserInfo(request *DescribeUserInfoRequest) (response *DescribeUserInfoResponse, err error)
- func (c *Client) DescribeUserInfoWithContext(ctx context.Context, request *DescribeUserInfoRequest) (response *DescribeUserInfoResponse, err error)
- func (c *Client) DescribeWebRecord(request *DescribeWebRecordRequest) (response *DescribeWebRecordResponse, err error)
- func (c *Client) DescribeWebRecordWithContext(ctx context.Context, request *DescribeWebRecordRequest) (response *DescribeWebRecordResponse, err error)
- func (c *Client) DismissRoom(request *DismissRoomRequest) (response *DismissRoomResponse, err error)
- func (c *Client) DismissRoomByStrRoomId(request *DismissRoomByStrRoomIdRequest) (response *DismissRoomByStrRoomIdResponse, err error)
- func (c *Client) DismissRoomByStrRoomIdWithContext(ctx context.Context, request *DismissRoomByStrRoomIdRequest) (response *DismissRoomByStrRoomIdResponse, err error)
- func (c *Client) DismissRoomWithContext(ctx context.Context, request *DismissRoomRequest) (response *DismissRoomResponse, err error)
- func (c *Client) ModifyCloudRecording(request *ModifyCloudRecordingRequest) (response *ModifyCloudRecordingResponse, err error)
- func (c *Client) ModifyCloudRecordingWithContext(ctx context.Context, request *ModifyCloudRecordingRequest) (response *ModifyCloudRecordingResponse, err error)
- func (c *Client) ModifyPicture(request *ModifyPictureRequest) (response *ModifyPictureResponse, err error)
- func (c *Client) ModifyPictureWithContext(ctx context.Context, request *ModifyPictureRequest) (response *ModifyPictureResponse, err error)
- func (c *Client) RemoveUser(request *RemoveUserRequest) (response *RemoveUserResponse, err error)
- func (c *Client) RemoveUserByStrRoomId(request *RemoveUserByStrRoomIdRequest) (response *RemoveUserByStrRoomIdResponse, err error)
- func (c *Client) RemoveUserByStrRoomIdWithContext(ctx context.Context, request *RemoveUserByStrRoomIdRequest) (response *RemoveUserByStrRoomIdResponse, err error)
- func (c *Client) RemoveUserWithContext(ctx context.Context, request *RemoveUserRequest) (response *RemoveUserResponse, err error)
- func (c *Client) StartAITranscription(request *StartAITranscriptionRequest) (response *StartAITranscriptionResponse, err error)
- func (c *Client) StartAITranscriptionWithContext(ctx context.Context, request *StartAITranscriptionRequest) (response *StartAITranscriptionResponse, err error)
- func (c *Client) StartMCUMixTranscode(request *StartMCUMixTranscodeRequest) (response *StartMCUMixTranscodeResponse, err error)
- func (c *Client) StartMCUMixTranscodeByStrRoomId(request *StartMCUMixTranscodeByStrRoomIdRequest) (response *StartMCUMixTranscodeByStrRoomIdResponse, err error)
- func (c *Client) StartMCUMixTranscodeByStrRoomIdWithContext(ctx context.Context, request *StartMCUMixTranscodeByStrRoomIdRequest) (response *StartMCUMixTranscodeByStrRoomIdResponse, err error)
- func (c *Client) StartMCUMixTranscodeWithContext(ctx context.Context, request *StartMCUMixTranscodeRequest) (response *StartMCUMixTranscodeResponse, err error)
- func (c *Client) StartPublishCdnStream(request *StartPublishCdnStreamRequest) (response *StartPublishCdnStreamResponse, err error)
- func (c *Client) StartPublishCdnStreamWithContext(ctx context.Context, request *StartPublishCdnStreamRequest) (response *StartPublishCdnStreamResponse, err error)
- func (c *Client) StartStreamIngest(request *StartStreamIngestRequest) (response *StartStreamIngestResponse, err error)
- func (c *Client) StartStreamIngestWithContext(ctx context.Context, request *StartStreamIngestRequest) (response *StartStreamIngestResponse, err error)
- func (c *Client) StartWebRecord(request *StartWebRecordRequest) (response *StartWebRecordResponse, err error)
- func (c *Client) StartWebRecordWithContext(ctx context.Context, request *StartWebRecordRequest) (response *StartWebRecordResponse, err error)
- func (c *Client) StopAITranscription(request *StopAITranscriptionRequest) (response *StopAITranscriptionResponse, err error)
- func (c *Client) StopAITranscriptionWithContext(ctx context.Context, request *StopAITranscriptionRequest) (response *StopAITranscriptionResponse, err error)
- func (c *Client) StopMCUMixTranscode(request *StopMCUMixTranscodeRequest) (response *StopMCUMixTranscodeResponse, err error)
- func (c *Client) StopMCUMixTranscodeByStrRoomId(request *StopMCUMixTranscodeByStrRoomIdRequest) (response *StopMCUMixTranscodeByStrRoomIdResponse, err error)
- func (c *Client) StopMCUMixTranscodeByStrRoomIdWithContext(ctx context.Context, request *StopMCUMixTranscodeByStrRoomIdRequest) (response *StopMCUMixTranscodeByStrRoomIdResponse, err error)
- func (c *Client) StopMCUMixTranscodeWithContext(ctx context.Context, request *StopMCUMixTranscodeRequest) (response *StopMCUMixTranscodeResponse, err error)
- func (c *Client) StopPublishCdnStream(request *StopPublishCdnStreamRequest) (response *StopPublishCdnStreamResponse, err error)
- func (c *Client) StopPublishCdnStreamWithContext(ctx context.Context, request *StopPublishCdnStreamRequest) (response *StopPublishCdnStreamResponse, err error)
- func (c *Client) StopStreamIngest(request *StopStreamIngestRequest) (response *StopStreamIngestResponse, err error)
- func (c *Client) StopStreamIngestWithContext(ctx context.Context, request *StopStreamIngestRequest) (response *StopStreamIngestResponse, err error)
- func (c *Client) StopWebRecord(request *StopWebRecordRequest) (response *StopWebRecordResponse, err error)
- func (c *Client) StopWebRecordWithContext(ctx context.Context, request *StopWebRecordRequest) (response *StopWebRecordResponse, err error)
- func (c *Client) SummarizeTranscription(request *SummarizeTranscriptionRequest) (response *SummarizeTranscriptionResponse, err error)
- func (c *Client) SummarizeTranscriptionWithContext(ctx context.Context, request *SummarizeTranscriptionRequest) (response *SummarizeTranscriptionResponse, err error)
- func (c *Client) UpdatePublishCdnStream(request *UpdatePublishCdnStreamRequest) (response *UpdatePublishCdnStreamResponse, err error)
- func (c *Client) UpdatePublishCdnStreamWithContext(ctx context.Context, request *UpdatePublishCdnStreamRequest) (response *UpdatePublishCdnStreamResponse, err error)
- type CloudStorage
- type CloudVod
- type CreateCloudRecordingRequest
- type CreateCloudRecordingRequestParams
- type CreateCloudRecordingResponse
- type CreateCloudRecordingResponseParams
- type CreatePictureRequest
- type CreatePictureRequestParams
- type CreatePictureResponse
- type CreatePictureResponseParams
- type DeleteCloudRecordingRequest
- type DeleteCloudRecordingRequestParams
- type DeleteCloudRecordingResponse
- type DeleteCloudRecordingResponseParams
- type DeletePictureRequest
- type DeletePictureRequestParams
- type DeletePictureResponse
- type DeletePictureResponseParams
- type DescribeAITranscriptionRequest
- type DescribeAITranscriptionRequestParams
- type DescribeAITranscriptionResponse
- type DescribeAITranscriptionResponseParams
- type DescribeCallDetailInfoRequest
- type DescribeCallDetailInfoRequestParams
- type DescribeCallDetailInfoResponse
- type DescribeCallDetailInfoResponseParams
- type DescribeCloudRecordingRequest
- type DescribeCloudRecordingRequestParams
- type DescribeCloudRecordingResponse
- type DescribeCloudRecordingResponseParams
- type DescribeMixTranscodingUsageRequest
- type DescribeMixTranscodingUsageRequestParams
- type DescribeMixTranscodingUsageResponse
- type DescribeMixTranscodingUsageResponseParams
- type DescribePictureRequest
- type DescribePictureRequestParams
- type DescribePictureResponse
- type DescribePictureResponseParams
- type DescribeRecordStatisticRequest
- type DescribeRecordStatisticRequestParams
- type DescribeRecordStatisticResponse
- type DescribeRecordStatisticResponseParams
- type DescribeRecordingUsageRequest
- type DescribeRecordingUsageRequestParams
- type DescribeRecordingUsageResponse
- type DescribeRecordingUsageResponseParams
- type DescribeRelayUsageRequest
- type DescribeRelayUsageRequestParams
- type DescribeRelayUsageResponse
- type DescribeRelayUsageResponseParams
- type DescribeRoomInfoRequest
- type DescribeRoomInfoRequestParams
- type DescribeRoomInfoResponse
- type DescribeRoomInfoResponseParams
- type DescribeScaleInfoRequest
- type DescribeScaleInfoRequestParams
- type DescribeScaleInfoResponse
- type DescribeScaleInfoResponseParams
- type DescribeStreamIngestRequest
- type DescribeStreamIngestRequestParams
- type DescribeStreamIngestResponse
- type DescribeStreamIngestResponseParams
- type DescribeTRTCMarketQualityDataRequest
- type DescribeTRTCMarketQualityDataRequestParams
- type DescribeTRTCMarketQualityDataResponse
- type DescribeTRTCMarketQualityDataResponseParams
- type DescribeTRTCMarketQualityMetricDataRequest
- type DescribeTRTCMarketQualityMetricDataRequestParams
- type DescribeTRTCMarketQualityMetricDataResponse
- type DescribeTRTCMarketQualityMetricDataResponseParams
- type DescribeTRTCMarketScaleDataRequest
- type DescribeTRTCMarketScaleDataRequestParams
- type DescribeTRTCMarketScaleDataResponse
- type DescribeTRTCMarketScaleDataResponseParams
- type DescribeTRTCMarketScaleMetricDataRequest
- type DescribeTRTCMarketScaleMetricDataRequestParams
- type DescribeTRTCMarketScaleMetricDataResponse
- type DescribeTRTCMarketScaleMetricDataResponseParams
- type DescribeTRTCRealTimeQualityDataRequest
- type DescribeTRTCRealTimeQualityDataRequestParams
- type DescribeTRTCRealTimeQualityDataResponse
- type DescribeTRTCRealTimeQualityDataResponseParams
- type DescribeTRTCRealTimeQualityMetricDataRequest
- type DescribeTRTCRealTimeQualityMetricDataRequestParams
- type DescribeTRTCRealTimeQualityMetricDataResponse
- type DescribeTRTCRealTimeQualityMetricDataResponseParams
- type DescribeTRTCRealTimeScaleDataRequest
- type DescribeTRTCRealTimeScaleDataRequestParams
- type DescribeTRTCRealTimeScaleDataResponse
- type DescribeTRTCRealTimeScaleDataResponseParams
- type DescribeTRTCRealTimeScaleMetricDataRequest
- type DescribeTRTCRealTimeScaleMetricDataRequestParams
- type DescribeTRTCRealTimeScaleMetricDataResponse
- type DescribeTRTCRealTimeScaleMetricDataResponseParams
- type DescribeTrtcMcuTranscodeTimeRequest
- type DescribeTrtcMcuTranscodeTimeRequestParams
- type DescribeTrtcMcuTranscodeTimeResponse
- type DescribeTrtcMcuTranscodeTimeResponseParams
- type DescribeTrtcRoomUsageRequest
- type DescribeTrtcRoomUsageRequestParams
- type DescribeTrtcRoomUsageResponse
- type DescribeTrtcRoomUsageResponseParams
- type DescribeTrtcUsageRequest
- type DescribeTrtcUsageRequestParams
- type DescribeTrtcUsageResponse
- type DescribeTrtcUsageResponseParams
- type DescribeUnusualEventRequest
- type DescribeUnusualEventRequestParams
- type DescribeUnusualEventResponse
- type DescribeUnusualEventResponseParams
- type DescribeUserEventRequest
- type DescribeUserEventRequestParams
- type DescribeUserEventResponse
- type DescribeUserEventResponseParams
- type DescribeUserInfoRequest
- type DescribeUserInfoRequestParams
- type DescribeUserInfoResponse
- type DescribeUserInfoResponseParams
- type DescribeWebRecordRequest
- type DescribeWebRecordRequestParams
- type DescribeWebRecordResponse
- type DescribeWebRecordResponseParams
- type DismissRoomByStrRoomIdRequest
- type DismissRoomByStrRoomIdRequestParams
- type DismissRoomByStrRoomIdResponse
- type DismissRoomByStrRoomIdResponseParams
- type DismissRoomRequest
- type DismissRoomRequestParams
- type DismissRoomResponse
- type DismissRoomResponseParams
- type EncodeParams
- type EventList
- type EventMessage
- type LayoutParams
- type MaxVideoUser
- type McuAudioParams
- type McuBackgroundCustomRender
- type McuCustomCrop
- type McuFeedBackRoomParams
- type McuLayout
- type McuLayoutParams
- type McuLayoutVolume
- type McuPassThrough
- type McuPublishCdnParam
- type McuSeiParams
- type McuUserInfoParams
- type McuVideoParams
- type McuWaterMarkImage
- type McuWaterMarkParams
- type McuWaterMarkText
- type MixLayout
- type MixLayoutParams
- type MixTranscodeParams
- type MixUserInfo
- type ModifyCloudRecordingRequest
- type ModifyCloudRecordingRequestParams
- type ModifyCloudRecordingResponse
- type ModifyCloudRecordingResponseParams
- type ModifyPictureRequest
- type ModifyPictureRequestParams
- type ModifyPictureResponse
- type ModifyPictureResponseParams
- type OneSdkAppIdTranscodeTimeUsagesInfo
- type OutputParams
- type PictureInfo
- type PresetLayoutConfig
- type PublishCdnParams
- type QualityData
- type RecognizeConfig
- type RecordParams
- type RecordUsage
- type RemoveUserByStrRoomIdRequest
- type RemoveUserByStrRoomIdRequestParams
- type RemoveUserByStrRoomIdResponse
- type RemoveUserByStrRoomIdResponseParams
- type RemoveUserRequest
- type RemoveUserRequestParams
- type RemoveUserResponse
- type RemoveUserResponseParams
- type RoomState
- type RowValues
- type ScaleInfomation
- type SdkAppIdRecordUsage
- type SdkAppIdTrtcMcuTranscodeTimeUsage
- type SeriesInfo
- type SeriesInfos
- type SingleSubscribeParams
- type SmallVideoLayoutParams
- type StartAITranscriptionRequest
- type StartAITranscriptionRequestParams
- type StartAITranscriptionResponse
- type StartAITranscriptionResponseParams
- type StartMCUMixTranscodeByStrRoomIdRequest
- type StartMCUMixTranscodeByStrRoomIdRequestParams
- type StartMCUMixTranscodeByStrRoomIdResponse
- type StartMCUMixTranscodeByStrRoomIdResponseParams
- type StartMCUMixTranscodeRequest
- type StartMCUMixTranscodeRequestParams
- type StartMCUMixTranscodeResponse
- type StartMCUMixTranscodeResponseParams
- type StartPublishCdnStreamRequest
- type StartPublishCdnStreamRequestParams
- type StartPublishCdnStreamResponse
- type StartPublishCdnStreamResponseParams
- type StartStreamIngestRequest
- type StartStreamIngestRequestParams
- type StartStreamIngestResponse
- type StartStreamIngestResponseParams
- type StartWebRecordRequest
- type StartWebRecordRequestParams
- type StartWebRecordResponse
- type StartWebRecordResponseParams
- type StopAITranscriptionRequest
- type StopAITranscriptionRequestParams
- type StopAITranscriptionResponse
- type StopAITranscriptionResponseParams
- type StopMCUMixTranscodeByStrRoomIdRequest
- type StopMCUMixTranscodeByStrRoomIdRequestParams
- type StopMCUMixTranscodeByStrRoomIdResponse
- type StopMCUMixTranscodeByStrRoomIdResponseParams
- type StopMCUMixTranscodeRequest
- type StopMCUMixTranscodeRequestParams
- type StopMCUMixTranscodeResponse
- type StopMCUMixTranscodeResponseParams
- type StopPublishCdnStreamRequest
- type StopPublishCdnStreamRequestParams
- type StopPublishCdnStreamResponse
- type StopPublishCdnStreamResponseParams
- type StopStreamIngestRequest
- type StopStreamIngestRequestParams
- type StopStreamIngestResponse
- type StopStreamIngestResponseParams
- type StopWebRecordRequest
- type StopWebRecordRequestParams
- type StopWebRecordResponse
- type StopWebRecordResponseParams
- type StorageFile
- type StorageParams
- type SubscribeStreamUserIds
- type SummarizeTranscriptionRequest
- type SummarizeTranscriptionRequestParams
- type SummarizeTranscriptionResponse
- type SummarizeTranscriptionResponseParams
- type TRTCDataResp
- type TRTCDataResult
- type TencentVod
- type TimeValue
- type TranscriptionParams
- type TrtcUsage
- type UpdatePublishCdnStreamRequest
- type UpdatePublishCdnStreamRequestParams
- type UpdatePublishCdnStreamResponse
- type UpdatePublishCdnStreamResponseParams
- type UserInformation
- type UserMediaStream
- type VideoEncode
- type VideoEncodeParams
- type VideoParams
- type WaterMark
- type WaterMarkChar
- type WaterMarkImage
- type WaterMarkParams
- type WaterMarkTimestamp
- type WebRecordVideoParams
Constants ¶
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" // 需要解锁所需能力位 FAILEDOPERATION_NOTABILITY = "FailedOperation.NotAbility" // 未开通RTMP FAILEDOPERATION_NOTRTMPFUNCTION = "FailedOperation.NotRtmpFunction" // 查询任务失败 FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed" // 请求过期。 FAILEDOPERATION_REQUESTOUTDATED = "FailedOperation.RequestOutdated" // 云API混流模板和SDK混流冲突。 FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection" // 单用户并发过载,请联系我们增大并发路数到合理值。 FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency" // 房间不存在。 FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist" // 应用ID不存在。 FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist" // AppId下没有此SdkAppId的资源 FAILEDOPERATION_SDKAPPIDNOTUNDERAPPID = "FailedOperation.SdkAppIdNotUnderAppId" // SdkAppId未开通页面录制能力,请检查。 FAILEDOPERATION_SDKAPPIDNOTWEBRECORDABILITY = "FailedOperation.SdkAppIdNotWebRecordAbility" // 任务已存在 FAILEDOPERATION_TASKEXIST = "FailedOperation.TaskExist" // 调用接口时任务已结束。 FAILEDOPERATION_TASKFINISHED = "FailedOperation.TaskFinished" // 任务不存在或已结束 FAILEDOPERATION_TASKNOTEXIST = "FailedOperation.TaskNotExist" // 内部错误。 INTERNALERROR = "InternalError" // 云端录制内部服务错误。 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" // http请求解析失败。 INTERNALERROR_HTTPPARSEFAILED = "InternalError.HttpParseFailed" // 接口错误。 INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr" // 内部错误,请重试。 INTERNALERROR_INTERNALERROR = "InternalError.InternalError" // 不支持的方法。 INTERNALERROR_METHODERR = "InternalError.MethodErr" // 参数错误。 INVALIDPARAMETER = "InvalidParameter" // AppId校验失败。 INVALIDPARAMETER_APPID = "InvalidParameter.AppId" // 音频编码参数错误。 INVALIDPARAMETER_AUDIOENCODEPARAMS = "InvalidParameter.AudioEncodeParams" // BackgroundImageUrl参数错误。 INVALIDPARAMETER_BACKGROUNDIMAGEURL = "InvalidParameter.BackgroundImageUrl" // body 解析参数失败。 INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" // 图片过大。 INVALIDPARAMETER_CHECKCONTENTFAILED = "InvalidParameter.CheckContentFailed" // 后缀名校验失败。 INVALIDPARAMETER_CHECKSUFFIXFAILED = "InvalidParameter.CheckSuffixFailed" // EncodeParams参数错误。 INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams" // EndTs参数错误。 INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs" // invalid sdkAppId INVALIDPARAMETER_INVALIDSDKAPPID = "InvalidParameter.InvalidSdkAppId" // 大画面居右显示参数错误。 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" // 查询起始时间超过当前监控仪表盘功能版本限制,详情请见:https://cloud.tencent.com/document/product/647/81331。 INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize" // StartTs参数错误。 INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs" // 查询开始时间超过文档限制。 INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize" // StrRoomId参数错误。 INVALIDPARAMETER_STRROOMID = "InvalidParameter.StrRoomId" // StreamId参数错误。 INVALIDPARAMETER_STREAMID = "InvalidParameter.StreamId" // TaskId 参数错误。 INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId" // Url解析参数失败。 INVALIDPARAMETER_URLPARAMSERROR = "InvalidParameter.UrlParamsError" // UserId参数错误。 INVALIDPARAMETER_USERID = "InvalidParameter.UserId" // UserIds参数错误。 INVALIDPARAMETER_USERIDS = "InvalidParameter.UserIds" // 用户数超过6个。 INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix" // UserSig过期或错误。 INVALIDPARAMETER_USERSIG = "InvalidParameter.UserSig" // UserSig 不是超级管理员。 INVALIDPARAMETER_USERSIGNOTADMIN = "InvalidParameter.UserSigNotAdmin" // 视频分辨率参数错误。 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" // 资源不足。 RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection" // 资源不存在。 RESOURCENOTFOUND = "ResourceNotFound" // 没有操作SdkAppId的权限。 UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId" // 未知参数错误。 UNKNOWNPARAMETER = "UnknownParameter" // 操作不支持。 UNSUPPORTEDOPERATION = "UnsupportedOperation" )
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,omitnil,omitempty" name:"AbnormalEventId"` // 远端用户ID,"":表示异常事件不是由远端用户产生 // 注意:此字段可能返回 null,表示取不到有效值。 PeerId *string `json:"PeerId,omitnil,omitempty" name:"PeerId"` }
type AbnormalExperience ¶
type AbnormalExperience struct { // 用户ID UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 异常体验ID ExperienceId *uint64 `json:"ExperienceId,omitnil,omitempty" name:"ExperienceId"` // 字符串房间号 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 异常事件数组 AbnormalEventList []*AbnormalEvent `json:"AbnormalEventList,omitnil,omitempty" name:"AbnormalEventList"` // 异常事件的上报时间 EventTime *uint64 `json:"EventTime,omitnil,omitempty" name:"EventTime"` }
type AgentParams ¶ added in v1.0.515
type AgentParams struct { // 转推服务在TRTC房间使用的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。 UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 转推服务加入TRTC房间的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。 UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"` // 所有参与混流转推的主播持续离开TRTC房间或切换成观众超过MaxIdleTime的时长,自动停止转推,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。 MaxIdleTime *uint64 `json:"MaxIdleTime,omitnil,omitempty" name:"MaxIdleTime"` }
type AudioEncode ¶ added in v1.0.515
type AudioEncode struct { // 输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000],单位是Hz。 SampleRate *uint64 `json:"SampleRate,omitnil,omitempty" name:"SampleRate"` // 输出流音频声道数,取值范围[1,2],1表示混流输出音频为单声道,2表示混流输出音频为双声道。 Channel *uint64 `json:"Channel,omitnil,omitempty" name:"Channel"` // 输出流音频码率。取值范围[8,500],单位为kbps。 BitRate *uint64 `json:"BitRate,omitnil,omitempty" name:"BitRate"` // 输出流音频编码类型,取值范围[0, 1, 2],0为LC-AAC,1为HE-AAC,2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时,只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。 Codec *uint64 `json:"Codec,omitnil,omitempty" name:"Codec"` }
type AudioEncodeParams ¶ added in v1.0.803
type AudioEncodeParams struct { // 音频采样率,取值为[48000, 44100],单位是Hz。 SampleRate *uint64 `json:"SampleRate,omitnil,omitempty" name:"SampleRate"` // 音频声道数,取值范围[1,2],1表示音频为单声道,2表示音频为双声道。 Channel *uint64 `json:"Channel,omitnil,omitempty" name:"Channel"` // 音频码率,取值范围[8,500],单位为kbps。 BitRate *uint64 `json:"BitRate,omitnil,omitempty" name:"BitRate"` // 音量,取值范围[0,300]。默认100,表示原始音量;0表示静音。 Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"` }
type AudioParams ¶ added in v1.0.400
type AudioParams struct { // 音频采样率枚举值:(注意1 代表48000HZ, 2 代表44100HZ, 3 代表16000HZ) // 1:48000Hz(默认); // 2:44100Hz // 3:16000Hz。 SampleRate *uint64 `json:"SampleRate,omitnil,omitempty" name:"SampleRate"` // 声道数枚举值: // 1:单声道; // 2:双声道(默认)。 Channel *uint64 `json:"Channel,omitnil,omitempty" name:"Channel"` // 音频码率: 取值范围[32000, 128000] ,单位bps,默认64000bps。 BitRate *uint64 `json:"BitRate,omitnil,omitempty" name:"BitRate"` }
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) CreateCloudRecording ¶ added in v1.0.400
func (c *Client) CreateCloudRecording(request *CreateCloudRecordingRequest) (response *CreateCloudRecordingResponse, err error)
CreateCloudRecording 接口说明:
启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面合流混成一路。
您可以通过此接口实现如下目标:
* 指定订阅流参数(RecordParams)来指定需要录制的主播的黑名单或者白名单。
* 指定录制存储参数(StorageParams)来指定上传到您希望的云存储,目前支持腾讯云(云点播VOD、对象存储COS)和第三方AWS
* 指定合流模式下的音视频转码详细参数(MixTranscodeParams),包括视频分辨率、视频码率、视频帧率、以及声音质量等
* 指定合流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。
关键名词:
* 单流录制:分别录制房间的订阅UserId的音频和视频,录制服务会实时将录制文件上传至您指定的云存储。
* 合流录制:将房间内订阅UserId的音视频混录成一个视频文件,并将录制文件上传至您指定的云存储。(录制结束后可前往云点播控制台https://console.cloud.tencent.com/vod/media 或 对象存储COS控制台https://console.cloud.tencent.com/cos/bucket查看文件)。
可能返回的错误码:
AUTHFAILURE = "AuthFailure" AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated" AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation" AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod" FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency" INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError" INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" MISSINGPARAMETER_ACCESSKEY = "MissingParameter.AccessKey" MISSINGPARAMETER_BUCKET = "MissingParameter.Bucket" MISSINGPARAMETER_CLOUDSTORAGE = "MissingParameter.CloudStorage" MISSINGPARAMETER_RECORDMODE = "MissingParameter.RecordMode" MISSINGPARAMETER_RECORDPARAMS = "MissingParameter.RecordParams" MISSINGPARAMETER_REGION = "MissingParameter.Region" MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_SECRETKEY = "MissingParameter.SecretKey" MISSINGPARAMETER_STORAGEPARAMS = "MissingParameter.StorageParams" MISSINGPARAMETER_STREAMTYPE = "MissingParameter.StreamType" MISSINGPARAMETER_TASKID = "MissingParameter.TaskId" MISSINGPARAMETER_USERID = "MissingParameter.UserId" MISSINGPARAMETER_USERSIG = "MissingParameter.UserSig" MISSINGPARAMETER_VENDOR = "MissingParameter.Vendor" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) CreateCloudRecordingWithContext ¶ added in v1.0.400
func (c *Client) CreateCloudRecordingWithContext(ctx context.Context, request *CreateCloudRecordingRequest) (response *CreateCloudRecordingResponse, err error)
CreateCloudRecording 接口说明:
启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面合流混成一路。
您可以通过此接口实现如下目标:
* 指定订阅流参数(RecordParams)来指定需要录制的主播的黑名单或者白名单。
* 指定录制存储参数(StorageParams)来指定上传到您希望的云存储,目前支持腾讯云(云点播VOD、对象存储COS)和第三方AWS
* 指定合流模式下的音视频转码详细参数(MixTranscodeParams),包括视频分辨率、视频码率、视频帧率、以及声音质量等
* 指定合流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。
关键名词:
* 单流录制:分别录制房间的订阅UserId的音频和视频,录制服务会实时将录制文件上传至您指定的云存储。
* 合流录制:将房间内订阅UserId的音视频混录成一个视频文件,并将录制文件上传至您指定的云存储。(录制结束后可前往云点播控制台https://console.cloud.tencent.com/vod/media 或 对象存储COS控制台https://console.cloud.tencent.com/cos/bucket查看文件)。
可能返回的错误码:
AUTHFAILURE = "AuthFailure" AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated" AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation" AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod" FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency" INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError" INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" MISSINGPARAMETER_ACCESSKEY = "MissingParameter.AccessKey" MISSINGPARAMETER_BUCKET = "MissingParameter.Bucket" MISSINGPARAMETER_CLOUDSTORAGE = "MissingParameter.CloudStorage" MISSINGPARAMETER_RECORDMODE = "MissingParameter.RecordMode" MISSINGPARAMETER_RECORDPARAMS = "MissingParameter.RecordParams" MISSINGPARAMETER_REGION = "MissingParameter.Region" MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_SECRETKEY = "MissingParameter.SecretKey" MISSINGPARAMETER_STORAGEPARAMS = "MissingParameter.StorageParams" MISSINGPARAMETER_STREAMTYPE = "MissingParameter.StreamType" MISSINGPARAMETER_TASKID = "MissingParameter.TaskId" MISSINGPARAMETER_USERID = "MissingParameter.UserId" MISSINGPARAMETER_USERSIG = "MissingParameter.UserSig" MISSINGPARAMETER_VENDOR = "MissingParameter.Vendor" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) 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) 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" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_TASKID = "MissingParameter.TaskId" MISSINGPARAMETER_USERID = "MissingParameter.UserId" RESOURCENOTFOUND = "ResourceNotFound"
func (*Client) DeleteCloudRecordingWithContext ¶ 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" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" 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" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" 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" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" MISSINGPARAMETER = "MissingParameter" UNKNOWNPARAMETER = "UnknownParameter"
func (*Client) DescribeAITranscription ¶ added in v1.0.925
func (c *Client) DescribeAITranscription(request *DescribeAITranscriptionRequest) (response *DescribeAITranscriptionResponse, err error)
DescribeAITranscription 查询AI转录任务状态。
可能返回的错误码:
FAILEDOPERATION_TASKNOTEXIST = "FailedOperation.TaskNotExist" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
func (*Client) DescribeAITranscriptionWithContext ¶ added in v1.0.925
func (c *Client) DescribeAITranscriptionWithContext(ctx context.Context, request *DescribeAITranscriptionRequest) (response *DescribeAITranscriptionResponse, err error)
DescribeAITranscription 查询AI转录任务状态。
可能返回的错误码:
FAILEDOPERATION_TASKNOTEXIST = "FailedOperation.TaskNotExist" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
func (*Client) DescribeCallDetailInfo ¶ added in v1.0.449
func (c *Client) DescribeCallDetailInfo(request *DescribeCallDetailInfoRequest) (response *DescribeCallDetailInfoResponse, err error)
DescribeCallDetailInfo 查询指定时间内的用户列表及用户通话质量数据,最大可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
**注意**:
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任选其一解锁:
方式一:通过订阅[包月套餐](https://cloud.tencent.com/document/product/647/85386)「尊享版」(可查近7天)和「旗舰版」(可查近14天),[前往订阅](https://buy.cloud.tencent.com/trtc?trtcversion=top)。
方式二:通过订阅[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)商业套餐包「基础版」(可查近7天)和「进阶版」(可查近14天),[前往订阅](https://buy.cloud.tencent.com/trtc_monitor)。
可能返回的错误码:
INTERNALERROR = "InternalError" INTERNALERROR_DBERROR = "InternalError.DBError" INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError" INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied" INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr" INTERNALERROR_METHODERR = "InternalError.MethodErr" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams" INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber" INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize" INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize" INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize" INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs" INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize" INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix" MISSINGPARAMETER = "MissingParameter" MISSINGPARAMETER_COMMID = "MissingParameter.CommId" MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId" MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"
func (*Client) DescribeCallDetailInfoWithContext ¶ added in v1.0.449
func (c *Client) DescribeCallDetailInfoWithContext(ctx context.Context, request *DescribeCallDetailInfoRequest) (response *DescribeCallDetailInfoResponse, err error)
DescribeCallDetailInfo 查询指定时间内的用户列表及用户通话质量数据,最大可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
**注意**:
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任选其一解锁:
方式一:通过订阅[包月套餐](https://cloud.tencent.com/document/product/647/85386)「尊享版」(可查近7天)和「旗舰版」(可查近14天),[前往订阅](https://buy.cloud.tencent.com/trtc?trtcversion=top)。
方式二:通过订阅[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)商业套餐包「基础版」(可查近7天)和「进阶版」(可查近14天),[前往订阅](https://buy.cloud.tencent.com/trtc_monitor)。
可能返回的错误码:
INTERNALERROR = "InternalError" INTERNALERROR_DBERROR = "InternalError.DBError" INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError" INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied" INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr" INTERNALERROR_METHODERR = "InternalError.MethodErr" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams" INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber" INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize" INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize" INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize" INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs" INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize" INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix" MISSINGPARAMETER = "MissingParameter" MISSINGPARAMETER_COMMID = "MissingParameter.CommId" MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId" MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"
func (*Client) DescribeCloudRecording ¶ added in v1.0.400
func (c *Client) DescribeCloudRecording(request *DescribeCloudRecordingRequest) (response *DescribeCloudRecordingResponse, err error)
DescribeCloudRecording 成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。
录制文件上传到云点播VOD时,StorageFileList中不会返回录制文件信息,请订阅相关录制文件回调事件,获取录制文件信息。
可能返回的错误码:
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 成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。
录制文件上传到云点播VOD时,StorageFileList中不会返回录制文件信息,请订阅相关录制文件回调事件,获取录制文件信息。
可能返回的错误码:
AUTHFAILURE = "AuthFailure" AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated" AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation" AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod" INTERNALERROR_CRINTERNALERROR = "InternalError.CRInternalError" INVALIDPARAMETER_OUTOFRANGE = "InvalidParameter.OutOfRange" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_TASKID = "MissingParameter.TaskId" MISSINGPARAMETER_USERID = "MissingParameter.UserId" RESOURCENOTFOUND = "ResourceNotFound"
func (*Client) DescribeMixTranscodingUsage ¶ added in v1.0.514
func (c *Client) DescribeMixTranscodingUsage(request *DescribeMixTranscodingUsageRequest) (response *DescribeMixTranscodingUsageResponse, err error)
DescribeMixTranscodingUsage 获取TRTC混流转码的用量明细。
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
- 单次查询统计区间最多不能超过31天。
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
- 默认接口请求频率限制:5次/秒。
可能返回的错误码:
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
func (*Client) DescribeMixTranscodingUsageWithContext ¶ added in v1.0.514
func (c *Client) DescribeMixTranscodingUsageWithContext(ctx context.Context, request *DescribeMixTranscodingUsageRequest) (response *DescribeMixTranscodingUsageResponse, err error)
DescribeMixTranscodingUsage 获取TRTC混流转码的用量明细。
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
- 单次查询统计区间最多不能超过31天。
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
- 默认接口请求频率限制:5次/秒。
可能返回的错误码:
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
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) DescribeRecordingUsage ¶ added in v1.0.514
func (c *Client) DescribeRecordingUsage(request *DescribeRecordingUsageRequest) (response *DescribeRecordingUsageResponse, err error)
DescribeRecordingUsage 获取TRTC录制的用量明细。
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
- 单次查询统计区间最多不能超过31天。
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
- 默认接口请求频率限制:5次/秒。
可能返回的错误码:
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
func (*Client) DescribeRecordingUsageWithContext ¶ added in v1.0.514
func (c *Client) DescribeRecordingUsageWithContext(ctx context.Context, request *DescribeRecordingUsageRequest) (response *DescribeRecordingUsageResponse, err error)
DescribeRecordingUsage 获取TRTC录制的用量明细。
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
- 单次查询统计区间最多不能超过31天。
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
- 默认接口请求频率限制:5次/秒。
可能返回的错误码:
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
func (*Client) DescribeRelayUsage ¶ added in v1.0.514
func (c *Client) DescribeRelayUsage(request *DescribeRelayUsageRequest) (response *DescribeRelayUsageResponse, err error)
DescribeRelayUsage 获取TRTC旁路转推的用量明细。
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
- 单次查询统计区间最多不能超过31天。
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
- 默认接口请求频率限制:5次/秒。
可能返回的错误码:
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
func (*Client) DescribeRelayUsageWithContext ¶ added in v1.0.514
func (c *Client) DescribeRelayUsageWithContext(ctx context.Context, request *DescribeRelayUsageRequest) (response *DescribeRelayUsageResponse, err error)
DescribeRelayUsage 获取TRTC旁路转推的用量明细。
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
- 单次查询统计区间最多不能超过31天。
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
- 默认接口请求频率限制:5次/秒。
可能返回的错误码:
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
func (*Client) DescribeRoomInfo ¶ added in v1.0.449
func (c *Client) DescribeRoomInfo(request *DescribeRoomInfoRequest) (response *DescribeRoomInfoResponse, err error)
DescribeRoomInfo 查询SdkAppId下的房间列表。默认返回10条通话,一次最多返回100条通话。最大可查询14天内的数据。(同老接口DescribeRoomInformation)
**注意**:
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任意其一解锁:
方式一:通过订阅[包月套餐](https://cloud.tencent.com/document/product/647/85386)「尊享版」(可查近7天)和「旗舰版」(可查近14天),[前往订阅](https://buy.cloud.tencent.com/trtc?trtcversion=top)。
方式二:通过订阅[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)商业套餐包「基础版」(可查近7天)和「进阶版」(可查近14天),[前往订阅](https://buy.cloud.tencent.com/trtc_monitor)。
可能返回的错误码:
INTERNALERROR = "InternalError" INTERNALERROR_DBERROR = "InternalError.DBError" INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError" INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied" INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr" INTERNALERROR_METHODERR = "InternalError.MethodErr" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs" INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber" INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize" INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize" INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize" INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs" INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize" INVALIDPARAMETER_URLPARAMSERROR = "InvalidParameter.UrlParamsError" INVALIDPARAMETER_USERID = "InvalidParameter.UserId" MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId" MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs" MISSINGPARAMETER_ROOMNUM = "MissingParameter.RoomNum" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"
func (*Client) DescribeRoomInfoWithContext ¶ added in v1.0.449
func (c *Client) DescribeRoomInfoWithContext(ctx context.Context, request *DescribeRoomInfoRequest) (response *DescribeRoomInfoResponse, err error)
DescribeRoomInfo 查询SdkAppId下的房间列表。默认返回10条通话,一次最多返回100条通话。最大可查询14天内的数据。(同老接口DescribeRoomInformation)
**注意**:
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任意其一解锁:
方式一:通过订阅[包月套餐](https://cloud.tencent.com/document/product/647/85386)「尊享版」(可查近7天)和「旗舰版」(可查近14天),[前往订阅](https://buy.cloud.tencent.com/trtc?trtcversion=top)。
方式二:通过订阅[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)商业套餐包「基础版」(可查近7天)和「进阶版」(可查近14天),[前往订阅](https://buy.cloud.tencent.com/trtc_monitor)。
可能返回的错误码:
INTERNALERROR = "InternalError" INTERNALERROR_DBERROR = "InternalError.DBError" INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError" INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied" INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr" INTERNALERROR_METHODERR = "InternalError.MethodErr" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs" INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber" INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize" INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize" INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize" INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs" INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize" INVALIDPARAMETER_URLPARAMSERROR = "InvalidParameter.UrlParamsError" INVALIDPARAMETER_USERID = "InvalidParameter.UserId" MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId" MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs" MISSINGPARAMETER_ROOMNUM = "MissingParameter.RoomNum" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"
func (*Client) DescribeScaleInfo ¶ added in v1.0.449
func (c *Client) DescribeScaleInfo(request *DescribeScaleInfoRequest) (response *DescribeScaleInfoResponse, err error)
DescribeScaleInfo 可查询SdkAppId每天的房间数和用户数,按天统计,可查询最近14天的数据。当天未结束,数据未统计完成,无法查到当天的房间数与用户数。(同老接口DescribeHistoryScale)
可能返回的错误码:
INTERNALERROR = "InternalError" INTERNALERROR_DBERROR = "InternalError.DBError" INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied" INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr" INTERNALERROR_METHODERR = "InternalError.MethodErr" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs" INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize" INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix" MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"
func (*Client) DescribeScaleInfoWithContext ¶ added in v1.0.449
func (c *Client) DescribeScaleInfoWithContext(ctx context.Context, request *DescribeScaleInfoRequest) (response *DescribeScaleInfoResponse, err error)
DescribeScaleInfo 可查询SdkAppId每天的房间数和用户数,按天统计,可查询最近14天的数据。当天未结束,数据未统计完成,无法查到当天的房间数与用户数。(同老接口DescribeHistoryScale)
可能返回的错误码:
INTERNALERROR = "InternalError" INTERNALERROR_DBERROR = "InternalError.DBError" INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied" INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr" INTERNALERROR_METHODERR = "InternalError.MethodErr" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs" INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize" INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix" MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"
func (*Client) DescribeStreamIngest ¶ added in v1.0.803
func (c *Client) DescribeStreamIngest(request *DescribeStreamIngestRequest) (response *DescribeStreamIngestResponse, err error)
DescribeStreamIngest 您可以查询输入在线媒体流任务的状态。
可能返回的错误码:
FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed" INTERNALERROR_DBERROR = "InternalError.DBError" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
func (*Client) DescribeStreamIngestWithContext ¶ added in v1.0.803
func (c *Client) DescribeStreamIngestWithContext(ctx context.Context, request *DescribeStreamIngestRequest) (response *DescribeStreamIngestResponse, err error)
DescribeStreamIngest 您可以查询输入在线媒体流任务的状态。
可能返回的错误码:
FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed" INTERNALERROR_DBERROR = "InternalError.DBError" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
func (*Client) DescribeTRTCMarketQualityData ¶ added in v1.0.732
func (c *Client) DescribeTRTCMarketQualityData(request *DescribeTRTCMarketQualityDataRequest) (response *DescribeTRTCMarketQualityDataResponse, err error)
DescribeTRTCMarketQualityData 查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
joinSuccessRate:加入频道成功率。
joinSuccessIn5sRate:5s内加入频道成功率。
audioFreezeRate:音频卡顿率。
videoFreezeRate:视频卡顿率。
networkDelay :网络延迟率。
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/647/81331)。
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
可能返回的错误码:
FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed" INTERNALERROR_DBERROR = "InternalError.DBError" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
func (*Client) DescribeTRTCMarketQualityDataWithContext ¶ added in v1.0.732
func (c *Client) DescribeTRTCMarketQualityDataWithContext(ctx context.Context, request *DescribeTRTCMarketQualityDataRequest) (response *DescribeTRTCMarketQualityDataResponse, err error)
DescribeTRTCMarketQualityData 查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
joinSuccessRate:加入频道成功率。
joinSuccessIn5sRate:5s内加入频道成功率。
audioFreezeRate:音频卡顿率。
videoFreezeRate:视频卡顿率。
networkDelay :网络延迟率。
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/647/81331)。
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
可能返回的错误码:
FAILEDOPERATION_QUERYTASKINFOFAILED = "FailedOperation.QueryTaskInfoFailed" INTERNALERROR_DBERROR = "InternalError.DBError" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_TASKID = "MissingParameter.TaskId"
func (*Client) DescribeTRTCMarketQualityMetricData ¶ added in v1.0.530
func (c *Client) DescribeTRTCMarketQualityMetricData(request *DescribeTRTCMarketQualityMetricDataRequest) (response *DescribeTRTCMarketQualityMetricDataResponse, err error)
DescribeTRTCMarketQualityMetricData 查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
joinSuccessRate:加入频道成功率。
joinSuccessIn5sRate:5s内加入频道成功率。
audioFreezeRate:音频卡顿率。
videoFreezeRate:视频卡顿率。
networkDelay :网络延迟率。
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
可能返回的错误码:
UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeTRTCMarketQualityMetricDataWithContext ¶ added in v1.0.530
func (c *Client) DescribeTRTCMarketQualityMetricDataWithContext(ctx context.Context, request *DescribeTRTCMarketQualityMetricDataRequest) (response *DescribeTRTCMarketQualityMetricDataResponse, err error)
DescribeTRTCMarketQualityMetricData 查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
joinSuccessRate:加入频道成功率。
joinSuccessIn5sRate:5s内加入频道成功率。
audioFreezeRate:音频卡顿率。
videoFreezeRate:视频卡顿率。
networkDelay :网络延迟率。
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
可能返回的错误码:
UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeTRTCMarketScaleData ¶ added in v1.0.732
func (c *Client) DescribeTRTCMarketScaleData(request *DescribeTRTCMarketScaleDataRequest) (response *DescribeTRTCMarketScaleDataResponse, err error)
DescribeTRTCMarketScaleData 查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数)
userCount:通话人数,
roomCount:通话房间数,从有用户加入频道到所有用户离开频道计为一个通话频道。
peakCurrentChannels:峰值同时在线频道数。
peakCurrentUsers:峰值同时在线人数。
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/647/81331)。
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
可能返回的错误码:
UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeTRTCMarketScaleDataWithContext ¶ added in v1.0.732
func (c *Client) DescribeTRTCMarketScaleDataWithContext(ctx context.Context, request *DescribeTRTCMarketScaleDataRequest) (response *DescribeTRTCMarketScaleDataResponse, err error)
DescribeTRTCMarketScaleData 查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数)
userCount:通话人数,
roomCount:通话房间数,从有用户加入频道到所有用户离开频道计为一个通话频道。
peakCurrentChannels:峰值同时在线频道数。
peakCurrentUsers:峰值同时在线人数。
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/647/81331)。
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
可能返回的错误码:
UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeTRTCMarketScaleMetricData ¶ added in v1.0.530
func (c *Client) DescribeTRTCMarketScaleMetricData(request *DescribeTRTCMarketScaleMetricDataRequest) (response *DescribeTRTCMarketScaleMetricDataResponse, err error)
DescribeTRTCMarketScaleMetricData 查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数)
userCount:通话人数,
roomCount:通话房间数,从有用户加入频道到所有用户离开频道计为一个通话频道。
peakCurrentChannels:峰值同时在线频道数。
peakCurrentUsers:峰值同时在线人数。
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
可能返回的错误码:
UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeTRTCMarketScaleMetricDataWithContext ¶ added in v1.0.530
func (c *Client) DescribeTRTCMarketScaleMetricDataWithContext(ctx context.Context, request *DescribeTRTCMarketScaleMetricDataRequest) (response *DescribeTRTCMarketScaleMetricDataResponse, err error)
DescribeTRTCMarketScaleMetricData 查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数)
userCount:通话人数,
roomCount:通话房间数,从有用户加入频道到所有用户离开频道计为一个通话频道。
peakCurrentChannels:峰值同时在线频道数。
peakCurrentUsers:峰值同时在线人数。
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
可能返回的错误码:
UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeTRTCRealTimeQualityData ¶ added in v1.0.732
func (c *Client) DescribeTRTCRealTimeQualityData(request *DescribeTRTCRealTimeQualityDataRequest) (response *DescribeTRTCRealTimeQualityDataResponse, err error)
DescribeTRTCRealTimeQualityData 查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
-视频卡顿率
-音频卡顿率
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/647/81331)。
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
可能返回的错误码:
INVALIDPARAMETER_INVALIDSDKAPPID = "InvalidParameter.InvalidSdkAppId"
func (*Client) DescribeTRTCRealTimeQualityDataWithContext ¶ added in v1.0.732
func (c *Client) DescribeTRTCRealTimeQualityDataWithContext(ctx context.Context, request *DescribeTRTCRealTimeQualityDataRequest) (response *DescribeTRTCRealTimeQualityDataResponse, err error)
DescribeTRTCRealTimeQualityData 查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
-视频卡顿率
-音频卡顿率
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/647/81331)。
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
可能返回的错误码:
INVALIDPARAMETER_INVALIDSDKAPPID = "InvalidParameter.InvalidSdkAppId"
func (*Client) DescribeTRTCRealTimeQualityMetricData ¶ added in v1.0.530
func (c *Client) DescribeTRTCRealTimeQualityMetricData(request *DescribeTRTCRealTimeQualityMetricDataRequest) (response *DescribeTRTCRealTimeQualityMetricDataResponse, err error)
DescribeTRTCRealTimeQualityMetricData 查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
-视频卡顿率
-音频卡顿率
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
可能返回的错误码:
UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeTRTCRealTimeQualityMetricDataWithContext ¶ added in v1.0.530
func (c *Client) DescribeTRTCRealTimeQualityMetricDataWithContext(ctx context.Context, request *DescribeTRTCRealTimeQualityMetricDataRequest) (response *DescribeTRTCRealTimeQualityMetricDataResponse, err error)
DescribeTRTCRealTimeQualityMetricData 查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
-视频卡顿率
-音频卡顿率
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
可能返回的错误码:
UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeTRTCRealTimeScaleData ¶ added in v1.0.732
func (c *Client) DescribeTRTCRealTimeScaleData(request *DescribeTRTCRealTimeScaleDataRequest) (response *DescribeTRTCRealTimeScaleDataResponse, err error)
DescribeTRTCRealTimeScaleData 查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
-userCount(在线用户数)
-roomCount(在线房间数)
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/647/81331)。
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
3.除此之外您也可以通过[订阅TRTC包月套餐](https://buy.cloud.tencent.com/trtc)尊享版或旗舰版解锁此接口的调用能力,请在开通包月套餐后,请[提交工单](https://console.cloud.tencent.com/workorder/category)联系售后解锁调用能力
可能返回的错误码:
UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeTRTCRealTimeScaleDataWithContext ¶ added in v1.0.732
func (c *Client) DescribeTRTCRealTimeScaleDataWithContext(ctx context.Context, request *DescribeTRTCRealTimeScaleDataRequest) (response *DescribeTRTCRealTimeScaleDataResponse, err error)
DescribeTRTCRealTimeScaleData 查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
-userCount(在线用户数)
-roomCount(在线房间数)
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/647/81331)。
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
3.除此之外您也可以通过[订阅TRTC包月套餐](https://buy.cloud.tencent.com/trtc)尊享版或旗舰版解锁此接口的调用能力,请在开通包月套餐后,请[提交工单](https://console.cloud.tencent.com/workorder/category)联系售后解锁调用能力
可能返回的错误码:
UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeTRTCRealTimeScaleMetricData ¶ added in v1.0.530
func (c *Client) DescribeTRTCRealTimeScaleMetricData(request *DescribeTRTCRealTimeScaleMetricDataRequest) (response *DescribeTRTCRealTimeScaleMetricDataResponse, err error)
DescribeTRTCRealTimeScaleMetricData 查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
-userCount(在线用户数)
-roomCount(在线房间数)
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
xa0
3.除此之外您也可以通过订阅TRTC包月套餐(https://buy.cloud.tencent.com/trtc)尊享版或旗舰版解锁此接口(DescribeTRTCRealTimeScaleMetricData)的调用能力,请在开通包月套餐后,请提交工单联系售后解锁调用能力https://console.cloud.tencent.com/workorder/category
可能返回的错误码:
UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeTRTCRealTimeScaleMetricDataWithContext ¶ added in v1.0.530
func (c *Client) DescribeTRTCRealTimeScaleMetricDataWithContext(ctx context.Context, request *DescribeTRTCRealTimeScaleMetricDataRequest) (response *DescribeTRTCRealTimeScaleMetricDataResponse, err error)
DescribeTRTCRealTimeScaleMetricData 查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
-userCount(在线用户数)
-roomCount(在线房间数)
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
xa0
3.除此之外您也可以通过订阅TRTC包月套餐(https://buy.cloud.tencent.com/trtc)尊享版或旗舰版解锁此接口(DescribeTRTCRealTimeScaleMetricData)的调用能力,请在开通包月套餐后,请提交工单联系售后解锁调用能力https://console.cloud.tencent.com/workorder/category
可能返回的错误码:
UNSUPPORTEDOPERATION = "UnsupportedOperation"
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) DescribeTrtcRoomUsage ¶ added in v1.0.623
func (c *Client) DescribeTrtcRoomUsage(request *DescribeTrtcRoomUsageRequest) (response *DescribeTrtcRoomUsageResponse, err error)
DescribeTrtcRoomUsage 查询TRTC音视频房间维度用量。
- 单次只能查询一天数据,返回查询时间段内的汇总数据;通过多次查询可以查不同天数据。若查询跨天用量,由于统计延迟等原因,返回数据可能不够准确。
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用,不可用于账单核对,如需对账请使用账号/应用维度用量API:DescribeTrtcUsage。
- 默认接口请求频率限制:1次/15秒。
- 数据最早可查日期为2023年4月1日0点,最大可查范围近3个月。
可能返回的错误码:
FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist" INTERNALERROR_DBERROR = "InternalError.DBError" INVALIDPARAMETER = "InvalidParameter"
func (*Client) DescribeTrtcRoomUsageWithContext ¶ added in v1.0.623
func (c *Client) DescribeTrtcRoomUsageWithContext(ctx context.Context, request *DescribeTrtcRoomUsageRequest) (response *DescribeTrtcRoomUsageResponse, err error)
DescribeTrtcRoomUsage 查询TRTC音视频房间维度用量。
- 单次只能查询一天数据,返回查询时间段内的汇总数据;通过多次查询可以查不同天数据。若查询跨天用量,由于统计延迟等原因,返回数据可能不够准确。
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用,不可用于账单核对,如需对账请使用账号/应用维度用量API:DescribeTrtcUsage。
- 默认接口请求频率限制:1次/15秒。
- 数据最早可查日期为2023年4月1日0点,最大可查范围近3个月。
可能返回的错误码:
FAILEDOPERATION_SDKAPPIDNOTEXIST = "FailedOperation.SdkAppIdNotExist" INTERNALERROR_DBERROR = "InternalError.DBError" INVALIDPARAMETER = "InvalidParameter"
func (*Client) DescribeTrtcUsage ¶ added in v1.0.514
func (c *Client) DescribeTrtcUsage(request *DescribeTrtcUsageRequest) (response *DescribeTrtcUsageResponse, err error)
DescribeTrtcUsage 获取TRTC音视频互动的用量明细。
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
- 单次查询统计区间最多不能超过31天。
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
- 默认接口请求频率限制:5次/秒。
可能返回的错误码:
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
func (*Client) DescribeTrtcUsageWithContext ¶ added in v1.0.514
func (c *Client) DescribeTrtcUsageWithContext(ctx context.Context, request *DescribeTrtcUsageRequest) (response *DescribeTrtcUsageResponse, err error)
DescribeTrtcUsage 获取TRTC音视频互动的用量明细。
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
- 单次查询统计区间最多不能超过31天。
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
- 默认接口请求频率限制:5次/秒。
可能返回的错误码:
INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
func (*Client) DescribeUnusualEvent ¶ added in v1.0.449
func (c *Client) DescribeUnusualEvent(request *DescribeUnusualEventRequest) (response *DescribeUnusualEventResponse, err error)
DescribeUnusualEvent 查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。(同老接口DescribeAbnormalEvent)
异常体验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) DescribeUnusualEventWithContext ¶ added in v1.0.449
func (c *Client) DescribeUnusualEventWithContext(ctx context.Context, request *DescribeUnusualEventRequest) (response *DescribeUnusualEventResponse, err error)
DescribeUnusualEvent 查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。(同老接口DescribeAbnormalEvent)
异常体验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) DescribeUserEvent ¶ added in v1.0.449
func (c *Client) DescribeUserEvent(request *DescribeUserEventRequest) (response *DescribeUserEventResponse, err error)
DescribeUserEvent 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
可能返回的错误码:
INTERNALERROR = "InternalError" INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError" INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied" INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr" INTERNALERROR_METHODERR = "InternalError.MethodErr" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs" INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs" INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize" INVALIDPARAMETER_URLPARAMSERROR = "InvalidParameter.UrlParamsError" INVALIDPARAMETER_USERID = "InvalidParameter.UserId" MISSINGPARAMETER = "MissingParameter" MISSINGPARAMETER_APPID = "MissingParameter.AppId" MISSINGPARAMETER_COMMID = "MissingParameter.CommId" MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId" MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs" MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId" MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs" MISSINGPARAMETER_USERID = "MissingParameter.UserId"
func (*Client) DescribeUserEventWithContext ¶ added in v1.0.449
func (c *Client) DescribeUserEventWithContext(ctx context.Context, request *DescribeUserEventRequest) (response *DescribeUserEventResponse, err error)
DescribeUserEvent 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
可能返回的错误码:
INTERNALERROR = "InternalError" INTERNALERROR_ESQUERYERROR = "InternalError.EsQueryError" INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied" INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr" INTERNALERROR_METHODERR = "InternalError.MethodErr" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_ENDTS = "InvalidParameter.EndTs" INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs" INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize" INVALIDPARAMETER_URLPARAMSERROR = "InvalidParameter.UrlParamsError" INVALIDPARAMETER_USERID = "InvalidParameter.UserId" MISSINGPARAMETER = "MissingParameter" MISSINGPARAMETER_APPID = "MissingParameter.AppId" MISSINGPARAMETER_COMMID = "MissingParameter.CommId" MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId" MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs" MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId" MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs" MISSINGPARAMETER_USERID = "MissingParameter.UserId"
func (*Client) DescribeUserInfo ¶ added in v1.0.449
func (c *Client) DescribeUserInfo(request *DescribeUserInfoRequest) (response *DescribeUserInfoResponse, err error)
DescribeUserInfo 查询指定时间内的用户列表,最大可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。(同老接口DescribeUserInformation)
**注意**:
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任选其一解锁:
方式一:通过订阅[包月套餐](https://cloud.tencent.com/document/product/647/85386)「尊享版」(可查近7天)和「旗舰版」(可查近14天),[前往订阅](https://buy.cloud.tencent.com/trtc?trtcversion=top)。
方式二:通过订阅[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)商业套餐包「基础版」(可查近7天)和「进阶版」(可查近14天),[前往订阅](https://buy.cloud.tencent.com/trtc_monitor)。
可能返回的错误码:
INTERNALERROR = "InternalError" INTERNALERROR_DBERROR = "InternalError.DBError" INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied" INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr" INTERNALERROR_METHODERR = "InternalError.MethodErr" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams" INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber" INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize" INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize" INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize" INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs" INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize" INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix" MISSINGPARAMETER = "MissingParameter" MISSINGPARAMETER_COMMID = "MissingParameter.CommId" MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId" MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"
func (*Client) DescribeUserInfoWithContext ¶ added in v1.0.449
func (c *Client) DescribeUserInfoWithContext(ctx context.Context, request *DescribeUserInfoRequest) (response *DescribeUserInfoResponse, err error)
DescribeUserInfo 查询指定时间内的用户列表,最大可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。(同老接口DescribeUserInformation)
**注意**:
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任选其一解锁:
方式一:通过订阅[包月套餐](https://cloud.tencent.com/document/product/647/85386)「尊享版」(可查近7天)和「旗舰版」(可查近14天),[前往订阅](https://buy.cloud.tencent.com/trtc?trtcversion=top)。
方式二:通过订阅[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)商业套餐包「基础版」(可查近7天)和「进阶版」(可查近14天),[前往订阅](https://buy.cloud.tencent.com/trtc_monitor)。
可能返回的错误码:
INTERNALERROR = "InternalError" INTERNALERROR_DBERROR = "InternalError.DBError" INTERNALERROR_HTTPPARASEFALIED = "InternalError.HttpParaseFalied" INTERNALERROR_INTERFACEERR = "InternalError.InterfaceErr" INTERNALERROR_METHODERR = "InternalError.MethodErr" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_ENCODEPARAMS = "InvalidParameter.EncodeParams" INVALIDPARAMETER_PAGENUMBER = "InvalidParameter.PageNumber" INVALIDPARAMETER_PAGESIZE = "InvalidParameter.PageSize" INVALIDPARAMETER_PAGESIZEOVERSIZE = "InvalidParameter.PageSizeOversize" INVALIDPARAMETER_QUERYSCALEOVERSIZE = "InvalidParameter.QueryScaleOversize" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" INVALIDPARAMETER_STARTTIMEOVERSIZE = "InvalidParameter.StartTimeOversize" INVALIDPARAMETER_STARTTS = "InvalidParameter.StartTs" INVALIDPARAMETER_STARTTSOVERSIZE = "InvalidParameter.StartTsOversize" INVALIDPARAMETER_USERIDSMORETHANSIX = "InvalidParameter.UserIdsMorethanSix" MISSINGPARAMETER = "MissingParameter" MISSINGPARAMETER_COMMID = "MissingParameter.CommId" MISSINGPARAMETER_COMMIDORSDKAPPID = "MissingParameter.CommIdOrSdkAppId" MISSINGPARAMETER_ENDTS = "MissingParameter.EndTs" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_STARTTS = "MissingParameter.StartTs"
func (*Client) DescribeWebRecord ¶ added in v1.0.883
func (c *Client) DescribeWebRecord(request *DescribeWebRecordRequest) (response *DescribeWebRecordResponse, err error)
DescribeWebRecord 查询页面录制任务
可能返回的错误码:
FAILEDOPERATION_TASKNOTEXIST = "FailedOperation.TaskNotExist" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
func (*Client) DescribeWebRecordWithContext ¶ added in v1.0.883
func (c *Client) DescribeWebRecordWithContext(ctx context.Context, request *DescribeWebRecordRequest) (response *DescribeWebRecordResponse, err error)
DescribeWebRecord 查询页面录制任务
可能返回的错误码:
FAILEDOPERATION_TASKNOTEXIST = "FailedOperation.TaskNotExist" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
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) 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) StartAITranscription ¶ added in v1.0.925
func (c *Client) StartAITranscription(request *StartAITranscriptionRequest) (response *StartAITranscriptionResponse, err error)
StartAITranscription 这个接口调用后,后台会启动转录机器人,实时进行语音识别并下发字幕和转录消息。
转录机器人支持两种拉流方式,通过TranscriptionMode字段控制:
- 拉取全房间的流。
- 拉取特定用户的流。
服务端实时下发字幕和会议记录有两种方式,通过IMAdminUserId和IMAdminUserSig字段控制:
- 如果填写IMAdminUserId和IMAdminUserSig,服务端会调用IM的[发送群组消息](https://cloud.tencent.com/document/product/269/1629)API来向端上实时下发消息。客户端只需监听群组消息的回调即可,比如[web端回调](https://cloud.tencent.com/document/product/269/75319)。
- 如果不填写IMAdminUserId和IMAdminUserSig,服务端使用TRTC自定义消息通道下发消息,CmdId固定是1。客户端只需监听自定义消息的回调即可,比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a25187089e1565)。
服务端实时下发的消息是JSON字符串,实时字幕具体格式如下:
`{
"type": "subtitle", "userid": "xxx", "text": "xxx", "translation_text": "xxx", "start_time": "00:00:02", "end_time": "00:00:05"
}`
字段作用如下:
- type是subtitle,表示这是实时字幕消息。
- userid表示是哪个用户说的话。
- text是语音识别出的文本。
- translation_text是text翻译后的文本,如果不启用翻译,则是空字符串。
- start_time和end_time表示该字幕消息从任务开启后的开始和结束时间。
转录消息具体格式如下:
`{
"type": "transcription", "userid": "xxx", "text": "xxx", "translation_text": "xx", "start_time": "00:00:02", "end_time": "00:00:05"
}`
字段作用如下:
- type是transcription,表示这是转录消息。
- 其余字段同实时字幕消息。
转录消息和实时字幕消息的区别是,转录消息是完整的一句话,实时字幕消息则是这一句话的中间阶段。
假如有一句完整的话,“今天天气怎么样?”,那么服务的下发消息的顺序可能是这样:
- 字幕消息,“今天”
- 字幕消息,“今天天气”
- 字幕消息,“今天天气怎么样”
- 转录消息,“今天天气怎么样?”
可能返回的错误码:
FAILEDOPERATION_NOTABILITY = "FailedOperation.NotAbility" FAILEDOPERATION_SDKAPPIDNOTUNDERAPPID = "FailedOperation.SdkAppIdNotUnderAppId" FAILEDOPERATION_TASKEXIST = "FailedOperation.TaskExist" INVALIDPARAMETER_USERSIG = "InvalidParameter.UserSig" INVALIDPARAMETER_USERSIGNOTADMIN = "InvalidParameter.UserSigNotAdmin" RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection"
func (*Client) StartAITranscriptionWithContext ¶ added in v1.0.925
func (c *Client) StartAITranscriptionWithContext(ctx context.Context, request *StartAITranscriptionRequest) (response *StartAITranscriptionResponse, err error)
StartAITranscription 这个接口调用后,后台会启动转录机器人,实时进行语音识别并下发字幕和转录消息。
转录机器人支持两种拉流方式,通过TranscriptionMode字段控制:
- 拉取全房间的流。
- 拉取特定用户的流。
服务端实时下发字幕和会议记录有两种方式,通过IMAdminUserId和IMAdminUserSig字段控制:
- 如果填写IMAdminUserId和IMAdminUserSig,服务端会调用IM的[发送群组消息](https://cloud.tencent.com/document/product/269/1629)API来向端上实时下发消息。客户端只需监听群组消息的回调即可,比如[web端回调](https://cloud.tencent.com/document/product/269/75319)。
- 如果不填写IMAdminUserId和IMAdminUserSig,服务端使用TRTC自定义消息通道下发消息,CmdId固定是1。客户端只需监听自定义消息的回调即可,比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a25187089e1565)。
服务端实时下发的消息是JSON字符串,实时字幕具体格式如下:
`{
"type": "subtitle", "userid": "xxx", "text": "xxx", "translation_text": "xxx", "start_time": "00:00:02", "end_time": "00:00:05"
}`
字段作用如下:
- type是subtitle,表示这是实时字幕消息。
- userid表示是哪个用户说的话。
- text是语音识别出的文本。
- translation_text是text翻译后的文本,如果不启用翻译,则是空字符串。
- start_time和end_time表示该字幕消息从任务开启后的开始和结束时间。
转录消息具体格式如下:
`{
"type": "transcription", "userid": "xxx", "text": "xxx", "translation_text": "xx", "start_time": "00:00:02", "end_time": "00:00:05"
}`
字段作用如下:
- type是transcription,表示这是转录消息。
- 其余字段同实时字幕消息。
转录消息和实时字幕消息的区别是,转录消息是完整的一句话,实时字幕消息则是这一句话的中间阶段。
假如有一句完整的话,“今天天气怎么样?”,那么服务的下发消息的顺序可能是这样:
- 字幕消息,“今天”
- 字幕消息,“今天天气”
- 字幕消息,“今天天气怎么样”
- 转录消息,“今天天气怎么样?”
可能返回的错误码:
FAILEDOPERATION_NOTABILITY = "FailedOperation.NotAbility" FAILEDOPERATION_SDKAPPIDNOTUNDERAPPID = "FailedOperation.SdkAppIdNotUnderAppId" FAILEDOPERATION_TASKEXIST = "FailedOperation.TaskExist" INVALIDPARAMETER_USERSIG = "InvalidParameter.UserSig" INVALIDPARAMETER_USERSIGNOTADMIN = "InvalidParameter.UserSigNotAdmin" RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection"
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 = "FailedOperation" FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection" FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist" FAILEDOPERATION_TASKFINISHED = "FailedOperation.TaskFinished" INTERNALERROR = "InternalError" INTERNALERROR_GETROOMFROMCACHEERROR = "InternalError.GetRoomFromCacheError" INTERNALERROR_INTERNALERROR = "InternalError.InternalError" INVALIDPARAMETER_AUDIOENCODEPARAMS = "InvalidParameter.AudioEncodeParams" INVALIDPARAMETER_BACKGROUNDIMAGEURL = "InvalidParameter.BackgroundImageUrl" 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" RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection" RESOURCENOTFOUND = "ResourceNotFound" 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 = "FailedOperation" FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection" FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist" FAILEDOPERATION_TASKFINISHED = "FailedOperation.TaskFinished" INTERNALERROR = "InternalError" INTERNALERROR_INTERNALERROR = "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_STRROOMID = "InvalidParameter.StrRoomId" 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" RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection" RESOURCENOTFOUND = "ResourceNotFound" 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 = "FailedOperation" FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection" FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist" FAILEDOPERATION_TASKFINISHED = "FailedOperation.TaskFinished" INTERNALERROR = "InternalError" INTERNALERROR_INTERNALERROR = "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_STRROOMID = "InvalidParameter.StrRoomId" 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" RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection" RESOURCENOTFOUND = "ResourceNotFound" 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 = "FailedOperation" FAILEDOPERATION_REQUESTREJECTION = "FailedOperation.RequestRejection" FAILEDOPERATION_ROOMNOTEXIST = "FailedOperation.RoomNotExist" FAILEDOPERATION_TASKFINISHED = "FailedOperation.TaskFinished" INTERNALERROR = "InternalError" INTERNALERROR_GETROOMFROMCACHEERROR = "InternalError.GetRoomFromCacheError" INTERNALERROR_INTERNALERROR = "InternalError.InternalError" INVALIDPARAMETER_AUDIOENCODEPARAMS = "InvalidParameter.AudioEncodeParams" INVALIDPARAMETER_BACKGROUNDIMAGEURL = "InvalidParameter.BackgroundImageUrl" 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" RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
func (*Client) StartPublishCdnStream ¶ added in v1.0.515
func (c *Client) StartPublishCdnStream(request *StartPublishCdnStreamRequest) (response *StartPublishCdnStreamResponse, err error)
StartPublishCdnStream TRTC房间中可能会同时存在多路音视频流,您可以通过混流转推API,通知腾讯云服务端将同个房间或者多个房间的多路视频画面混合到一起,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看,同时可以支持将这一路音视频的混流回推到TRTC房间内部。
云api混流转推功能包含三个接口:
1、StartPublishCdnStream:启动一个混流转推任务,此接口会发起一个新的混流转推任务,启动成功后会返回一个sdkappid维度唯一的任务id(TaskId)。您需要保存该TaskId,后续需要依赖此TaskId更新任务和结束任务。
2、UpdatePublishCdnStream:更新指定的混流转推任务,包括:更新视频画面的布局、更新混音列表、更新转推cdn的地址列表以及更新回推房间列表。
3、StopPublishCdnStream:停止指定的混流转推任务。
您可以通过此套接口实现目标:
1、设置最终混流的画质和音质,包括视频分辨率、视频帧率、视频码率,和音频质量。
2、设置每一路画面的布局位置,您只需要设置一次,后续您指定的混流用户进房上行音视频时,排版引擎会自动将该用户的画面混合到您指定的布局位置。同时您可以使用更新接口调整画面的布局位置。
3、设置多个cdn转推的目的地址,一个转推任务最多可以同时设置10个cdn转推地址,如果您需要转推非腾讯云的cdn地址时,需要联系腾讯云开通能力。
4、设置多个回推房间列表,一个转推任务最多可以同时将混流回推到10个TRTC房间。
目前已经支持如下几种布局模版,其中动态布局模版(悬浮模板、九宫格模板、屏幕分享模板)只支持单个TRTC房间,自定义模版支持混合多个TRTC房间内的音视频流。具体说明如下:
1、悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频默认不占布局配置,也支持设置。每个子画面默认采用居中裁剪的方式进行渲染,也支持统一设置子画面的渲染方式。
2、九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,默认不占布局配置,也支持设置。每个子画面默认采用居中裁剪的方式进行渲染,也支持统一设置子画面的渲染方式。
3、屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,需要您明确设置占据大画面的混流用户信息。其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理,也支持统一设置子画面的渲染方式。
4、自定义布局模版:支持您主动根据业务需要设置布局位置,每个预设的布局位置支持具名设置(具名设置需要明确指定房间号和用户名)和不具名设置。当一个子画面具名设置时,该位置就为该用户预留,用户进房且上行音视频数据时会自动占据该位置,其它用户不会占据该位置。当预设的布局位置未具名时,排版引擎会根据进房间顺序自动填充,预设位置填满时,不再混合其它用户的画面和声音。每个子画面位置支持设置占位图(BackgroundImageUrl),当用户未进房或者只上行音频数据时,该位置画面可显示对应的占位图画面。
您可以控制台开通旁路转推回调功能实现转推cdn状态的事件监控,具体说明请参考官网文档:[旁路转推回调说明](https://cloud.tencent.com/document/product/647/88552)
您使用转推api时根据使用特性可能会产生如下费用:
MCU混流转码费用请参考文档:[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)
转推非腾讯云CDN费用请参考文档:[云端转推计费说明](https://cloud.tencent.com/document/product/647/82155)
参数的使用说明:
1、AgentParams:每个转推任务会拉起一个机器人用户进入TRTC房间进行拉流,您需要通过AgentParams.UserId参数进行设置,这个机器人id不能和房间中的普通用户id冲突,否则会导致转推任务由于机器人用户被踢出TRTC房间而异常结束,您可以通过增加特殊前缀的方式规避。您可以通过设置AgentParams.MaxIdleTime控制转推任务的自动结束,当设置此参数时,所有参与混流转推的主播持续离开TRTC房间超过MaxIdleTime的时长,自动停止转推任务。注意:参与混流转推的主播仅是停止音视频上行,转推任务不会自动停止。
2、WithTranscoding:如果需要将多路音视频流混合到一路时,WithTranscoding必须设置为1。
3、AudioParams:转推任务音频参数和视频参数是分开设置的,若您想要将指定的用户音频进行混音时,需要明确设置AudioParams.SubscribeAudioList。若您不设置AudioParams.SubscribeAudioList,混音引擎会自动将TRTC房间中所有用户的音频混合。若您想要混合TRTC房间除指定用户之外的所有用户的声音,可以通过AudioParams.UnSubscribeAudioList设置音频黑名单列表。
4、VideoParams:若您想要将用户的视频混合,可以通过VideoParams设置,若只想要混纯音频,则不用设置VideoParams参数。您可以通过VideoParams.LayoutParams.MixLayoutMode设置画面的布局模式,包括:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局)和自定义布局。动态布局模式由排版引擎按照固定的布局自动混合,不需要设置VideoParams.LayoutParams.MixLayoutList。当使用悬浮布局和屏幕分享布局时,您可以通过设置VideoParams.LayoutParams.MaxVideoUser参数指定大画面用户。自定义布局模式提供给您自主布局画面的能力,可以通过VideoParams.LayoutParams.MixLayoutList参数指定每个用户所在的布局位置。在每个布局参数中,您可以通过用户媒体流参数(UserMediaStream)指定这个布局位置为指定的用户预留,也可以不设置UserMediaStream,由排版引擎按照用户进入TRTC房间的顺序自动填充,另外您也可以设置每个布局位置的渲染方式(RenderMode)和裁剪方式(CustomCrop)。
5、VideoParams.WaterMarkList:若您想要混流画面中叠加水印,可以通过VideoParams.WaterMarkList参数设置,支持图片水印和文字水印,支持透明通道。
6、SingleSubscribeParams:若您想要将TRTC房间中的一路单流推到CDN,可以使用SingleSubscribeParams参数设置,此时需要将WithTranscoding参数设置为0。
7、PublishCdnParams.N:若您想要推流到CDN,可以使用PublishCdnParams.N参数设置,支持最多同时推流到10个CDN地址。若转推地址是腾讯云CDN时,请将IsTencentCdn明确设置为1;若您有转推非腾讯云CDN的需求时,请联系腾讯云技术支持开通,转推非腾讯云会产生转推费用,费用说明请参考官网文档:[云端转推计费说明](https://cloud.tencent.com/document/product/647/82155)。
8、FeedBackRoomParams.N:若您想要将混合的音视频流回推到TRTC房间,可以使用FeedBackRoomParams.N参数设置,支持最多同时推10路流回TRTC房间。您需要指定回推的TRTC房间号和机器人ID(UserId),机器人ID不能与普通用户ID冲突,否则会导致转推任务由于机器人用户被踢出TRTC房间而异常结束,您可以通过增加特殊前缀的方式规避。
9、SeiParams:若您想要混合的音视频流中增加SEI信息时,可以使用SeiParams参数设置,支持音量布局SEI和叠加转推请求中的SEI,其中音量布局SEI的内容是固定的json结构,具体请看本章节后续的SEI说明。您可以通过FollowIdr参数设置SEI跟随关键帧一起发送。音量布局sei的说明如下:
如果您的CDN观众端需要识别到参与混流的主播位置,以及需要识别到参与混流的主播的音量信息,可以通过音量布局sei实现。音量布局sei的payload内容及参数说明如下:
```
{
"app_data":"", "canvas":{ "w":1080, "h":960 }, "regions":[ { "uid":"65949987242835883c", "zorder":2, "volume":45, "x":270, "y":480, "w":540, "h":480 }, { "uid":"659c9d8d242b328d31", "zorder":2, "volume":0, "x":0, "y":0, "w":540, "h":480 }, { "uid":"64989a82272b308c", "zorder":2, "volume":91, "x":540, "y":0, "w":540, "h":480 } ], "ver":"1.0", "ts":1648544726
}
```
canvas:这个是混流信令中VideoEncode设置的宽高,即:混流输出的整个画布宽高。
regions:里面是真实混入的用户id和对应的子画面位置,若参与混流的用户未进入TRTC房间或者未开启视频上行,regions中不会包含该用户。
uid:代表参与混流的用户ID。
zorder:参与混流userid在混流输出的层级。
x/y:参与混流userid的子画面在画布的坐标。
w/h:参与混流userid的子画面的大小。
volume:代表混流用户的音量,取值范围为0-100,值越大,代表该用户参与混流时的音量越大。
ts:是输出sei的服务器本地秒级时戳。
ver:可以忽略。
其它使用注意事项:
1、使用混流转推接口时,您需要先调用启动转推任务接口(StartPublishCdnStream),获取启动转推任务响应中的任务ID标识(TaskId)。后续传入任务ID标识(TaskId)来更新转推任务(UpdatePublishCdnStream)和停止转推任务(StopPublishCdnStream)。
2、转推API不支持发起到TRTC控制台配置的自动旁路任务,以及通过TRTC SDK进房接口中设置的自定义流ID的旁路任务。
3、为了确保转推链接的稳定,同一个转推任务不支持纯音频、音视频、纯视频之间的切换。
4、为了确保转推链接的稳定,不支持update时更新视频参数(codec)和音频参数(codec、采样率、码率、声道数)。
5、发起单流旁路任务时,AudioParams和VideoParams都填写表示音视频旁路,如果仅填写AudioParams表示纯音频旁路,任务进行过程中不支持纯音频到音视频的切换。音视频旁路时,VideoParams中的Width、Height、Fps、BitRate、Gop需要按照真实上行参数填写。
6、更新请求中必须携带SequenceNumber参数,用于防止请求乱序。客户保证对同一个任务更新时的SequenceNumber参数递增,否则会导致混流任务更新失败。
7、调用api时region选择说明:如果应用id是1400xxx时,region可填北京、上海、广州、香港,如果您的cdn观众主要在海外,请选择香港;如果应用id是200xxx或400xxx时,region请选择新加坡。
8、回推到TRTC房间的流不会参与其他回推房间任务的混流,满足下面条件之一时,可以参与其他转推cdn任务的混流: (1) 转推cdn任务在视频参数中通过具名方式指定推流机器人参与混流;(2) 转推cdn任务在音频参数中通过白名单方式指定推流机器人参与混流;(3) 转推cdn任务参与混流用户的房间号与回推机器人对应混流用户的房间号完全不同。
9、您可以在主播进房前,提前创建转推任务,结束转推任务时需要主动调用停止接口。如果您没有调用停止转推任务接口时,腾讯云后台会按照所有参与混流的用户没有任何数据上行的时间算起,直到超过启动转推任务时设置的超时时间(AgentParams.MaxIdleTime)为止,自动停止混流转推任务。
可能返回的错误码:
AUTHFAILURE = "AuthFailure" AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated" AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation" AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" MISSINGPARAMETER = "MissingParameter" RESOURCENOTFOUND = "ResourceNotFound" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) StartPublishCdnStreamWithContext ¶ added in v1.0.515
func (c *Client) StartPublishCdnStreamWithContext(ctx context.Context, request *StartPublishCdnStreamRequest) (response *StartPublishCdnStreamResponse, err error)
StartPublishCdnStream TRTC房间中可能会同时存在多路音视频流,您可以通过混流转推API,通知腾讯云服务端将同个房间或者多个房间的多路视频画面混合到一起,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看,同时可以支持将这一路音视频的混流回推到TRTC房间内部。
云api混流转推功能包含三个接口:
1、StartPublishCdnStream:启动一个混流转推任务,此接口会发起一个新的混流转推任务,启动成功后会返回一个sdkappid维度唯一的任务id(TaskId)。您需要保存该TaskId,后续需要依赖此TaskId更新任务和结束任务。
2、UpdatePublishCdnStream:更新指定的混流转推任务,包括:更新视频画面的布局、更新混音列表、更新转推cdn的地址列表以及更新回推房间列表。
3、StopPublishCdnStream:停止指定的混流转推任务。
您可以通过此套接口实现目标:
1、设置最终混流的画质和音质,包括视频分辨率、视频帧率、视频码率,和音频质量。
2、设置每一路画面的布局位置,您只需要设置一次,后续您指定的混流用户进房上行音视频时,排版引擎会自动将该用户的画面混合到您指定的布局位置。同时您可以使用更新接口调整画面的布局位置。
3、设置多个cdn转推的目的地址,一个转推任务最多可以同时设置10个cdn转推地址,如果您需要转推非腾讯云的cdn地址时,需要联系腾讯云开通能力。
4、设置多个回推房间列表,一个转推任务最多可以同时将混流回推到10个TRTC房间。
目前已经支持如下几种布局模版,其中动态布局模版(悬浮模板、九宫格模板、屏幕分享模板)只支持单个TRTC房间,自定义模版支持混合多个TRTC房间内的音视频流。具体说明如下:
1、悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频默认不占布局配置,也支持设置。每个子画面默认采用居中裁剪的方式进行渲染,也支持统一设置子画面的渲染方式。
2、九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,默认不占布局配置,也支持设置。每个子画面默认采用居中裁剪的方式进行渲染,也支持统一设置子画面的渲染方式。
3、屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,需要您明确设置占据大画面的混流用户信息。其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理,也支持统一设置子画面的渲染方式。
4、自定义布局模版:支持您主动根据业务需要设置布局位置,每个预设的布局位置支持具名设置(具名设置需要明确指定房间号和用户名)和不具名设置。当一个子画面具名设置时,该位置就为该用户预留,用户进房且上行音视频数据时会自动占据该位置,其它用户不会占据该位置。当预设的布局位置未具名时,排版引擎会根据进房间顺序自动填充,预设位置填满时,不再混合其它用户的画面和声音。每个子画面位置支持设置占位图(BackgroundImageUrl),当用户未进房或者只上行音频数据时,该位置画面可显示对应的占位图画面。
您可以控制台开通旁路转推回调功能实现转推cdn状态的事件监控,具体说明请参考官网文档:[旁路转推回调说明](https://cloud.tencent.com/document/product/647/88552)
您使用转推api时根据使用特性可能会产生如下费用:
MCU混流转码费用请参考文档:[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)
转推非腾讯云CDN费用请参考文档:[云端转推计费说明](https://cloud.tencent.com/document/product/647/82155)
参数的使用说明:
1、AgentParams:每个转推任务会拉起一个机器人用户进入TRTC房间进行拉流,您需要通过AgentParams.UserId参数进行设置,这个机器人id不能和房间中的普通用户id冲突,否则会导致转推任务由于机器人用户被踢出TRTC房间而异常结束,您可以通过增加特殊前缀的方式规避。您可以通过设置AgentParams.MaxIdleTime控制转推任务的自动结束,当设置此参数时,所有参与混流转推的主播持续离开TRTC房间超过MaxIdleTime的时长,自动停止转推任务。注意:参与混流转推的主播仅是停止音视频上行,转推任务不会自动停止。
2、WithTranscoding:如果需要将多路音视频流混合到一路时,WithTranscoding必须设置为1。
3、AudioParams:转推任务音频参数和视频参数是分开设置的,若您想要将指定的用户音频进行混音时,需要明确设置AudioParams.SubscribeAudioList。若您不设置AudioParams.SubscribeAudioList,混音引擎会自动将TRTC房间中所有用户的音频混合。若您想要混合TRTC房间除指定用户之外的所有用户的声音,可以通过AudioParams.UnSubscribeAudioList设置音频黑名单列表。
4、VideoParams:若您想要将用户的视频混合,可以通过VideoParams设置,若只想要混纯音频,则不用设置VideoParams参数。您可以通过VideoParams.LayoutParams.MixLayoutMode设置画面的布局模式,包括:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局)和自定义布局。动态布局模式由排版引擎按照固定的布局自动混合,不需要设置VideoParams.LayoutParams.MixLayoutList。当使用悬浮布局和屏幕分享布局时,您可以通过设置VideoParams.LayoutParams.MaxVideoUser参数指定大画面用户。自定义布局模式提供给您自主布局画面的能力,可以通过VideoParams.LayoutParams.MixLayoutList参数指定每个用户所在的布局位置。在每个布局参数中,您可以通过用户媒体流参数(UserMediaStream)指定这个布局位置为指定的用户预留,也可以不设置UserMediaStream,由排版引擎按照用户进入TRTC房间的顺序自动填充,另外您也可以设置每个布局位置的渲染方式(RenderMode)和裁剪方式(CustomCrop)。
5、VideoParams.WaterMarkList:若您想要混流画面中叠加水印,可以通过VideoParams.WaterMarkList参数设置,支持图片水印和文字水印,支持透明通道。
6、SingleSubscribeParams:若您想要将TRTC房间中的一路单流推到CDN,可以使用SingleSubscribeParams参数设置,此时需要将WithTranscoding参数设置为0。
7、PublishCdnParams.N:若您想要推流到CDN,可以使用PublishCdnParams.N参数设置,支持最多同时推流到10个CDN地址。若转推地址是腾讯云CDN时,请将IsTencentCdn明确设置为1;若您有转推非腾讯云CDN的需求时,请联系腾讯云技术支持开通,转推非腾讯云会产生转推费用,费用说明请参考官网文档:[云端转推计费说明](https://cloud.tencent.com/document/product/647/82155)。
8、FeedBackRoomParams.N:若您想要将混合的音视频流回推到TRTC房间,可以使用FeedBackRoomParams.N参数设置,支持最多同时推10路流回TRTC房间。您需要指定回推的TRTC房间号和机器人ID(UserId),机器人ID不能与普通用户ID冲突,否则会导致转推任务由于机器人用户被踢出TRTC房间而异常结束,您可以通过增加特殊前缀的方式规避。
9、SeiParams:若您想要混合的音视频流中增加SEI信息时,可以使用SeiParams参数设置,支持音量布局SEI和叠加转推请求中的SEI,其中音量布局SEI的内容是固定的json结构,具体请看本章节后续的SEI说明。您可以通过FollowIdr参数设置SEI跟随关键帧一起发送。音量布局sei的说明如下:
如果您的CDN观众端需要识别到参与混流的主播位置,以及需要识别到参与混流的主播的音量信息,可以通过音量布局sei实现。音量布局sei的payload内容及参数说明如下:
```
{
"app_data":"", "canvas":{ "w":1080, "h":960 }, "regions":[ { "uid":"65949987242835883c", "zorder":2, "volume":45, "x":270, "y":480, "w":540, "h":480 }, { "uid":"659c9d8d242b328d31", "zorder":2, "volume":0, "x":0, "y":0, "w":540, "h":480 }, { "uid":"64989a82272b308c", "zorder":2, "volume":91, "x":540, "y":0, "w":540, "h":480 } ], "ver":"1.0", "ts":1648544726
}
```
canvas:这个是混流信令中VideoEncode设置的宽高,即:混流输出的整个画布宽高。
regions:里面是真实混入的用户id和对应的子画面位置,若参与混流的用户未进入TRTC房间或者未开启视频上行,regions中不会包含该用户。
uid:代表参与混流的用户ID。
zorder:参与混流userid在混流输出的层级。
x/y:参与混流userid的子画面在画布的坐标。
w/h:参与混流userid的子画面的大小。
volume:代表混流用户的音量,取值范围为0-100,值越大,代表该用户参与混流时的音量越大。
ts:是输出sei的服务器本地秒级时戳。
ver:可以忽略。
其它使用注意事项:
1、使用混流转推接口时,您需要先调用启动转推任务接口(StartPublishCdnStream),获取启动转推任务响应中的任务ID标识(TaskId)。后续传入任务ID标识(TaskId)来更新转推任务(UpdatePublishCdnStream)和停止转推任务(StopPublishCdnStream)。
2、转推API不支持发起到TRTC控制台配置的自动旁路任务,以及通过TRTC SDK进房接口中设置的自定义流ID的旁路任务。
3、为了确保转推链接的稳定,同一个转推任务不支持纯音频、音视频、纯视频之间的切换。
4、为了确保转推链接的稳定,不支持update时更新视频参数(codec)和音频参数(codec、采样率、码率、声道数)。
5、发起单流旁路任务时,AudioParams和VideoParams都填写表示音视频旁路,如果仅填写AudioParams表示纯音频旁路,任务进行过程中不支持纯音频到音视频的切换。音视频旁路时,VideoParams中的Width、Height、Fps、BitRate、Gop需要按照真实上行参数填写。
6、更新请求中必须携带SequenceNumber参数,用于防止请求乱序。客户保证对同一个任务更新时的SequenceNumber参数递增,否则会导致混流任务更新失败。
7、调用api时region选择说明:如果应用id是1400xxx时,region可填北京、上海、广州、香港,如果您的cdn观众主要在海外,请选择香港;如果应用id是200xxx或400xxx时,region请选择新加坡。
8、回推到TRTC房间的流不会参与其他回推房间任务的混流,满足下面条件之一时,可以参与其他转推cdn任务的混流: (1) 转推cdn任务在视频参数中通过具名方式指定推流机器人参与混流;(2) 转推cdn任务在音频参数中通过白名单方式指定推流机器人参与混流;(3) 转推cdn任务参与混流用户的房间号与回推机器人对应混流用户的房间号完全不同。
9、您可以在主播进房前,提前创建转推任务,结束转推任务时需要主动调用停止接口。如果您没有调用停止转推任务接口时,腾讯云后台会按照所有参与混流的用户没有任何数据上行的时间算起,直到超过启动转推任务时设置的超时时间(AgentParams.MaxIdleTime)为止,自动停止混流转推任务。
可能返回的错误码:
AUTHFAILURE = "AuthFailure" AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated" AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation" AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" MISSINGPARAMETER = "MissingParameter" RESOURCENOTFOUND = "ResourceNotFound" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) StartStreamIngest ¶ added in v1.0.803
func (c *Client) StartStreamIngest(request *StartStreamIngestRequest) (response *StartStreamIngestResponse, err error)
StartStreamIngest 将一个在线媒体流推到TRTC房间。
使用此接口的前提条件:需要购买 [尊享版或旗舰版套餐包](https://cloud.tencent.com/document/product/647/85386
)
可能返回的错误码:
FAILEDOPERATION_NOTRTMPFUNCTION = "FailedOperation.NotRtmpFunction" FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency" FAILEDOPERATION_TASKEXIST = "FailedOperation.TaskExist" INTERNALERROR_HTTPPARSEFAILED = "InternalError.HttpParseFailed" INTERNALERROR_INTERNALERROR = "InternalError.InternalError" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" INVALIDPARAMETER_STRROOMID = "InvalidParameter.StrRoomId" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId" INVALIDPARAMETER_USERSIG = "InvalidParameter.UserSig" MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_TASKID = "MissingParameter.TaskId" RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection"
func (*Client) StartStreamIngestWithContext ¶ added in v1.0.803
func (c *Client) StartStreamIngestWithContext(ctx context.Context, request *StartStreamIngestRequest) (response *StartStreamIngestResponse, err error)
StartStreamIngest 将一个在线媒体流推到TRTC房间。
使用此接口的前提条件:需要购买 [尊享版或旗舰版套餐包](https://cloud.tencent.com/document/product/647/85386
)
可能返回的错误码:
FAILEDOPERATION_NOTRTMPFUNCTION = "FailedOperation.NotRtmpFunction" FAILEDOPERATION_RESTRICTEDCONCURRENCY = "FailedOperation.RestrictedConcurrency" FAILEDOPERATION_TASKEXIST = "FailedOperation.TaskExist" INTERNALERROR_HTTPPARSEFAILED = "InternalError.HttpParseFailed" INTERNALERROR_INTERNALERROR = "InternalError.InternalError" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_ROOMID = "InvalidParameter.RoomId" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" INVALIDPARAMETER_STRROOMID = "InvalidParameter.StrRoomId" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId" INVALIDPARAMETER_USERSIG = "InvalidParameter.UserSig" MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" MISSINGPARAMETER_TASKID = "MissingParameter.TaskId" RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection"
func (*Client) StartWebRecord ¶ added in v1.0.883
func (c *Client) StartWebRecord(request *StartWebRecordRequest) (response *StartWebRecordResponse, err error)
StartWebRecord 通过此接口可以发起 WEB 页面录制任务,在接口参数中指定录制 URL,录制分辨率,录制结果存储等参数。
因为参数或API逻辑问题会立即返回结果。而因为页面问题,如页面无法访问,会在回调中返回结果,请关注。
可能返回的错误码:
FAILEDOPERATION_NOTABILITY = "FailedOperation.NotAbility" FAILEDOPERATION_SDKAPPIDNOTUNDERAPPID = "FailedOperation.SdkAppIdNotUnderAppId" FAILEDOPERATION_SDKAPPIDNOTWEBRECORDABILITY = "FailedOperation.SdkAppIdNotWebRecordAbility" FAILEDOPERATION_TASKEXIST = "FailedOperation.TaskExist" RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection"
func (*Client) StartWebRecordWithContext ¶ added in v1.0.883
func (c *Client) StartWebRecordWithContext(ctx context.Context, request *StartWebRecordRequest) (response *StartWebRecordResponse, err error)
StartWebRecord 通过此接口可以发起 WEB 页面录制任务,在接口参数中指定录制 URL,录制分辨率,录制结果存储等参数。
因为参数或API逻辑问题会立即返回结果。而因为页面问题,如页面无法访问,会在回调中返回结果,请关注。
可能返回的错误码:
FAILEDOPERATION_NOTABILITY = "FailedOperation.NotAbility" FAILEDOPERATION_SDKAPPIDNOTUNDERAPPID = "FailedOperation.SdkAppIdNotUnderAppId" FAILEDOPERATION_SDKAPPIDNOTWEBRECORDABILITY = "FailedOperation.SdkAppIdNotWebRecordAbility" FAILEDOPERATION_TASKEXIST = "FailedOperation.TaskExist" RESOURCEINSUFFICIENT_REQUESTREJECTION = "ResourceInsufficient.RequestRejection"
func (*Client) StopAITranscription ¶ added in v1.0.925
func (c *Client) StopAITranscription(request *StopAITranscriptionRequest) (response *StopAITranscriptionResponse, err error)
StopAITranscription 停止AI转录任务。
可能返回的错误码:
FAILEDOPERATION_TASKNOTEXIST = "FailedOperation.TaskNotExist" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
func (*Client) StopAITranscriptionWithContext ¶ added in v1.0.925
func (c *Client) StopAITranscriptionWithContext(ctx context.Context, request *StopAITranscriptionRequest) (response *StopAITranscriptionResponse, err error)
StopAITranscription 停止AI转录任务。
可能返回的错误码:
FAILEDOPERATION_TASKNOTEXIST = "FailedOperation.TaskNotExist" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
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" RESOURCENOTFOUND = "ResourceNotFound" 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" INVALIDPARAMETER_STRROOMID = "InvalidParameter.StrRoomId" INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId" MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" RESOURCENOTFOUND = "ResourceNotFound" 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" INVALIDPARAMETER_STRROOMID = "InvalidParameter.StrRoomId" INVALIDPARAMETERVALUE_ROOMID = "InvalidParameterValue.RoomId" MISSINGPARAMETER_ROOMID = "MissingParameter.RoomId" MISSINGPARAMETER_SDKAPPID = "MissingParameter.SdkAppId" RESOURCENOTFOUND = "ResourceNotFound" 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" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION_SDKAPPID = "UnauthorizedOperation.SdkAppId"
func (*Client) StopPublishCdnStream ¶ added in v1.0.515
func (c *Client) StopPublishCdnStream(request *StopPublishCdnStreamRequest) (response *StopPublishCdnStreamResponse, err error)
StopPublishCdnStream 停止转推任务。
可能返回的错误码:
AUTHFAILURE = "AuthFailure" AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated" AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation" AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation" FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" RESOURCENOTFOUND = "ResourceNotFound"
func (*Client) StopPublishCdnStreamWithContext ¶ added in v1.0.515
func (c *Client) StopPublishCdnStreamWithContext(ctx context.Context, request *StopPublishCdnStreamRequest) (response *StopPublishCdnStreamResponse, err error)
StopPublishCdnStream 停止转推任务。
可能返回的错误码:
AUTHFAILURE = "AuthFailure" AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated" AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation" AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation" FAILEDOPERATION_CRUNSUPPORTMETHOD = "FailedOperation.CRUnsupportMethod" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" RESOURCENOTFOUND = "ResourceNotFound"
func (*Client) StopStreamIngest ¶ added in v1.0.803
func (c *Client) StopStreamIngest(request *StopStreamIngestRequest) (response *StopStreamIngestResponse, err error)
StopStreamIngest 停止一个输入在线媒体流任务。
可能返回的错误码:
FAILEDOPERATION_TASKFINISHED = "FailedOperation.TaskFinished" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
func (*Client) StopStreamIngestWithContext ¶ added in v1.0.803
func (c *Client) StopStreamIngestWithContext(ctx context.Context, request *StopStreamIngestRequest) (response *StopStreamIngestResponse, err error)
StopStreamIngest 停止一个输入在线媒体流任务。
可能返回的错误码:
FAILEDOPERATION_TASKFINISHED = "FailedOperation.TaskFinished" INVALIDPARAMETER_BODYPARAMSERROR = "InvalidParameter.BodyParamsError" INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
func (*Client) StopWebRecord ¶ added in v1.0.883
func (c *Client) StopWebRecord(request *StopWebRecordRequest) (response *StopWebRecordResponse, err error)
StopWebRecord 停止页面录制任务
可能返回的错误码:
FAILEDOPERATION_TASKNOTEXIST = "FailedOperation.TaskNotExist" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
func (*Client) StopWebRecordWithContext ¶ added in v1.0.883
func (c *Client) StopWebRecordWithContext(ctx context.Context, request *StopWebRecordRequest) (response *StopWebRecordResponse, err error)
StopWebRecord 停止页面录制任务
可能返回的错误码:
FAILEDOPERATION_TASKNOTEXIST = "FailedOperation.TaskNotExist" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
func (*Client) SummarizeTranscription ¶ added in v1.0.925
func (c *Client) SummarizeTranscription(request *SummarizeTranscriptionRequest) (response *SummarizeTranscriptionResponse, err error)
SummarizeTranscription 对转录的文本进行总结。
可能返回的错误码:
FAILEDOPERATION_TASKNOTEXIST = "FailedOperation.TaskNotExist" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
func (*Client) SummarizeTranscriptionWithContext ¶ added in v1.0.925
func (c *Client) SummarizeTranscriptionWithContext(ctx context.Context, request *SummarizeTranscriptionRequest) (response *SummarizeTranscriptionResponse, err error)
SummarizeTranscription 对转录的文本进行总结。
可能返回的错误码:
FAILEDOPERATION_TASKNOTEXIST = "FailedOperation.TaskNotExist" INVALIDPARAMETER_TASKID = "InvalidParameter.TaskId"
func (*Client) UpdatePublishCdnStream ¶ added in v1.0.515
func (c *Client) UpdatePublishCdnStream(request *UpdatePublishCdnStreamRequest) (response *UpdatePublishCdnStreamResponse, err error)
UpdatePublishCdnStream 更新转推任务。
注:请参见启动转推任务的接口说明和使用说明。
可能返回的错误码:
AUTHFAILURE = "AuthFailure" AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated" AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation" AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_REQUESTOUTDATED = "FailedOperation.RequestOutdated" FAILEDOPERATION_TASKFINISHED = "FailedOperation.TaskFinished" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" RESOURCENOTFOUND = "ResourceNotFound" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) UpdatePublishCdnStreamWithContext ¶ added in v1.0.515
func (c *Client) UpdatePublishCdnStreamWithContext(ctx context.Context, request *UpdatePublishCdnStreamRequest) (response *UpdatePublishCdnStreamResponse, err error)
UpdatePublishCdnStream 更新转推任务。
注:请参见启动转推任务的接口说明和使用说明。
可能返回的错误码:
AUTHFAILURE = "AuthFailure" AUTHFAILURE_UNREALNAMEAUTHENTICATED = "AuthFailure.UnRealNameAuthenticated" AUTHFAILURE_UNAUTHORIZEDOPERATION = "AuthFailure.UnauthorizedOperation" AUTHFAILURE_UNSUPPORTEDOPERATION = "AuthFailure.UnsupportedOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_REQUESTOUTDATED = "FailedOperation.RequestOutdated" FAILEDOPERATION_TASKFINISHED = "FailedOperation.TaskFinished" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" RESOURCENOTFOUND = "ResourceNotFound" UNSUPPORTEDOPERATION = "UnsupportedOperation"
type CloudStorage ¶ added in v1.0.400
type CloudStorage struct { // 腾讯云对象存储COS以及第三方云存储账号信息 // 0:腾讯云对象存储 COS // 1:AWS // 【注意】目前第三方云存储仅支持AWS,更多第三方云存储陆续支持中 // 示例值:0 Vendor *uint64 `json:"Vendor,omitnil,omitempty" name:"Vendor"` // 腾讯云对象存储的[地域信息](https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F)。 // 示例值:cn-shanghai-1 // // AWS S3[地域信息](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions) // 示例值:ap-southeast-3 Region *string `json:"Region,omitnil,omitempty" name:"Region"` // 云存储桶名称。 Bucket *string `json:"Bucket,omitnil,omitempty" name:"Bucket"` // 云存储的access_key账号信息。 // 若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretId值。 // 示例值:test-accesskey AccessKey *string `json:"AccessKey,omitnil,omitempty" name:"AccessKey"` // 云存储的secret_key账号信息。 // 若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretKey值。 // 示例值:test-secretkey SecretKey *string `json:"SecretKey,omitnil,omitempty" name:"SecretKey"` // 云存储bucket 的指定位置,由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-',举个例子,录制文件xxx.m3u8在 ["prefix1", "prefix2"]作用下,会变成prefix1/prefix2/TaskId/xxx.m3u8。 // 示例值:["prefix1", "prefix2"] FileNamePrefix []*string `json:"FileNamePrefix,omitnil,omitempty" name:"FileNamePrefix"` }
type CloudVod ¶ added in v1.0.400
type CloudVod struct { // 腾讯云点播相关参数。 TencentVod *TencentVod `json:"TencentVod,omitnil,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,omitnil,omitempty" name:"SdkAppId"` // TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 录制机器人的UserId,用于进房发起录制任务。 // 【*注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个录制任务时,机器人的userid也不能相互重复,否则会中断前一个录制任务。建议可以把房间ID作为UserId的标识的一部分,即录制机器人UserId在房间内唯一。 UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 录制机器人UserId对应的校验签名,即UserId和UserSig相当于录制机器人进房的登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。 UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"` // 云端录制控制参数。 RecordParams *RecordParams `json:"RecordParams,omitnil,omitempty" name:"RecordParams"` // 云端录制文件上传到云存储的参数(不支持同时设置云点播VOD和对象存储COS) StorageParams *StorageParams `json:"StorageParams,omitnil,omitempty" name:"StorageParams"` // TRTC房间号的类型。 // 【*注意】必须和录制的房间所对应的RoomId类型相同: // 0: 字符串类型的RoomId // 1: 32位整型的RoomId(默认) RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"` // 合流的转码参数,录制模式为合流的时候可以设置。 MixTranscodeParams *MixTranscodeParams `json:"MixTranscodeParams,omitnil,omitempty" name:"MixTranscodeParams"` // 合流的布局参数,录制模式为合流的时候可以设置。 MixLayoutParams *MixLayoutParams `json:"MixLayoutParams,omitnil,omitempty" name:"MixLayoutParams"` // 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。 ResourceExpiredHour *uint64 `json:"ResourceExpiredHour,omitnil,omitempty" name:"ResourceExpiredHour"` // TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。 PrivateMapKey *string `json:"PrivateMapKey,omitnil,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 CreateCloudRecordingRequestParams ¶ added in v1.0.426
type CreateCloudRecordingRequestParams struct { // TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 录制机器人的UserId,用于进房发起录制任务。 // 【*注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个录制任务时,机器人的userid也不能相互重复,否则会中断前一个录制任务。建议可以把房间ID作为UserId的标识的一部分,即录制机器人UserId在房间内唯一。 UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 录制机器人UserId对应的校验签名,即UserId和UserSig相当于录制机器人进房的登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。 UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"` // 云端录制控制参数。 RecordParams *RecordParams `json:"RecordParams,omitnil,omitempty" name:"RecordParams"` // 云端录制文件上传到云存储的参数(不支持同时设置云点播VOD和对象存储COS) StorageParams *StorageParams `json:"StorageParams,omitnil,omitempty" name:"StorageParams"` // TRTC房间号的类型。 // 【*注意】必须和录制的房间所对应的RoomId类型相同: // 0: 字符串类型的RoomId // 1: 32位整型的RoomId(默认) RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"` // 合流的转码参数,录制模式为合流的时候可以设置。 MixTranscodeParams *MixTranscodeParams `json:"MixTranscodeParams,omitnil,omitempty" name:"MixTranscodeParams"` // 合流的布局参数,录制模式为合流的时候可以设置。 MixLayoutParams *MixLayoutParams `json:"MixLayoutParams,omitnil,omitempty" name:"MixLayoutParams"` // 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。 ResourceExpiredHour *uint64 `json:"ResourceExpiredHour,omitnil,omitempty" name:"ResourceExpiredHour"` // TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。 PrivateMapKey *string `json:"PrivateMapKey,omitnil,omitempty" name:"PrivateMapKey"` }
Predefined struct for user
type CreateCloudRecordingResponse ¶ added in v1.0.400
type CreateCloudRecordingResponse struct { *tchttp.BaseResponse Response *CreateCloudRecordingResponseParams `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 CreateCloudRecordingResponseParams ¶ added in v1.0.426
type CreateCloudRecordingResponseParams struct { // 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。任务 ID需要业务保存下来,作为下次针对这个录制任务操作的参数。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type CreatePictureRequest ¶
type CreatePictureRequest struct { *tchttp.BaseRequest // 应用id SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 图片内容经base64编码后的string格式,最大长度为2M Content *string `json:"Content,omitnil,omitempty" name:"Content"` // 图片后缀名 Suffix *string `json:"Suffix,omitnil,omitempty" name:"Suffix"` // 图片长度 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` // 图片宽度 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 显示位置x轴方向 XPosition *uint64 `json:"XPosition,omitnil,omitempty" name:"XPosition"` // 显示位置y轴方向 YPosition *uint64 `json:"YPosition,omitnil,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 CreatePictureRequestParams ¶ added in v1.0.426
type CreatePictureRequestParams struct { // 应用id SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 图片内容经base64编码后的string格式,最大长度为2M Content *string `json:"Content,omitnil,omitempty" name:"Content"` // 图片后缀名 Suffix *string `json:"Suffix,omitnil,omitempty" name:"Suffix"` // 图片长度 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` // 图片宽度 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 显示位置x轴方向 XPosition *uint64 `json:"XPosition,omitnil,omitempty" name:"XPosition"` // 显示位置y轴方向 YPosition *uint64 `json:"YPosition,omitnil,omitempty" name:"YPosition"` }
Predefined struct for user
type CreatePictureResponse ¶
type CreatePictureResponse struct { *tchttp.BaseResponse Response *CreatePictureResponseParams `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 CreatePictureResponseParams ¶ added in v1.0.426
type CreatePictureResponseParams struct { // 图片id PictureId *uint64 `json:"PictureId,omitnil,omitempty" name:"PictureId"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DeleteCloudRecordingRequest ¶ added in v1.0.400
type DeleteCloudRecordingRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 录制任务的唯一Id,在启动录制成功后会返回。 TaskId *string `json:"TaskId,omitnil,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 DeleteCloudRecordingRequestParams ¶ added in v1.0.426
type DeleteCloudRecordingRequestParams struct { // TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 录制任务的唯一Id,在启动录制成功后会返回。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` }
Predefined struct for user
type DeleteCloudRecordingResponse ¶ added in v1.0.400
type DeleteCloudRecordingResponse struct { *tchttp.BaseResponse Response *DeleteCloudRecordingResponseParams `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 DeleteCloudRecordingResponseParams ¶ added in v1.0.426
type DeleteCloudRecordingResponseParams struct { // 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DeletePictureRequest ¶
type DeletePictureRequest struct { *tchttp.BaseRequest // 图片id PictureId *uint64 `json:"PictureId,omitnil,omitempty" name:"PictureId"` // 应用id SdkAppId *uint64 `json:"SdkAppId,omitnil,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 DeletePictureRequestParams ¶ added in v1.0.426
type DeletePictureRequestParams struct { // 图片id PictureId *uint64 `json:"PictureId,omitnil,omitempty" name:"PictureId"` // 应用id SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
Predefined struct for user
type DeletePictureResponse ¶
type DeletePictureResponse struct { *tchttp.BaseResponse Response *DeletePictureResponseParams `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 DeletePictureResponseParams ¶ added in v1.0.426
type DeletePictureResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeAITranscriptionRequest ¶ added in v1.0.925
type DescribeAITranscriptionRequest struct { *tchttp.BaseRequest // 查询任务状态,不使用时传入空字符串。 // 有两种查询方式: // 1、只填写TaskId,这种方式使用TaskId来查询任务 // 2、TaskId为空字符串,填写SdkAppId和SessionId,这种方式不需要使用TaskId查询任务 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // TRTC的SdkAppId,和SessionId配合使用。 SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 开启转录任务时传入的SessionId,和SdkAppId配合使用。 SessionId *string `json:"SessionId,omitnil,omitempty" name:"SessionId"` }
func NewDescribeAITranscriptionRequest ¶ added in v1.0.925
func NewDescribeAITranscriptionRequest() (request *DescribeAITranscriptionRequest)
func (*DescribeAITranscriptionRequest) FromJsonString ¶ added in v1.0.925
func (r *DescribeAITranscriptionRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAITranscriptionRequest) ToJsonString ¶ added in v1.0.925
func (r *DescribeAITranscriptionRequest) ToJsonString() string
type DescribeAITranscriptionRequestParams ¶ added in v1.0.925
type DescribeAITranscriptionRequestParams struct { // 查询任务状态,不使用时传入空字符串。 // 有两种查询方式: // 1、只填写TaskId,这种方式使用TaskId来查询任务 // 2、TaskId为空字符串,填写SdkAppId和SessionId,这种方式不需要使用TaskId查询任务 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // TRTC的SdkAppId,和SessionId配合使用。 SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 开启转录任务时传入的SessionId,和SdkAppId配合使用。 SessionId *string `json:"SessionId,omitnil,omitempty" name:"SessionId"` }
Predefined struct for user
type DescribeAITranscriptionResponse ¶ added in v1.0.925
type DescribeAITranscriptionResponse struct { *tchttp.BaseResponse Response *DescribeAITranscriptionResponseParams `json:"Response"` }
func NewDescribeAITranscriptionResponse ¶ added in v1.0.925
func NewDescribeAITranscriptionResponse() (response *DescribeAITranscriptionResponse)
func (*DescribeAITranscriptionResponse) FromJsonString ¶ added in v1.0.925
func (r *DescribeAITranscriptionResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAITranscriptionResponse) ToJsonString ¶ added in v1.0.925
func (r *DescribeAITranscriptionResponse) ToJsonString() string
type DescribeAITranscriptionResponseParams ¶ added in v1.0.925
type DescribeAITranscriptionResponseParams struct { // 任务开始时间。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 转录任务状态。 // 有4个值: // 1、Idle表示任务未开始 // 2、Preparing表示任务准备中 // 3、InProgress表示任务正在运行 // 4、Stopped表示任务已停止,正在清理资源中 Status *string `json:"Status,omitnil,omitempty" name:"Status"` // 唯一标识一次任务。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 开启转录任务时填写的SessionId,如果没写则不返回。 SessionId *string `json:"SessionId,omitnil,omitempty" name:"SessionId"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeCallDetailInfoRequest ¶ added in v1.0.449
type DescribeCallDetailInfoRequest struct { *tchttp.BaseRequest // 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。 CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"` // 查询开始时间,本地unix时间戳,单位为秒(如:1590065777), // 注意:支持查询14天内的数据。 StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) // 注意:查询起止时间需小于1小时,超过则返回null,即与StartTime间隔时间不超过1小时。 EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 用户SdkAppId(如:1400xxxxxx)。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 需查询的用户数组,默认不填返回6个用户。 UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"` // 需查询的指标,不填则只返回用户列表,填all则返回所有指标。 // appCpu:APP CPU使用率; // sysCpu:系统 CPU使用率; // aBit:上/下行音频码率;单位:bps // aBlock:音频卡顿时长;单位:ms // bigvBit:上/下行视频码率;单位:bps // bigvCapFps:视频采集帧率; // bigvEncFps:视频发送帧率; // bigvDecFps:渲染帧率; // bigvBlock:视频卡顿时长;单位:ms // aLoss:上/下行音频丢包率; // bigvLoss:上/下行视频丢包率; // bigvWidth:上/下行分辨率宽; // bigvHeight:上/下行分辨率高; // aCapEnergy:音频采集能量; // aPlayEnergy:音频播放能量; // rtt:SDK到云端的往返延时;单位: ms DataType []*string `json:"DataType,omitnil,omitempty" name:"DataType"` // 当前页数,默认为0, // 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。 PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"` // 每页个数,默认为6, // 范围:[1,100] // 注意:DataType不为null,UserIds长度不能超过6,PageSize最大值不超过6; // DataType 为null,UserIds长度不超过100,PageSize最大不超过100。 PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"` }
func NewDescribeCallDetailInfoRequest ¶ added in v1.0.449
func NewDescribeCallDetailInfoRequest() (request *DescribeCallDetailInfoRequest)
func (*DescribeCallDetailInfoRequest) FromJsonString ¶ added in v1.0.449
func (r *DescribeCallDetailInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeCallDetailInfoRequest) ToJsonString ¶ added in v1.0.449
func (r *DescribeCallDetailInfoRequest) ToJsonString() string
type DescribeCallDetailInfoRequestParams ¶ added in v1.0.449
type DescribeCallDetailInfoRequestParams struct { // 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。 CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"` // 查询开始时间,本地unix时间戳,单位为秒(如:1590065777), // 注意:支持查询14天内的数据。 StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) // 注意:查询起止时间需小于1小时,超过则返回null,即与StartTime间隔时间不超过1小时。 EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 用户SdkAppId(如:1400xxxxxx)。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 需查询的用户数组,默认不填返回6个用户。 UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"` // 需查询的指标,不填则只返回用户列表,填all则返回所有指标。 // appCpu:APP CPU使用率; // sysCpu:系统 CPU使用率; // aBit:上/下行音频码率;单位:bps // aBlock:音频卡顿时长;单位:ms // bigvBit:上/下行视频码率;单位:bps // bigvCapFps:视频采集帧率; // bigvEncFps:视频发送帧率; // bigvDecFps:渲染帧率; // bigvBlock:视频卡顿时长;单位:ms // aLoss:上/下行音频丢包率; // bigvLoss:上/下行视频丢包率; // bigvWidth:上/下行分辨率宽; // bigvHeight:上/下行分辨率高; // aCapEnergy:音频采集能量; // aPlayEnergy:音频播放能量; // rtt:SDK到云端的往返延时;单位: ms DataType []*string `json:"DataType,omitnil,omitempty" name:"DataType"` // 当前页数,默认为0, // 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。 PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"` // 每页个数,默认为6, // 范围:[1,100] // 注意:DataType不为null,UserIds长度不能超过6,PageSize最大值不超过6; // DataType 为null,UserIds长度不超过100,PageSize最大不超过100。 PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"` }
Predefined struct for user
type DescribeCallDetailInfoResponse ¶ added in v1.0.449
type DescribeCallDetailInfoResponse struct { *tchttp.BaseResponse Response *DescribeCallDetailInfoResponseParams `json:"Response"` }
func NewDescribeCallDetailInfoResponse ¶ added in v1.0.449
func NewDescribeCallDetailInfoResponse() (response *DescribeCallDetailInfoResponse)
func (*DescribeCallDetailInfoResponse) FromJsonString ¶ added in v1.0.449
func (r *DescribeCallDetailInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeCallDetailInfoResponse) ToJsonString ¶ added in v1.0.449
func (r *DescribeCallDetailInfoResponse) ToJsonString() string
type DescribeCallDetailInfoResponseParams ¶ added in v1.0.449
type DescribeCallDetailInfoResponseParams struct { // 返回的用户总条数 Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"` // 用户信息列表 // 注意:此字段可能返回 null,表示取不到有效值。 UserList []*UserInformation `json:"UserList,omitnil,omitempty" name:"UserList"` // 质量数据 // 注意:此字段可能返回 null,表示取不到有效值。 Data []*QualityData `json:"Data,omitnil,omitempty" name:"Data"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeCloudRecordingRequest ¶ added in v1.0.400
type DescribeCloudRecordingRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 录制任务的唯一Id,在启动录制成功后会返回。 TaskId *string `json:"TaskId,omitnil,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 DescribeCloudRecordingRequestParams ¶ added in v1.0.426
type DescribeCloudRecordingRequestParams struct { // TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 录制任务的唯一Id,在启动录制成功后会返回。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` }
Predefined struct for user
type DescribeCloudRecordingResponse ¶ added in v1.0.400
type DescribeCloudRecordingResponse struct { *tchttp.BaseResponse Response *DescribeCloudRecordingResponseParams `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 DescribeCloudRecordingResponseParams ¶ added in v1.0.426
type DescribeCloudRecordingResponseParams struct { // 录制任务的唯一Id。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 云端录制任务的状态信息。 // Idle:表示当前录制任务空闲中 // InProgress:表示当前录制任务正在进行中。 // Exited:表示当前录制任务正在退出的过程中。 Status *string `json:"Status,omitnil,omitempty" name:"Status"` // 录制文件信息。 // 注意:此字段可能返回 null,表示取不到有效值。 StorageFileList []*StorageFile `json:"StorageFileList,omitnil,omitempty" name:"StorageFileList"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeMixTranscodingUsageRequest ¶ added in v1.0.514
type DescribeMixTranscodingUsageRequest struct { *tchttp.BaseRequest // 查询开始时间,格式为YYYY-MM-DD。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 // 单次查询统计区间最多不能超过31天。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
func NewDescribeMixTranscodingUsageRequest ¶ added in v1.0.514
func NewDescribeMixTranscodingUsageRequest() (request *DescribeMixTranscodingUsageRequest)
func (*DescribeMixTranscodingUsageRequest) FromJsonString ¶ added in v1.0.514
func (r *DescribeMixTranscodingUsageRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeMixTranscodingUsageRequest) ToJsonString ¶ added in v1.0.514
func (r *DescribeMixTranscodingUsageRequest) ToJsonString() string
type DescribeMixTranscodingUsageRequestParams ¶ added in v1.0.514
type DescribeMixTranscodingUsageRequestParams struct { // 查询开始时间,格式为YYYY-MM-DD。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 // 单次查询统计区间最多不能超过31天。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
Predefined struct for user
type DescribeMixTranscodingUsageResponse ¶ added in v1.0.514
type DescribeMixTranscodingUsageResponse struct { *tchttp.BaseResponse Response *DescribeMixTranscodingUsageResponseParams `json:"Response"` }
func NewDescribeMixTranscodingUsageResponse ¶ added in v1.0.514
func NewDescribeMixTranscodingUsageResponse() (response *DescribeMixTranscodingUsageResponse)
func (*DescribeMixTranscodingUsageResponse) FromJsonString ¶ added in v1.0.514
func (r *DescribeMixTranscodingUsageResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeMixTranscodingUsageResponse) ToJsonString ¶ added in v1.0.514
func (r *DescribeMixTranscodingUsageResponse) ToJsonString() string
type DescribeMixTranscodingUsageResponseParams ¶ added in v1.0.514
type DescribeMixTranscodingUsageResponseParams struct { // 用量类型,与UsageValue中各个位置的值对应。 UsageKey []*string `json:"UsageKey,omitnil,omitempty" name:"UsageKey"` // 各个时间点用量明细。 UsageList []*TrtcUsage `json:"UsageList,omitnil,omitempty" name:"UsageList"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribePictureRequest ¶
type DescribePictureRequest struct { *tchttp.BaseRequest // 应用ID SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 图片ID,不填时返回该应用下所有图片 PictureId *uint64 `json:"PictureId,omitnil,omitempty" name:"PictureId"` // 每页数量,不填时默认为10 PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"` // 页码,不填时默认为1 PageNo *uint64 `json:"PageNo,omitnil,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 DescribePictureRequestParams ¶ added in v1.0.426
type DescribePictureRequestParams struct { // 应用ID SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 图片ID,不填时返回该应用下所有图片 PictureId *uint64 `json:"PictureId,omitnil,omitempty" name:"PictureId"` // 每页数量,不填时默认为10 PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"` // 页码,不填时默认为1 PageNo *uint64 `json:"PageNo,omitnil,omitempty" name:"PageNo"` }
Predefined struct for user
type DescribePictureResponse ¶
type DescribePictureResponse struct { *tchttp.BaseResponse Response *DescribePictureResponseParams `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 DescribePictureResponseParams ¶ added in v1.0.426
type DescribePictureResponseParams struct { // 返回的图片记录数 Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"` // 图片信息列表 PictureInfo []*PictureInfo `json:"PictureInfo,omitnil,omitempty" name:"PictureInfo"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeRecordStatisticRequest ¶
type DescribeRecordStatisticRequest struct { *tchttp.BaseRequest // 查询开始日期,格式为YYYY-MM-DD。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束日期,格式为YYYY-MM-DD。 // 单次查询统计区间最多不能超过31天。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。 SdkAppId *uint64 `json:"SdkAppId,omitnil,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 DescribeRecordStatisticRequestParams ¶ added in v1.0.426
type DescribeRecordStatisticRequestParams struct { // 查询开始日期,格式为YYYY-MM-DD。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束日期,格式为YYYY-MM-DD。 // 单次查询统计区间最多不能超过31天。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
Predefined struct for user
type DescribeRecordStatisticResponse ¶
type DescribeRecordStatisticResponse struct { *tchttp.BaseResponse Response *DescribeRecordStatisticResponseParams `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 DescribeRecordStatisticResponseParams ¶ added in v1.0.426
type DescribeRecordStatisticResponseParams struct { // 应用的用量信息数组。 SdkAppIdUsages []*SdkAppIdRecordUsage `json:"SdkAppIdUsages,omitnil,omitempty" name:"SdkAppIdUsages"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeRecordingUsageRequest ¶ added in v1.0.514
type DescribeRecordingUsageRequest struct { *tchttp.BaseRequest // 查询开始时间,格式为YYYY-MM-DD。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 // 单次查询统计区间最多不能超过31天。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 查询单流录制或合流录制,值为"single"或"multi"。 MixType *string `json:"MixType,omitnil,omitempty" name:"MixType"` // TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
func NewDescribeRecordingUsageRequest ¶ added in v1.0.514
func NewDescribeRecordingUsageRequest() (request *DescribeRecordingUsageRequest)
func (*DescribeRecordingUsageRequest) FromJsonString ¶ added in v1.0.514
func (r *DescribeRecordingUsageRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeRecordingUsageRequest) ToJsonString ¶ added in v1.0.514
func (r *DescribeRecordingUsageRequest) ToJsonString() string
type DescribeRecordingUsageRequestParams ¶ added in v1.0.514
type DescribeRecordingUsageRequestParams struct { // 查询开始时间,格式为YYYY-MM-DD。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 // 单次查询统计区间最多不能超过31天。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 查询单流录制或合流录制,值为"single"或"multi"。 MixType *string `json:"MixType,omitnil,omitempty" name:"MixType"` // TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
Predefined struct for user
type DescribeRecordingUsageResponse ¶ added in v1.0.514
type DescribeRecordingUsageResponse struct { *tchttp.BaseResponse Response *DescribeRecordingUsageResponseParams `json:"Response"` }
func NewDescribeRecordingUsageResponse ¶ added in v1.0.514
func NewDescribeRecordingUsageResponse() (response *DescribeRecordingUsageResponse)
func (*DescribeRecordingUsageResponse) FromJsonString ¶ added in v1.0.514
func (r *DescribeRecordingUsageResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeRecordingUsageResponse) ToJsonString ¶ added in v1.0.514
func (r *DescribeRecordingUsageResponse) ToJsonString() string
type DescribeRecordingUsageResponseParams ¶ added in v1.0.514
type DescribeRecordingUsageResponseParams struct { // 用量类型,与UsageValue中各个位置的值对应。 UsageKey []*string `json:"UsageKey,omitnil,omitempty" name:"UsageKey"` // 各个时间点用量明细。 UsageList []*TrtcUsage `json:"UsageList,omitnil,omitempty" name:"UsageList"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeRelayUsageRequest ¶ added in v1.0.514
type DescribeRelayUsageRequest struct { *tchttp.BaseRequest // 查询开始时间,格式为YYYY-MM-DD。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 // 单次查询统计区间最多不能超过31天。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
func NewDescribeRelayUsageRequest ¶ added in v1.0.514
func NewDescribeRelayUsageRequest() (request *DescribeRelayUsageRequest)
func (*DescribeRelayUsageRequest) FromJsonString ¶ added in v1.0.514
func (r *DescribeRelayUsageRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeRelayUsageRequest) ToJsonString ¶ added in v1.0.514
func (r *DescribeRelayUsageRequest) ToJsonString() string
type DescribeRelayUsageRequestParams ¶ added in v1.0.514
type DescribeRelayUsageRequestParams struct { // 查询开始时间,格式为YYYY-MM-DD。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 // 单次查询统计区间最多不能超过31天。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
Predefined struct for user
type DescribeRelayUsageResponse ¶ added in v1.0.514
type DescribeRelayUsageResponse struct { *tchttp.BaseResponse Response *DescribeRelayUsageResponseParams `json:"Response"` }
func NewDescribeRelayUsageResponse ¶ added in v1.0.514
func NewDescribeRelayUsageResponse() (response *DescribeRelayUsageResponse)
func (*DescribeRelayUsageResponse) FromJsonString ¶ added in v1.0.514
func (r *DescribeRelayUsageResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeRelayUsageResponse) ToJsonString ¶ added in v1.0.514
func (r *DescribeRelayUsageResponse) ToJsonString() string
type DescribeRelayUsageResponseParams ¶ added in v1.0.514
type DescribeRelayUsageResponseParams struct { // 用量类型,与UsageValue中各个位置的值对应。 UsageKey []*string `json:"UsageKey,omitnil,omitempty" name:"UsageKey"` // 各个时间点用量明细。 UsageList []*TrtcUsage `json:"UsageList,omitnil,omitempty" name:"UsageList"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeRoomInfoRequest ¶ added in v1.0.449
type DescribeRoomInfoRequest struct { *tchttp.BaseRequest // 用户SdkAppId(如:1400xxxxxx) SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)注意:最大支持查询14天内的数据 StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) // 注意:与StartTime间隔时间不超过24小时。 EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 房间号(如:223) RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 当前页数,默认为0, // 注意:PageNumber和PageSize 其中一个不填均默认返回10条数据。 PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"` // 每页个数,默认为10, // 范围:[1,100] PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"` }
func NewDescribeRoomInfoRequest ¶ added in v1.0.449
func NewDescribeRoomInfoRequest() (request *DescribeRoomInfoRequest)
func (*DescribeRoomInfoRequest) FromJsonString ¶ added in v1.0.449
func (r *DescribeRoomInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeRoomInfoRequest) ToJsonString ¶ added in v1.0.449
func (r *DescribeRoomInfoRequest) ToJsonString() string
type DescribeRoomInfoRequestParams ¶ added in v1.0.449
type DescribeRoomInfoRequestParams struct { // 用户SdkAppId(如:1400xxxxxx) SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)注意:最大支持查询14天内的数据 StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) // 注意:与StartTime间隔时间不超过24小时。 EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 房间号(如:223) RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 当前页数,默认为0, // 注意:PageNumber和PageSize 其中一个不填均默认返回10条数据。 PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"` // 每页个数,默认为10, // 范围:[1,100] PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"` }
Predefined struct for user
type DescribeRoomInfoResponse ¶ added in v1.0.449
type DescribeRoomInfoResponse struct { *tchttp.BaseResponse Response *DescribeRoomInfoResponseParams `json:"Response"` }
func NewDescribeRoomInfoResponse ¶ added in v1.0.449
func NewDescribeRoomInfoResponse() (response *DescribeRoomInfoResponse)
func (*DescribeRoomInfoResponse) FromJsonString ¶ added in v1.0.449
func (r *DescribeRoomInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeRoomInfoResponse) ToJsonString ¶ added in v1.0.449
func (r *DescribeRoomInfoResponse) ToJsonString() string
type DescribeRoomInfoResponseParams ¶ added in v1.0.449
type DescribeRoomInfoResponseParams struct { // 返回当页数据总数 Total *int64 `json:"Total,omitnil,omitempty" name:"Total"` // 房间信息列表 RoomList []*RoomState `json:"RoomList,omitnil,omitempty" name:"RoomList"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeScaleInfoRequest ¶ added in v1.0.449
type DescribeScaleInfoRequest struct { *tchttp.BaseRequest // 用户SdkAppId(如:1400xxxxxx) SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,本地unix时间戳,单位为秒(如:1590065777) // 注意:支持查询14天内的数据。 StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,本地unix时间戳,单位为秒(如:1590065877),建议与StartTime间隔时间超过24小时。 // 注意:按天统计,结束时间大于前一天,否则查询数据为空(如:需查询20号数据,结束时间需晚于20号0点)。 EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` }
func NewDescribeScaleInfoRequest ¶ added in v1.0.449
func NewDescribeScaleInfoRequest() (request *DescribeScaleInfoRequest)
func (*DescribeScaleInfoRequest) FromJsonString ¶ added in v1.0.449
func (r *DescribeScaleInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeScaleInfoRequest) ToJsonString ¶ added in v1.0.449
func (r *DescribeScaleInfoRequest) ToJsonString() string
type DescribeScaleInfoRequestParams ¶ added in v1.0.449
type DescribeScaleInfoRequestParams struct { // 用户SdkAppId(如:1400xxxxxx) SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,本地unix时间戳,单位为秒(如:1590065777) // 注意:支持查询14天内的数据。 StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,本地unix时间戳,单位为秒(如:1590065877),建议与StartTime间隔时间超过24小时。 // 注意:按天统计,结束时间大于前一天,否则查询数据为空(如:需查询20号数据,结束时间需晚于20号0点)。 EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` }
Predefined struct for user
type DescribeScaleInfoResponse ¶ added in v1.0.449
type DescribeScaleInfoResponse struct { *tchttp.BaseResponse Response *DescribeScaleInfoResponseParams `json:"Response"` }
func NewDescribeScaleInfoResponse ¶ added in v1.0.449
func NewDescribeScaleInfoResponse() (response *DescribeScaleInfoResponse)
func (*DescribeScaleInfoResponse) FromJsonString ¶ added in v1.0.449
func (r *DescribeScaleInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeScaleInfoResponse) ToJsonString ¶ added in v1.0.449
func (r *DescribeScaleInfoResponse) ToJsonString() string
type DescribeScaleInfoResponseParams ¶ added in v1.0.449
type DescribeScaleInfoResponseParams struct { // 返回的数据条数 Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"` // 返回的数据 // 注意:此字段可能返回 null,表示取不到有效值。 ScaleList []*ScaleInfomation `json:"ScaleList,omitnil,omitempty" name:"ScaleList"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeStreamIngestRequest ¶ added in v1.0.803
type DescribeStreamIngestRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId,和任务的房间所对应的SDKAppId相同 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 任务的唯一Id,在启动任务成功后会返回。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` }
func NewDescribeStreamIngestRequest ¶ added in v1.0.803
func NewDescribeStreamIngestRequest() (request *DescribeStreamIngestRequest)
func (*DescribeStreamIngestRequest) FromJsonString ¶ added in v1.0.803
func (r *DescribeStreamIngestRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeStreamIngestRequest) ToJsonString ¶ added in v1.0.803
func (r *DescribeStreamIngestRequest) ToJsonString() string
type DescribeStreamIngestRequestParams ¶ added in v1.0.803
type DescribeStreamIngestRequestParams struct { // TRTC的SDKAppId,和任务的房间所对应的SDKAppId相同 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 任务的唯一Id,在启动任务成功后会返回。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` }
Predefined struct for user
type DescribeStreamIngestResponse ¶ added in v1.0.803
type DescribeStreamIngestResponse struct { *tchttp.BaseResponse Response *DescribeStreamIngestResponseParams `json:"Response"` }
func NewDescribeStreamIngestResponse ¶ added in v1.0.803
func NewDescribeStreamIngestResponse() (response *DescribeStreamIngestResponse)
func (*DescribeStreamIngestResponse) FromJsonString ¶ added in v1.0.803
func (r *DescribeStreamIngestResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeStreamIngestResponse) ToJsonString ¶ added in v1.0.803
func (r *DescribeStreamIngestResponse) ToJsonString() string
type DescribeStreamIngestResponseParams ¶ added in v1.0.803
type DescribeStreamIngestResponseParams struct { // 任务的状态信息。 // InProgress:表示当前任务正在进行中。 // NotExist:表示当前任务不存在。 // 示例值:InProgress Status *string `json:"Status,omitnil,omitempty" name:"Status"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeTRTCMarketQualityDataRequest ¶ added in v1.0.732
type DescribeTRTCMarketQualityDataRequest struct { *tchttp.BaseRequest // 用户SdkAppId(如:1400xxxxxx) SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天) StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 返回数据的粒度,支持设为以下值: // d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。 // h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。 Period *string `json:"Period,omitnil,omitempty" name:"Period"` }
func NewDescribeTRTCMarketQualityDataRequest ¶ added in v1.0.732
func NewDescribeTRTCMarketQualityDataRequest() (request *DescribeTRTCMarketQualityDataRequest)
func (*DescribeTRTCMarketQualityDataRequest) FromJsonString ¶ added in v1.0.732
func (r *DescribeTRTCMarketQualityDataRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCMarketQualityDataRequest) ToJsonString ¶ added in v1.0.732
func (r *DescribeTRTCMarketQualityDataRequest) ToJsonString() string
type DescribeTRTCMarketQualityDataRequestParams ¶ added in v1.0.732
type DescribeTRTCMarketQualityDataRequestParams struct { // 用户SdkAppId(如:1400xxxxxx) SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天) StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 返回数据的粒度,支持设为以下值: // d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。 // h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。 Period *string `json:"Period,omitnil,omitempty" name:"Period"` }
Predefined struct for user
type DescribeTRTCMarketQualityDataResponse ¶ added in v1.0.732
type DescribeTRTCMarketQualityDataResponse struct { *tchttp.BaseResponse Response *DescribeTRTCMarketQualityDataResponseParams `json:"Response"` }
func NewDescribeTRTCMarketQualityDataResponse ¶ added in v1.0.732
func NewDescribeTRTCMarketQualityDataResponse() (response *DescribeTRTCMarketQualityDataResponse)
func (*DescribeTRTCMarketQualityDataResponse) FromJsonString ¶ added in v1.0.732
func (r *DescribeTRTCMarketQualityDataResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCMarketQualityDataResponse) ToJsonString ¶ added in v1.0.732
func (r *DescribeTRTCMarketQualityDataResponse) ToJsonString() string
type DescribeTRTCMarketQualityDataResponseParams ¶ added in v1.0.732
type DescribeTRTCMarketQualityDataResponseParams struct { // TRTC监控数据出参 // 注意:此字段可能返回 null,表示取不到有效值。 Data *TRTCDataResult `json:"Data,omitnil,omitempty" name:"Data"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeTRTCMarketQualityMetricDataRequest ¶ added in v1.0.530
type DescribeTRTCMarketQualityMetricDataRequest struct { *tchttp.BaseRequest // 用户SdkAppId(如:1400xxxxxx) SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天) StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 返回数据的粒度,支持设为以下值: // d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。 // h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。 Period *string `json:"Period,omitnil,omitempty" name:"Period"` }
func NewDescribeTRTCMarketQualityMetricDataRequest ¶ added in v1.0.530
func NewDescribeTRTCMarketQualityMetricDataRequest() (request *DescribeTRTCMarketQualityMetricDataRequest)
func (*DescribeTRTCMarketQualityMetricDataRequest) FromJsonString ¶ added in v1.0.530
func (r *DescribeTRTCMarketQualityMetricDataRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCMarketQualityMetricDataRequest) ToJsonString ¶ added in v1.0.530
func (r *DescribeTRTCMarketQualityMetricDataRequest) ToJsonString() string
type DescribeTRTCMarketQualityMetricDataRequestParams ¶ added in v1.0.530
type DescribeTRTCMarketQualityMetricDataRequestParams struct { // 用户SdkAppId(如:1400xxxxxx) SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天) StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 返回数据的粒度,支持设为以下值: // d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。 // h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。 Period *string `json:"Period,omitnil,omitempty" name:"Period"` }
Predefined struct for user
type DescribeTRTCMarketQualityMetricDataResponse ¶ added in v1.0.530
type DescribeTRTCMarketQualityMetricDataResponse struct { *tchttp.BaseResponse Response *DescribeTRTCMarketQualityMetricDataResponseParams `json:"Response"` }
func NewDescribeTRTCMarketQualityMetricDataResponse ¶ added in v1.0.530
func NewDescribeTRTCMarketQualityMetricDataResponse() (response *DescribeTRTCMarketQualityMetricDataResponse)
func (*DescribeTRTCMarketQualityMetricDataResponse) FromJsonString ¶ added in v1.0.530
func (r *DescribeTRTCMarketQualityMetricDataResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCMarketQualityMetricDataResponse) ToJsonString ¶ added in v1.0.530
func (r *DescribeTRTCMarketQualityMetricDataResponse) ToJsonString() string
type DescribeTRTCMarketQualityMetricDataResponseParams ¶ added in v1.0.530
type DescribeTRTCMarketQualityMetricDataResponseParams struct { // TRTC监控数据出参 // 注意:此字段可能返回 null,表示取不到有效值。 Data *TRTCDataResp `json:"Data,omitnil,omitempty" name:"Data"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeTRTCMarketScaleDataRequest ¶ added in v1.0.732
type DescribeTRTCMarketScaleDataRequest struct { *tchttp.BaseRequest // 用户SdkAppId SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天) StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 返回数据的粒度,支持设为以下值: // d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。 // h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。 Period *string `json:"Period,omitnil,omitempty" name:"Period"` }
func NewDescribeTRTCMarketScaleDataRequest ¶ added in v1.0.732
func NewDescribeTRTCMarketScaleDataRequest() (request *DescribeTRTCMarketScaleDataRequest)
func (*DescribeTRTCMarketScaleDataRequest) FromJsonString ¶ added in v1.0.732
func (r *DescribeTRTCMarketScaleDataRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCMarketScaleDataRequest) ToJsonString ¶ added in v1.0.732
func (r *DescribeTRTCMarketScaleDataRequest) ToJsonString() string
type DescribeTRTCMarketScaleDataRequestParams ¶ added in v1.0.732
type DescribeTRTCMarketScaleDataRequestParams struct { // 用户SdkAppId SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天) StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 返回数据的粒度,支持设为以下值: // d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。 // h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。 Period *string `json:"Period,omitnil,omitempty" name:"Period"` }
Predefined struct for user
type DescribeTRTCMarketScaleDataResponse ¶ added in v1.0.732
type DescribeTRTCMarketScaleDataResponse struct { *tchttp.BaseResponse Response *DescribeTRTCMarketScaleDataResponseParams `json:"Response"` }
func NewDescribeTRTCMarketScaleDataResponse ¶ added in v1.0.732
func NewDescribeTRTCMarketScaleDataResponse() (response *DescribeTRTCMarketScaleDataResponse)
func (*DescribeTRTCMarketScaleDataResponse) FromJsonString ¶ added in v1.0.732
func (r *DescribeTRTCMarketScaleDataResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCMarketScaleDataResponse) ToJsonString ¶ added in v1.0.732
func (r *DescribeTRTCMarketScaleDataResponse) ToJsonString() string
type DescribeTRTCMarketScaleDataResponseParams ¶ added in v1.0.732
type DescribeTRTCMarketScaleDataResponseParams struct { // TRTC监控数据出参 // 注意:此字段可能返回 null,表示取不到有效值。 Data *TRTCDataResult `json:"Data,omitnil,omitempty" name:"Data"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeTRTCMarketScaleMetricDataRequest ¶ added in v1.0.530
type DescribeTRTCMarketScaleMetricDataRequest struct { *tchttp.BaseRequest // 用户SdkAppId SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天) StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 返回数据的粒度,支持设为以下值: // d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。 // h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。 Period *string `json:"Period,omitnil,omitempty" name:"Period"` }
func NewDescribeTRTCMarketScaleMetricDataRequest ¶ added in v1.0.530
func NewDescribeTRTCMarketScaleMetricDataRequest() (request *DescribeTRTCMarketScaleMetricDataRequest)
func (*DescribeTRTCMarketScaleMetricDataRequest) FromJsonString ¶ added in v1.0.530
func (r *DescribeTRTCMarketScaleMetricDataRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCMarketScaleMetricDataRequest) ToJsonString ¶ added in v1.0.530
func (r *DescribeTRTCMarketScaleMetricDataRequest) ToJsonString() string
type DescribeTRTCMarketScaleMetricDataRequestParams ¶ added in v1.0.530
type DescribeTRTCMarketScaleMetricDataRequestParams struct { // 用户SdkAppId SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天) StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 返回数据的粒度,支持设为以下值: // d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。 // h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。 Period *string `json:"Period,omitnil,omitempty" name:"Period"` }
Predefined struct for user
type DescribeTRTCMarketScaleMetricDataResponse ¶ added in v1.0.530
type DescribeTRTCMarketScaleMetricDataResponse struct { *tchttp.BaseResponse Response *DescribeTRTCMarketScaleMetricDataResponseParams `json:"Response"` }
func NewDescribeTRTCMarketScaleMetricDataResponse ¶ added in v1.0.530
func NewDescribeTRTCMarketScaleMetricDataResponse() (response *DescribeTRTCMarketScaleMetricDataResponse)
func (*DescribeTRTCMarketScaleMetricDataResponse) FromJsonString ¶ added in v1.0.530
func (r *DescribeTRTCMarketScaleMetricDataResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCMarketScaleMetricDataResponse) ToJsonString ¶ added in v1.0.530
func (r *DescribeTRTCMarketScaleMetricDataResponse) ToJsonString() string
type DescribeTRTCMarketScaleMetricDataResponseParams ¶ added in v1.0.530
type DescribeTRTCMarketScaleMetricDataResponseParams struct { // TRTC监控数据出参 // 注意:此字段可能返回 null,表示取不到有效值。 Data *TRTCDataResp `json:"Data,omitnil,omitempty" name:"Data"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeTRTCRealTimeQualityDataRequest ¶ added in v1.0.732
type DescribeTRTCRealTimeQualityDataRequest struct { *tchttp.BaseRequest // 用户SdkAppId(如:1400xxxxxx) SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时) StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 结束时间,unix时间戳,单位:秒 EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 房间ID RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
func NewDescribeTRTCRealTimeQualityDataRequest ¶ added in v1.0.732
func NewDescribeTRTCRealTimeQualityDataRequest() (request *DescribeTRTCRealTimeQualityDataRequest)
func (*DescribeTRTCRealTimeQualityDataRequest) FromJsonString ¶ added in v1.0.732
func (r *DescribeTRTCRealTimeQualityDataRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCRealTimeQualityDataRequest) ToJsonString ¶ added in v1.0.732
func (r *DescribeTRTCRealTimeQualityDataRequest) ToJsonString() string
type DescribeTRTCRealTimeQualityDataRequestParams ¶ added in v1.0.732
type DescribeTRTCRealTimeQualityDataRequestParams struct { // 用户SdkAppId(如:1400xxxxxx) SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时) StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 结束时间,unix时间戳,单位:秒 EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 房间ID RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
Predefined struct for user
type DescribeTRTCRealTimeQualityDataResponse ¶ added in v1.0.732
type DescribeTRTCRealTimeQualityDataResponse struct { *tchttp.BaseResponse Response *DescribeTRTCRealTimeQualityDataResponseParams `json:"Response"` }
func NewDescribeTRTCRealTimeQualityDataResponse ¶ added in v1.0.732
func NewDescribeTRTCRealTimeQualityDataResponse() (response *DescribeTRTCRealTimeQualityDataResponse)
func (*DescribeTRTCRealTimeQualityDataResponse) FromJsonString ¶ added in v1.0.732
func (r *DescribeTRTCRealTimeQualityDataResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCRealTimeQualityDataResponse) ToJsonString ¶ added in v1.0.732
func (r *DescribeTRTCRealTimeQualityDataResponse) ToJsonString() string
type DescribeTRTCRealTimeQualityDataResponseParams ¶ added in v1.0.732
type DescribeTRTCRealTimeQualityDataResponseParams struct { // TRTC监控数据出参 // 注意:此字段可能返回 null,表示取不到有效值。 Data *TRTCDataResult `json:"Data,omitnil,omitempty" name:"Data"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeTRTCRealTimeQualityMetricDataRequest ¶ added in v1.0.530
type DescribeTRTCRealTimeQualityMetricDataRequest struct { *tchttp.BaseRequest // 用户SdkAppId(如:1400xxxxxx) SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时) StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 结束时间,unix时间戳,单位:秒 EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 房间ID RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
func NewDescribeTRTCRealTimeQualityMetricDataRequest ¶ added in v1.0.530
func NewDescribeTRTCRealTimeQualityMetricDataRequest() (request *DescribeTRTCRealTimeQualityMetricDataRequest)
func (*DescribeTRTCRealTimeQualityMetricDataRequest) FromJsonString ¶ added in v1.0.530
func (r *DescribeTRTCRealTimeQualityMetricDataRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCRealTimeQualityMetricDataRequest) ToJsonString ¶ added in v1.0.530
func (r *DescribeTRTCRealTimeQualityMetricDataRequest) ToJsonString() string
type DescribeTRTCRealTimeQualityMetricDataRequestParams ¶ added in v1.0.530
type DescribeTRTCRealTimeQualityMetricDataRequestParams struct { // 用户SdkAppId(如:1400xxxxxx) SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时) StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 结束时间,unix时间戳,单位:秒 EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 房间ID RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
Predefined struct for user
type DescribeTRTCRealTimeQualityMetricDataResponse ¶ added in v1.0.530
type DescribeTRTCRealTimeQualityMetricDataResponse struct { *tchttp.BaseResponse Response *DescribeTRTCRealTimeQualityMetricDataResponseParams `json:"Response"` }
func NewDescribeTRTCRealTimeQualityMetricDataResponse ¶ added in v1.0.530
func NewDescribeTRTCRealTimeQualityMetricDataResponse() (response *DescribeTRTCRealTimeQualityMetricDataResponse)
func (*DescribeTRTCRealTimeQualityMetricDataResponse) FromJsonString ¶ added in v1.0.530
func (r *DescribeTRTCRealTimeQualityMetricDataResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCRealTimeQualityMetricDataResponse) ToJsonString ¶ added in v1.0.530
func (r *DescribeTRTCRealTimeQualityMetricDataResponse) ToJsonString() string
type DescribeTRTCRealTimeQualityMetricDataResponseParams ¶ added in v1.0.530
type DescribeTRTCRealTimeQualityMetricDataResponseParams struct { // TRTC监控数据出参 // 注意:此字段可能返回 null,表示取不到有效值。 Data *TRTCDataResp `json:"Data,omitnil,omitempty" name:"Data"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeTRTCRealTimeScaleDataRequest ¶ added in v1.0.732
type DescribeTRTCRealTimeScaleDataRequest struct { *tchttp.BaseRequest // 用户SdkAppId(如:1400xxxxxx) SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时) StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 结束时间,unix时间戳,单位:秒 EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 房间ID RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
func NewDescribeTRTCRealTimeScaleDataRequest ¶ added in v1.0.732
func NewDescribeTRTCRealTimeScaleDataRequest() (request *DescribeTRTCRealTimeScaleDataRequest)
func (*DescribeTRTCRealTimeScaleDataRequest) FromJsonString ¶ added in v1.0.732
func (r *DescribeTRTCRealTimeScaleDataRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCRealTimeScaleDataRequest) ToJsonString ¶ added in v1.0.732
func (r *DescribeTRTCRealTimeScaleDataRequest) ToJsonString() string
type DescribeTRTCRealTimeScaleDataRequestParams ¶ added in v1.0.732
type DescribeTRTCRealTimeScaleDataRequestParams struct { // 用户SdkAppId(如:1400xxxxxx) SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时) StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 结束时间,unix时间戳,单位:秒 EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 房间ID RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
Predefined struct for user
type DescribeTRTCRealTimeScaleDataResponse ¶ added in v1.0.732
type DescribeTRTCRealTimeScaleDataResponse struct { *tchttp.BaseResponse Response *DescribeTRTCRealTimeScaleDataResponseParams `json:"Response"` }
func NewDescribeTRTCRealTimeScaleDataResponse ¶ added in v1.0.732
func NewDescribeTRTCRealTimeScaleDataResponse() (response *DescribeTRTCRealTimeScaleDataResponse)
func (*DescribeTRTCRealTimeScaleDataResponse) FromJsonString ¶ added in v1.0.732
func (r *DescribeTRTCRealTimeScaleDataResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCRealTimeScaleDataResponse) ToJsonString ¶ added in v1.0.732
func (r *DescribeTRTCRealTimeScaleDataResponse) ToJsonString() string
type DescribeTRTCRealTimeScaleDataResponseParams ¶ added in v1.0.732
type DescribeTRTCRealTimeScaleDataResponseParams struct { // TRTC监控数据出参 // 注意:此字段可能返回 null,表示取不到有效值。 Data *TRTCDataResult `json:"Data,omitnil,omitempty" name:"Data"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeTRTCRealTimeScaleMetricDataRequest ¶ added in v1.0.530
type DescribeTRTCRealTimeScaleMetricDataRequest struct { *tchttp.BaseRequest // 用户SdkAppId(如:1400xxxxxx) SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时) StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 结束时间,unix时间戳,单位:秒 EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 房间ID RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
func NewDescribeTRTCRealTimeScaleMetricDataRequest ¶ added in v1.0.530
func NewDescribeTRTCRealTimeScaleMetricDataRequest() (request *DescribeTRTCRealTimeScaleMetricDataRequest)
func (*DescribeTRTCRealTimeScaleMetricDataRequest) FromJsonString ¶ added in v1.0.530
func (r *DescribeTRTCRealTimeScaleMetricDataRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCRealTimeScaleMetricDataRequest) ToJsonString ¶ added in v1.0.530
func (r *DescribeTRTCRealTimeScaleMetricDataRequest) ToJsonString() string
type DescribeTRTCRealTimeScaleMetricDataRequestParams ¶ added in v1.0.530
type DescribeTRTCRealTimeScaleMetricDataRequestParams struct { // 用户SdkAppId(如:1400xxxxxx) SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时) StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 结束时间,unix时间戳,单位:秒 EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 房间ID RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
Predefined struct for user
type DescribeTRTCRealTimeScaleMetricDataResponse ¶ added in v1.0.530
type DescribeTRTCRealTimeScaleMetricDataResponse struct { *tchttp.BaseResponse Response *DescribeTRTCRealTimeScaleMetricDataResponseParams `json:"Response"` }
func NewDescribeTRTCRealTimeScaleMetricDataResponse ¶ added in v1.0.530
func NewDescribeTRTCRealTimeScaleMetricDataResponse() (response *DescribeTRTCRealTimeScaleMetricDataResponse)
func (*DescribeTRTCRealTimeScaleMetricDataResponse) FromJsonString ¶ added in v1.0.530
func (r *DescribeTRTCRealTimeScaleMetricDataResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTRTCRealTimeScaleMetricDataResponse) ToJsonString ¶ added in v1.0.530
func (r *DescribeTRTCRealTimeScaleMetricDataResponse) ToJsonString() string
type DescribeTRTCRealTimeScaleMetricDataResponseParams ¶ added in v1.0.530
type DescribeTRTCRealTimeScaleMetricDataResponseParams struct { // TRTC监控数据出参 // 注意:此字段可能返回 null,表示取不到有效值。 Data *TRTCDataResp `json:"Data,omitnil,omitempty" name:"Data"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeTrtcMcuTranscodeTimeRequest ¶
type DescribeTrtcMcuTranscodeTimeRequest struct { *tchttp.BaseRequest // 查询开始时间,格式为YYYY-MM-DD。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 // 单次查询统计区间最多不能超过31天。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。 SdkAppId *uint64 `json:"SdkAppId,omitnil,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 DescribeTrtcMcuTranscodeTimeRequestParams ¶ added in v1.0.426
type DescribeTrtcMcuTranscodeTimeRequestParams struct { // 查询开始时间,格式为YYYY-MM-DD。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 // 单次查询统计区间最多不能超过31天。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
Predefined struct for user
type DescribeTrtcMcuTranscodeTimeResponse ¶
type DescribeTrtcMcuTranscodeTimeResponse struct { *tchttp.BaseResponse Response *DescribeTrtcMcuTranscodeTimeResponseParams `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 DescribeTrtcMcuTranscodeTimeResponseParams ¶ added in v1.0.426
type DescribeTrtcMcuTranscodeTimeResponseParams struct { // 应用的用量信息数组。 Usages []*OneSdkAppIdTranscodeTimeUsagesInfo `json:"Usages,omitnil,omitempty" name:"Usages"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeTrtcRoomUsageRequest ¶ added in v1.0.623
type DescribeTrtcRoomUsageRequest struct { *tchttp.BaseRequest // TRTC的SdkAppId,和房间所对应的SdkAppId相同。 SdkAppid *uint64 `json:"SdkAppid,omitnil,omitempty" name:"SdkAppid"` // 查询开始时间,格式为YYYY-MM-DD HH:MM,精确到分钟级。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD HH:MM,单次查询不超过24h。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` }
func NewDescribeTrtcRoomUsageRequest ¶ added in v1.0.623
func NewDescribeTrtcRoomUsageRequest() (request *DescribeTrtcRoomUsageRequest)
func (*DescribeTrtcRoomUsageRequest) FromJsonString ¶ added in v1.0.623
func (r *DescribeTrtcRoomUsageRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTrtcRoomUsageRequest) ToJsonString ¶ added in v1.0.623
func (r *DescribeTrtcRoomUsageRequest) ToJsonString() string
type DescribeTrtcRoomUsageRequestParams ¶ added in v1.0.623
type DescribeTrtcRoomUsageRequestParams struct { // TRTC的SdkAppId,和房间所对应的SdkAppId相同。 SdkAppid *uint64 `json:"SdkAppid,omitnil,omitempty" name:"SdkAppid"` // 查询开始时间,格式为YYYY-MM-DD HH:MM,精确到分钟级。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD HH:MM,单次查询不超过24h。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` }
Predefined struct for user
type DescribeTrtcRoomUsageResponse ¶ added in v1.0.623
type DescribeTrtcRoomUsageResponse struct { *tchttp.BaseResponse Response *DescribeTrtcRoomUsageResponseParams `json:"Response"` }
func NewDescribeTrtcRoomUsageResponse ¶ added in v1.0.623
func NewDescribeTrtcRoomUsageResponse() (response *DescribeTrtcRoomUsageResponse)
func (*DescribeTrtcRoomUsageResponse) FromJsonString ¶ added in v1.0.623
func (r *DescribeTrtcRoomUsageResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTrtcRoomUsageResponse) ToJsonString ¶ added in v1.0.623
func (r *DescribeTrtcRoomUsageResponse) ToJsonString() string
type DescribeTrtcRoomUsageResponseParams ¶ added in v1.0.623
type DescribeTrtcRoomUsageResponseParams struct { // 房间维度用量数据,csv文件格式,单位:秒。 Data *string `json:"Data,omitnil,omitempty" name:"Data"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeTrtcUsageRequest ¶ added in v1.0.514
type DescribeTrtcUsageRequest struct { *tchttp.BaseRequest // 查询开始时间,格式为YYYY-MM-DD。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 // 单次查询统计区间最多不能超过31天。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
func NewDescribeTrtcUsageRequest ¶ added in v1.0.514
func NewDescribeTrtcUsageRequest() (request *DescribeTrtcUsageRequest)
func (*DescribeTrtcUsageRequest) FromJsonString ¶ added in v1.0.514
func (r *DescribeTrtcUsageRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTrtcUsageRequest) ToJsonString ¶ added in v1.0.514
func (r *DescribeTrtcUsageRequest) ToJsonString() string
type DescribeTrtcUsageRequestParams ¶ added in v1.0.514
type DescribeTrtcUsageRequestParams struct { // 查询开始时间,格式为YYYY-MM-DD。 StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,格式为YYYY-MM-DD。 // 单次查询统计区间最多不能超过31天。 EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
Predefined struct for user
type DescribeTrtcUsageResponse ¶ added in v1.0.514
type DescribeTrtcUsageResponse struct { *tchttp.BaseResponse Response *DescribeTrtcUsageResponseParams `json:"Response"` }
func NewDescribeTrtcUsageResponse ¶ added in v1.0.514
func NewDescribeTrtcUsageResponse() (response *DescribeTrtcUsageResponse)
func (*DescribeTrtcUsageResponse) FromJsonString ¶ added in v1.0.514
func (r *DescribeTrtcUsageResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTrtcUsageResponse) ToJsonString ¶ added in v1.0.514
func (r *DescribeTrtcUsageResponse) ToJsonString() string
type DescribeTrtcUsageResponseParams ¶ added in v1.0.514
type DescribeTrtcUsageResponseParams struct { // 用量类型,与UsageValue中各个位置的值对应。 UsageKey []*string `json:"UsageKey,omitnil,omitempty" name:"UsageKey"` // 各个时间点用量明细。 UsageList []*TrtcUsage `json:"UsageList,omitnil,omitempty" name:"UsageList"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeUnusualEventRequest ¶ added in v1.0.449
type DescribeUnusualEventRequest struct { *tchttp.BaseRequest // 用户SdkAppId(如:1400xxxxxx) SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,本地unix时间戳,单位为秒(如:1590065777) // 注意:支持查询14天内的数据 StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)注意:与StartTime间隔时间不超过1小时。 EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 房间号,查询房间内任意20条以内异常体验事件 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
func NewDescribeUnusualEventRequest ¶ added in v1.0.449
func NewDescribeUnusualEventRequest() (request *DescribeUnusualEventRequest)
func (*DescribeUnusualEventRequest) FromJsonString ¶ added in v1.0.449
func (r *DescribeUnusualEventRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUnusualEventRequest) ToJsonString ¶ added in v1.0.449
func (r *DescribeUnusualEventRequest) ToJsonString() string
type DescribeUnusualEventRequestParams ¶ added in v1.0.449
type DescribeUnusualEventRequestParams struct { // 用户SdkAppId(如:1400xxxxxx) SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 查询开始时间,本地unix时间戳,单位为秒(如:1590065777) // 注意:支持查询14天内的数据 StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)注意:与StartTime间隔时间不超过1小时。 EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 房间号,查询房间内任意20条以内异常体验事件 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
Predefined struct for user
type DescribeUnusualEventResponse ¶ added in v1.0.449
type DescribeUnusualEventResponse struct { *tchttp.BaseResponse Response *DescribeUnusualEventResponseParams `json:"Response"` }
func NewDescribeUnusualEventResponse ¶ added in v1.0.449
func NewDescribeUnusualEventResponse() (response *DescribeUnusualEventResponse)
func (*DescribeUnusualEventResponse) FromJsonString ¶ added in v1.0.449
func (r *DescribeUnusualEventResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUnusualEventResponse) ToJsonString ¶ added in v1.0.449
func (r *DescribeUnusualEventResponse) ToJsonString() string
type DescribeUnusualEventResponseParams ¶ added in v1.0.449
type DescribeUnusualEventResponseParams struct { // 返回的数据总条数 // 范围:[0,20] Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"` // 异常体验列表 AbnormalExperienceList []*AbnormalExperience `json:"AbnormalExperienceList,omitnil,omitempty" name:"AbnormalExperienceList"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeUserEventRequest ¶ added in v1.0.449
type DescribeUserEventRequest struct { *tchttp.BaseRequest // 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。 CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"` // 查询开始时间,本地unix时间戳,单位为秒(如:1590065777) // 注意:支持查询14天内的数据 StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) // 注意:查询时间大于房间结束时间,以房间结束时间为准。 EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 用户UserId UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 房间号(如:223) RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 用户SdkAppId(如:1400xxxxxx) SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
func NewDescribeUserEventRequest ¶ added in v1.0.449
func NewDescribeUserEventRequest() (request *DescribeUserEventRequest)
func (*DescribeUserEventRequest) FromJsonString ¶ added in v1.0.449
func (r *DescribeUserEventRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUserEventRequest) ToJsonString ¶ added in v1.0.449
func (r *DescribeUserEventRequest) ToJsonString() string
type DescribeUserEventRequestParams ¶ added in v1.0.449
type DescribeUserEventRequestParams struct { // 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。 CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"` // 查询开始时间,本地unix时间戳,单位为秒(如:1590065777) // 注意:支持查询14天内的数据 StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) // 注意:查询时间大于房间结束时间,以房间结束时间为准。 EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 用户UserId UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 房间号(如:223) RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 用户SdkAppId(如:1400xxxxxx) SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
Predefined struct for user
type DescribeUserEventResponse ¶ added in v1.0.449
type DescribeUserEventResponse struct { *tchttp.BaseResponse Response *DescribeUserEventResponseParams `json:"Response"` }
func NewDescribeUserEventResponse ¶ added in v1.0.449
func NewDescribeUserEventResponse() (response *DescribeUserEventResponse)
func (*DescribeUserEventResponse) FromJsonString ¶ added in v1.0.449
func (r *DescribeUserEventResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUserEventResponse) ToJsonString ¶ added in v1.0.449
func (r *DescribeUserEventResponse) ToJsonString() string
type DescribeUserEventResponseParams ¶ added in v1.0.449
type DescribeUserEventResponseParams struct { // 返回的事件列表,若没有数据,会返回空数组。 Data []*EventList `json:"Data,omitnil,omitempty" name:"Data"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeUserInfoRequest ¶ added in v1.0.449
type DescribeUserInfoRequest struct { *tchttp.BaseRequest // 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。 CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"` // 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)注意:最大支持查询14天内的数据 StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) // 注意:与StartTime间隔时间不超过4小时。 EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 用户SdkAppId(如:1400xxxxxx) SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 需查询的用户数组,不填默认返回6个用户 // 范围:[1,100]。 UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"` // 当前页数,默认为0, // 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。 PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"` // 每页个数,默认为6, // 范围:[1,100]。 PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"` }
func NewDescribeUserInfoRequest ¶ added in v1.0.449
func NewDescribeUserInfoRequest() (request *DescribeUserInfoRequest)
func (*DescribeUserInfoRequest) FromJsonString ¶ added in v1.0.449
func (r *DescribeUserInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUserInfoRequest) ToJsonString ¶ added in v1.0.449
func (r *DescribeUserInfoRequest) ToJsonString() string
type DescribeUserInfoRequestParams ¶ added in v1.0.449
type DescribeUserInfoRequestParams struct { // 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。 CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"` // 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)注意:最大支持查询14天内的数据 StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"` // 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) // 注意:与StartTime间隔时间不超过4小时。 EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"` // 用户SdkAppId(如:1400xxxxxx) SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 需查询的用户数组,不填默认返回6个用户 // 范围:[1,100]。 UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"` // 当前页数,默认为0, // 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。 PageNumber *uint64 `json:"PageNumber,omitnil,omitempty" name:"PageNumber"` // 每页个数,默认为6, // 范围:[1,100]。 PageSize *uint64 `json:"PageSize,omitnil,omitempty" name:"PageSize"` }
Predefined struct for user
type DescribeUserInfoResponse ¶ added in v1.0.449
type DescribeUserInfoResponse struct { *tchttp.BaseResponse Response *DescribeUserInfoResponseParams `json:"Response"` }
func NewDescribeUserInfoResponse ¶ added in v1.0.449
func NewDescribeUserInfoResponse() (response *DescribeUserInfoResponse)
func (*DescribeUserInfoResponse) FromJsonString ¶ added in v1.0.449
func (r *DescribeUserInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUserInfoResponse) ToJsonString ¶ added in v1.0.449
func (r *DescribeUserInfoResponse) ToJsonString() string
type DescribeUserInfoResponseParams ¶ added in v1.0.449
type DescribeUserInfoResponseParams struct { // 返回的用户总条数 Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"` // 用户信息列表 // 注意:此字段可能返回 null,表示取不到有效值。 UserList []*UserInformation `json:"UserList,omitnil,omitempty" name:"UserList"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeWebRecordRequest ¶ added in v1.0.883
type DescribeWebRecordRequest struct { *tchttp.BaseRequest // 开始页面录制时返回的任务id TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 发起页面录制时传递的SdkAppId SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 发起录制时传递的RecordId, 传入此值时需要传递SdkAppId RecordId *string `json:"RecordId,omitnil,omitempty" name:"RecordId"` }
func NewDescribeWebRecordRequest ¶ added in v1.0.883
func NewDescribeWebRecordRequest() (request *DescribeWebRecordRequest)
func (*DescribeWebRecordRequest) FromJsonString ¶ added in v1.0.883
func (r *DescribeWebRecordRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeWebRecordRequest) ToJsonString ¶ added in v1.0.883
func (r *DescribeWebRecordRequest) ToJsonString() string
type DescribeWebRecordRequestParams ¶ added in v1.0.883
type DescribeWebRecordRequestParams struct { // 开始页面录制时返回的任务id TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 发起页面录制时传递的SdkAppId SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 发起录制时传递的RecordId, 传入此值时需要传递SdkAppId RecordId *string `json:"RecordId,omitnil,omitempty" name:"RecordId"` }
Predefined struct for user
type DescribeWebRecordResponse ¶ added in v1.0.883
type DescribeWebRecordResponse struct { *tchttp.BaseResponse Response *DescribeWebRecordResponseParams `json:"Response"` }
func NewDescribeWebRecordResponse ¶ added in v1.0.883
func NewDescribeWebRecordResponse() (response *DescribeWebRecordResponse)
func (*DescribeWebRecordResponse) FromJsonString ¶ added in v1.0.883
func (r *DescribeWebRecordResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeWebRecordResponse) ToJsonString ¶ added in v1.0.883
func (r *DescribeWebRecordResponse) ToJsonString() string
type DescribeWebRecordResponseParams ¶ added in v1.0.883
type DescribeWebRecordResponseParams struct { // 1: 正在录制中 Status *int64 `json:"Status,omitnil,omitempty" name:"Status"` // 在使用RecordId查询时返回 // 注意:此字段可能返回 null,表示取不到有效值。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 在使用TaskId查询时返回 // 注意:此字段可能返回 null,表示取不到有效值。 RecordId *string `json:"RecordId,omitnil,omitempty" name:"RecordId"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DismissRoomByStrRoomIdRequest ¶
type DismissRoomByStrRoomIdRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 字符串类型房间号。 // 本接口仅支持解散字符串类型房间号,如需解散数字类型房间号,请使用:DismissRoom RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
func NewDismissRoomByStrRoomIdRequest ¶
func NewDismissRoomByStrRoomIdRequest() (request *DismissRoomByStrRoomIdRequest)
func (*DismissRoomByStrRoomIdRequest) FromJsonString ¶
func (r *DismissRoomByStrRoomIdRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DismissRoomByStrRoomIdRequest) ToJsonString ¶
func (r *DismissRoomByStrRoomIdRequest) ToJsonString() string
type DismissRoomByStrRoomIdRequestParams ¶ added in v1.0.426
type DismissRoomByStrRoomIdRequestParams struct { // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 字符串类型房间号。 // 本接口仅支持解散字符串类型房间号,如需解散数字类型房间号,请使用:DismissRoom RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
Predefined struct for user
type DismissRoomByStrRoomIdResponse ¶
type DismissRoomByStrRoomIdResponse struct { *tchttp.BaseResponse Response *DismissRoomByStrRoomIdResponseParams `json:"Response"` }
func NewDismissRoomByStrRoomIdResponse ¶
func NewDismissRoomByStrRoomIdResponse() (response *DismissRoomByStrRoomIdResponse)
func (*DismissRoomByStrRoomIdResponse) FromJsonString ¶
func (r *DismissRoomByStrRoomIdResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DismissRoomByStrRoomIdResponse) ToJsonString ¶
func (r *DismissRoomByStrRoomIdResponse) ToJsonString() string
type DismissRoomByStrRoomIdResponseParams ¶ added in v1.0.426
type DismissRoomByStrRoomIdResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DismissRoomRequest ¶
type DismissRoomRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 数字房间号。本接口仅支持解散数字类型房间号,如需解散字符串类型房间号,请使用DismissRoomByStrRoomId。 RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
func NewDismissRoomRequest ¶
func NewDismissRoomRequest() (request *DismissRoomRequest)
func (*DismissRoomRequest) FromJsonString ¶
func (r *DismissRoomRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DismissRoomRequest) ToJsonString ¶
func (r *DismissRoomRequest) ToJsonString() string
type DismissRoomRequestParams ¶ added in v1.0.426
type DismissRoomRequestParams struct { // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 数字房间号。本接口仅支持解散数字类型房间号,如需解散字符串类型房间号,请使用DismissRoomByStrRoomId。 RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
Predefined struct for user
type DismissRoomResponse ¶
type DismissRoomResponse struct { *tchttp.BaseResponse Response *DismissRoomResponseParams `json:"Response"` }
func NewDismissRoomResponse ¶
func NewDismissRoomResponse() (response *DismissRoomResponse)
func (*DismissRoomResponse) FromJsonString ¶
func (r *DismissRoomResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DismissRoomResponse) ToJsonString ¶
func (r *DismissRoomResponse) ToJsonString() string
type DismissRoomResponseParams ¶ added in v1.0.426
type DismissRoomResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type EncodeParams ¶
type EncodeParams struct { // 混流-输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000],单位是Hz。混流任务发起过程中,为了保持CDN链接的稳定,不要修改音频参数(codec、采样率、码率、声道数)。 AudioSampleRate *uint64 `json:"AudioSampleRate,omitnil,omitempty" name:"AudioSampleRate"` // 混流-输出流音频码率。取值范围[8,500],单位为kbps。混流任务发起过程中,为了保持CDN链接的稳定,不要修改音频参数(codec、采样率、码率、声道数)。 AudioBitrate *uint64 `json:"AudioBitrate,omitnil,omitempty" name:"AudioBitrate"` // 混流-输出流音频声道数,取值范围[1,2],1表示混流输出音频为单声道,2表示混流输出音频为双声道。混流任务发起过程中,为了保持CDN链接的稳定,不要修改音频参数(codec、采样率、码率、声道数)。 AudioChannels *uint64 `json:"AudioChannels,omitnil,omitempty" name:"AudioChannels"` // 混流-输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。 VideoWidth *uint64 `json:"VideoWidth,omitnil,omitempty" name:"VideoWidth"` // 混流-输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。 VideoHeight *uint64 `json:"VideoHeight,omitnil,omitempty" name:"VideoHeight"` // 混流-输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。 VideoBitrate *uint64 `json:"VideoBitrate,omitnil,omitempty" name:"VideoBitrate"` // 混流-输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。 VideoFramerate *uint64 `json:"VideoFramerate,omitnil,omitempty" name:"VideoFramerate"` // 混流-输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。 VideoGop *uint64 `json:"VideoGop,omitnil,omitempty" name:"VideoGop"` // 混流-输出流背景色,取值是十进制整数。常用的颜色有: // 红色:0xff0000,对应的十进制整数是16724736。 // 黄色:0xffff00。对应的十进制整数是16776960。 // 绿色:0x33cc00。对应的十进制整数是3394560。 // 蓝色:0x0066ff。对应的十进制整数是26367。 // 黑色:0x000000。对应的十进制整数是0。 // 白色:0xFFFFFF。对应的十进制整数是16777215。 // 灰色:0x999999。对应的十进制整数是10066329。 BackgroundColor *uint64 `json:"BackgroundColor,omitnil,omitempty" name:"BackgroundColor"` // 混流-输出流背景图片,取值为实时音视频控制台上传的图片ID。 BackgroundImageId *uint64 `json:"BackgroundImageId,omitnil,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]。混流任务发起过程中,为了保持CDN链接的稳定,不要修改音频参数(codec、采样率、码率、声道数)。 AudioCodec *uint64 `json:"AudioCodec,omitnil,omitempty" name:"AudioCodec"` // 混流-输出流背景图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。BackgroundImageUrl和BackgroundImageId参数都填时,以BackgroundImageUrl为准。图片大小限制不超过2MB。 BackgroundImageUrl *string `json:"BackgroundImageUrl,omitnil,omitempty" name:"BackgroundImageUrl"` }
type EventList ¶
type EventList struct { // 数据内容 Content []*EventMessage `json:"Content,omitnil,omitempty" name:"Content"` // 发送端的userId PeerId *string `json:"PeerId,omitnil,omitempty" name:"PeerId"` }
type EventMessage ¶
type EventMessage struct { // 视频流类型: // 0:与视频无关的事件; // 2:视频为大画面; // 3:视频为小画面; // 7:视频为旁路画面; Type *uint64 `json:"Type,omitnil,omitempty" name:"Type"` // 事件上报的时间戳,unix时间(1589891188801ms) Time *uint64 `json:"Time,omitnil,omitempty" name:"Time"` // 事件Id:分为sdk的事件和webrtc的事件,详情见:附录/事件 ID 映射表:https://cloud.tencent.com/document/product/647/44916 EventId *uint64 `json:"EventId,omitnil,omitempty" name:"EventId"` // 事件的第一个参数,如视频分辨率宽 ParamOne *int64 `json:"ParamOne,omitnil,omitempty" name:"ParamOne"` // 事件的第二个参数,如视频分辨率高 ParamTwo *int64 `json:"ParamTwo,omitnil,omitempty" name:"ParamTwo"` }
type LayoutParams ¶
type LayoutParams struct { // 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 Template *uint64 `json:"Template,omitnil,omitempty" name:"Template"` // 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 MainVideoUserId *string `json:"MainVideoUserId,omitnil,omitempty" name:"MainVideoUserId"` // 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 MainVideoStreamType *uint64 `json:"MainVideoStreamType,omitnil,omitempty" name:"MainVideoStreamType"` // 画中画模板中有效,代表小画面的布局参数。 SmallVideoLayoutParams *SmallVideoLayoutParams `json:"SmallVideoLayoutParams,omitnil,omitempty" name:"SmallVideoLayoutParams"` // 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 MainVideoRightAlign *uint64 `json:"MainVideoRightAlign,omitnil,omitempty" name:"MainVideoRightAlign"` // 指定混视频的用户ID列表。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效,最多可设置16个用户。 MixVideoUids []*string `json:"MixVideoUids,omitnil,omitempty" name:"MixVideoUids"` // 自定义模板中有效,指定用户视频在混合画面中的位置。 PresetLayoutConfig []*PresetLayoutConfig `json:"PresetLayoutConfig,omitnil,omitempty" name:"PresetLayoutConfig"` // 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 PlaceHolderMode *uint64 `json:"PlaceHolderMode,omitnil,omitempty" name:"PlaceHolderMode"` // 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。 PureAudioHoldPlaceMode *uint64 `json:"PureAudioHoldPlaceMode,omitnil,omitempty" name:"PureAudioHoldPlaceMode"` // 水印参数。 WaterMarkParams *WaterMarkParams `json:"WaterMarkParams,omitnil,omitempty" name:"WaterMarkParams"` // 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效,画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底,不填采用后台的默认渲染方式(屏幕分享大画面为缩放,其他为裁剪)。若此参数不生效,请提交工单寻求帮助。 RenderMode *uint64 `json:"RenderMode,omitnil,omitempty" name:"RenderMode"` }
type MaxVideoUser ¶ added in v1.0.515
type MaxVideoUser struct { // 用户媒体流参数。 UserMediaStream *UserMediaStream `json:"UserMediaStream,omitnil,omitempty" name:"UserMediaStream"` }
type McuAudioParams ¶ added in v1.0.515
type McuAudioParams struct { // 音频编码参数。 AudioEncode *AudioEncode `json:"AudioEncode,omitnil,omitempty" name:"AudioEncode"` // 音频用户白名单,start时,为空或不填表示混所有主播音频,填具体值表示混指定主播音频;update时,不填表示不更新,为空表示更新为混所有主播音频,填具体值表示更新为混指定主播音频。 // 使用黑白名单时,黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时,以黑名单为主。 SubscribeAudioList []*McuUserInfoParams `json:"SubscribeAudioList,omitnil,omitempty" name:"SubscribeAudioList"` // 音频用户黑名单,为空或不填表示无黑名单,填具体值表示不混指定主播音频。update时,不填表示不更新,为空表示更新为清空黑名单,填具体值表示更新为不混指定主播音频。 // 使用黑白名单时,黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时,以黑名单为主。 UnSubscribeAudioList []*McuUserInfoParams `json:"UnSubscribeAudioList,omitnil,omitempty" name:"UnSubscribeAudioList"` }
type McuBackgroundCustomRender ¶ added in v1.0.898
type McuBackgroundCustomRender struct { // 自定义渲染画面的宽度,单位为像素值,需大于0,且不能超过子布局的宽。 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 自定义渲染画面的高度,单位为像素值,需大于0,且不能超过子布局的高。 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` // 自定义渲染画面的圆角半径,单位为像素值,不能超过渲染画面Width和Height最小值的一半,不指定默认为0,表示直角。 Radius *uint64 `json:"Radius,omitnil,omitempty" name:"Radius"` }
type McuCustomCrop ¶ added in v1.0.515
type McuCustomCrop struct { // 自定义裁剪起始位置的X偏移,单位为像素值,大于等于0。 LocationX *uint64 `json:"LocationX,omitnil,omitempty" name:"LocationX"` // 自定义裁剪起始位置的Y偏移,单位为像素值,大于等于0。 LocationY *uint64 `json:"LocationY,omitnil,omitempty" name:"LocationY"` // 自定义裁剪画面的宽度,单位为像素值,大于0,且LocationX+Width不超过10000 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 自定义裁剪画面的高度,单位为像素值,大于0,且LocationY+Height不超过10000 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` }
type McuFeedBackRoomParams ¶ added in v1.0.552
type McuFeedBackRoomParams struct { // 回推房间的RoomId。 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 房间类型,必须和回推房间所对应的RoomId类型相同,0为整形房间号,1为字符串房间号。 RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"` // 回推房间使用的UserId(https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。 UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 回推房间UserId对应的用户签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。 UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"` }
type McuLayout ¶ added in v1.0.515
type McuLayout struct { // 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。 UserMediaStream *UserMediaStream `json:"UserMediaStream,omitnil,omitempty" name:"UserMediaStream"` // 子画面在输出时的宽度,单位为像素值,不填默认为0。 ImageWidth *uint64 `json:"ImageWidth,omitnil,omitempty" name:"ImageWidth"` // 子画面在输出时的高度,单位为像素值,不填默认为0。 ImageHeight *uint64 `json:"ImageHeight,omitnil,omitempty" name:"ImageHeight"` // 子画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。 LocationX *uint64 `json:"LocationX,omitnil,omitempty" name:"LocationX"` // 子画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。 LocationY *uint64 `json:"LocationY,omitnil,omitempty" name:"LocationY"` // 子画面在输出时的层级,不填默认为0。 ZOrder *uint64 `json:"ZOrder,omitnil,omitempty" name:"ZOrder"` // 子画面在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底。不填默认为0。 RenderMode *uint64 `json:"RenderMode,omitnil,omitempty" name:"RenderMode"` // 【此参数配置无效,暂不支持】子画面的背景颜色,常用的颜色有: // 红色:0xcc0033。 // 黄色:0xcc9900。 // 绿色:0xcccc33。 // 蓝色:0x99CCFF。 // 黑色:0x000000。 // 白色:0xFFFFFF。 // 灰色:0x999999。 BackGroundColor *string `json:"BackGroundColor,omitnil,omitempty" name:"BackGroundColor"` // 子画面的背景图url,填写该参数,当用户关闭摄像头或未进入TRTC房间时,会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致,则会对图片进行拉伸处理,优先级高于BackGroundColor。支持png、jpg、jpeg、bmp、gif、webm格式。图片大小限制不超过5MB。 // 注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,子画面的背景图将不会生效。 BackgroundImageUrl *string `json:"BackgroundImageUrl,omitnil,omitempty" name:"BackgroundImageUrl"` // 客户自定义裁剪,针对原始输入流裁剪 CustomCrop *McuCustomCrop `json:"CustomCrop,omitnil,omitempty" name:"CustomCrop"` // 子背景图在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底,3为变比例伸缩,4为自定义渲染。不填默认为3。 BackgroundRenderMode *uint64 `json:"BackgroundRenderMode,omitnil,omitempty" name:"BackgroundRenderMode"` // 子画面的透明模版url,指向一张包含透明通道的模板图片。填写该参数,后台混流时会提取该模板图片的透明通道,将其缩放作为目标画面的透明通道,再和其他画面进行混合。您可以通过透明模版实现目标画面的半透明效果和任意形状裁剪(如圆角、星形、心形等)。 支持png格式。图片大小限制不超过5MB。 // 注:1,模板图片宽高比应接近目标画面宽高比,以避免缩放适配目标画面时出现模板效果变形;2,透明模版只有RenderMode为0(裁剪)时才生效;3,您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,透明模版将不会生效。 TransparentUrl *string `json:"TransparentUrl,omitnil,omitempty" name:"TransparentUrl"` // 子背景图的自定义渲染参数,当BackgroundRenderMode为4时必须配置。 BackgroundCustomRender *McuBackgroundCustomRender `json:"BackgroundCustomRender,omitnil,omitempty" name:"BackgroundCustomRender"` }
type McuLayoutParams ¶ added in v1.0.515
type McuLayoutParams struct { // 布局模式:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局),静态布局(4:自定义布局)。 MixLayoutMode *uint64 `json:"MixLayoutMode,omitnil,omitempty" name:"MixLayoutMode"` // 纯音频上行是否占布局位置,只在动态布局中有效。0表示纯音频不占布局位置,1表示纯音频占布局位置,不填默认为0。 PureAudioHoldPlaceMode *uint64 `json:"PureAudioHoldPlaceMode,omitnil,omitempty" name:"PureAudioHoldPlaceMode"` // 自定义模板中有效,指定用户视频在混合画面中的位置。 MixLayoutList []*McuLayout `json:"MixLayoutList,omitnil,omitempty" name:"MixLayoutList"` // 指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。 MaxVideoUser *MaxVideoUser `json:"MaxVideoUser,omitnil,omitempty" name:"MaxVideoUser"` // 屏幕分享模板、悬浮模板、九宫格模版有效,画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底 RenderMode *uint64 `json:"RenderMode,omitnil,omitempty" name:"RenderMode"` }
type McuLayoutVolume ¶ added in v1.0.515
type McuLayoutVolume struct { // AppData的内容,会被写入自定义SEI中的app_data字段,长度需小于4096。 AppData *string `json:"AppData,omitnil,omitempty" name:"AppData"` // SEI消息的payload_type,默认值100,取值范围100-254(244除外,244为我们内部自定义的时间戳SEI) PayloadType *uint64 `json:"PayloadType,omitnil,omitempty" name:"PayloadType"` // SEI发送间隔,单位毫秒,默认值为1000。 Interval *uint64 `json:"Interval,omitnil,omitempty" name:"Interval"` // 取值范围[0,1],填1:发送关键帧时会确保带SEI;填0:发送关键帧时不确保带SEI。默认值为0。 FollowIdr *uint64 `json:"FollowIdr,omitnil,omitempty" name:"FollowIdr"` }
type McuPassThrough ¶ added in v1.0.515
type McuPassThrough struct { // 透传SEI的payload内容。 PayloadContent *string `json:"PayloadContent,omitnil,omitempty" name:"PayloadContent"` // SEI消息的payload_type,取值范围5、100-254(244除外,244为我们内部自定义的时间戳SEI)。 PayloadType *uint64 `json:"PayloadType,omitnil,omitempty" name:"PayloadType"` // PayloadType为5,PayloadUuid必须填写。PayloadType不是5时,不需要填写,填写会被后台忽略。该值必须是32长度的十六进制。 PayloadUuid *string `json:"PayloadUuid,omitnil,omitempty" name:"PayloadUuid"` // SEI发送间隔,单位毫秒,默认值为1000。 Interval *uint64 `json:"Interval,omitnil,omitempty" name:"Interval"` // 取值范围[0,1],填1:发送关键帧时会确保带SEI;填0:发送关键帧时不确保带SEI。默认值为0。 FollowIdr *uint64 `json:"FollowIdr,omitnil,omitempty" name:"FollowIdr"` }
type McuPublishCdnParam ¶ added in v1.0.515
type McuPublishCdnParam struct { // CDN转推URL,只支持rtmp链接。 // 注:若更新转推时,URL有任何变化,都会断流重推。 PublishCdnUrl *string `json:"PublishCdnUrl,omitnil,omitempty" name:"PublishCdnUrl"` // 是否是腾讯云CDN,0为转推非腾讯云CDN,1为转推腾讯CDN,不携带该参数默认为1。注意:1,为避免误产生转推费用,该参数建议明确填写,转推非腾讯云CDN时会产生转推费用,详情参见接口文档说明;2,国内站默认只支持转推腾讯云CDN,如您有转推第三方CDN需求,请联系腾讯云技术支持。 IsTencentCdn *uint64 `json:"IsTencentCdn,omitnil,omitempty" name:"IsTencentCdn"` }
type McuSeiParams ¶ added in v1.0.515
type McuSeiParams struct { // 音量布局SEI LayoutVolume *McuLayoutVolume `json:"LayoutVolume,omitnil,omitempty" name:"LayoutVolume"` // 透传SEI PassThrough *McuPassThrough `json:"PassThrough,omitnil,omitempty" name:"PassThrough"` }
type McuUserInfoParams ¶ added in v1.0.515
type McuUserInfoParams struct { // 用户参数。 UserInfo *MixUserInfo `json:"UserInfo,omitnil,omitempty" name:"UserInfo"` }
type McuVideoParams ¶ added in v1.0.515
type McuVideoParams struct { // 输出流视频编码参数。 VideoEncode *VideoEncode `json:"VideoEncode,omitnil,omitempty" name:"VideoEncode"` // 混流布局参数。 LayoutParams *McuLayoutParams `json:"LayoutParams,omitnil,omitempty" name:"LayoutParams"` // 整个画布背景颜色,常用的颜色有: // 红色:0xcc0033。 // 黄色:0xcc9900。 // 绿色:0xcccc33。 // 蓝色:0x99CCFF。 // 黑色:0x000000。 // 白色:0xFFFFFF。 // 灰色:0x999999。 BackGroundColor *string `json:"BackGroundColor,omitnil,omitempty" name:"BackGroundColor"` // 整个画布的背景图url,优先级高于BackGroundColor。支持png、jpg、jpeg格式。图片大小限制不超过5MB。 // 注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,背景图将不会生效。 BackgroundImageUrl *string `json:"BackgroundImageUrl,omitnil,omitempty" name:"BackgroundImageUrl"` // 混流布局的水印参数。 WaterMarkList []*McuWaterMarkParams `json:"WaterMarkList,omitnil,omitempty" name:"WaterMarkList"` // 背景图在输出时的显示模式:0为裁剪,1为缩放并显示黑底,2为变比例伸缩。后台默认为变比例伸缩。 BackgroundRenderMode *uint64 `json:"BackgroundRenderMode,omitnil,omitempty" name:"BackgroundRenderMode"` }
type McuWaterMarkImage ¶ added in v1.0.515
type McuWaterMarkImage struct { // 水印图片URL地址,支持png、jpg、jpeg格式。图片大小限制不超过5MB。 // 注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,水印图片将不会生效。 WaterMarkUrl *string `json:"WaterMarkUrl,omitnil,omitempty" name:"WaterMarkUrl"` // 水印在输出时的宽。单位为像素值。 WaterMarkWidth *uint64 `json:"WaterMarkWidth,omitnil,omitempty" name:"WaterMarkWidth"` // 水印在输出时的高。单位为像素值。 WaterMarkHeight *uint64 `json:"WaterMarkHeight,omitnil,omitempty" name:"WaterMarkHeight"` // 水印在输出时的X偏移。单位为像素值。 LocationX *uint64 `json:"LocationX,omitnil,omitempty" name:"LocationX"` // 水印在输出时的Y偏移。单位为像素值。 LocationY *uint64 `json:"LocationY,omitnil,omitempty" name:"LocationY"` // 水印在输出时的层级,不填默认为0。 ZOrder *uint64 `json:"ZOrder,omitnil,omitempty" name:"ZOrder"` // 动态水印类型,默认为0。0:关闭;1:随机位置,每秒变动一次;2:边界扫描反弹,每帧变动一次。 DynamicPosType *uint64 `json:"DynamicPosType,omitnil,omitempty" name:"DynamicPosType"` }
type McuWaterMarkParams ¶ added in v1.0.515
type McuWaterMarkParams struct { // 水印类型,0为图片(默认),1为文字。 WaterMarkType *uint64 `json:"WaterMarkType,omitnil,omitempty" name:"WaterMarkType"` // 图片水印参数。WaterMarkType为0指定。 WaterMarkImage *McuWaterMarkImage `json:"WaterMarkImage,omitnil,omitempty" name:"WaterMarkImage"` // 文字水印参数。WaterMarkType为1指定。 WaterMarkText *McuWaterMarkText `json:"WaterMarkText,omitnil,omitempty" name:"WaterMarkText"` }
type McuWaterMarkText ¶ added in v1.0.611
type McuWaterMarkText struct { // 文字水印内容。 Text *string `json:"Text,omitnil,omitempty" name:"Text"` // 水印在输出时的宽。单位为像素值。 WaterMarkWidth *uint64 `json:"WaterMarkWidth,omitnil,omitempty" name:"WaterMarkWidth"` // 水印在输出时的高。单位为像素值。 WaterMarkHeight *uint64 `json:"WaterMarkHeight,omitnil,omitempty" name:"WaterMarkHeight"` // 水印在输出时的X偏移。单位为像素值。 LocationX *uint64 `json:"LocationX,omitnil,omitempty" name:"LocationX"` // 水印在输出时的Y偏移。单位为像素值。 LocationY *uint64 `json:"LocationY,omitnil,omitempty" name:"LocationY"` // 字体大小 FontSize *uint64 `json:"FontSize,omitnil,omitempty" name:"FontSize"` // 字体颜色,默认为白色。常用的颜色有: 红色:0xcc0033。 黄色:0xcc9900。 绿色:0xcccc33。 蓝色:0x99CCFF。 黑色:0x000000。 白色:0xFFFFFF。 灰色:0x999999。 FontColor *string `json:"FontColor,omitnil,omitempty" name:"FontColor"` // 字体背景色,不配置默认为透明。常用的颜色有: 红色:0xcc0033。 黄色:0xcc9900。 绿色:0xcccc33。 蓝色:0x99CCFF。 黑色:0x000000。 白色:0xFFFFFF。 灰色:0x999999。 BackGroundColor *string `json:"BackGroundColor,omitnil,omitempty" name:"BackGroundColor"` // 动态水印类型,默认为0。0:关闭;1:随机位置,每秒变动一次;2:边界扫描反弹,每帧变动一次。 DynamicPosType *uint64 `json:"DynamicPosType,omitnil,omitempty" name:"DynamicPosType"` // 水印在输出时的层级,不填默认为0。 ZOrder *uint64 `json:"ZOrder,omitnil,omitempty" name:"ZOrder"` // 水印字体,不填默认为Tencent。支持设置以下值: Tencent (默认) SourceHanSans Font *string `json:"Font,omitnil,omitempty" name:"Font"` }
type MixLayout ¶ added in v1.0.400
type MixLayout struct { // 画布上该画面左上角的 y 轴坐标,取值范围 [0, 1920],不能超过画布的高。 Top *uint64 `json:"Top,omitnil,omitempty" name:"Top"` // 画布上该画面左上角的 x 轴坐标,取值范围 [0, 1920],不能超过画布的宽。 Left *uint64 `json:"Left,omitnil,omitempty" name:"Left"` // 画布上该画面宽度的相对值,取值范围 [0, 1920],与Left相加不应超过画布的宽。 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 画布上该画面高度的相对值,取值范围 [0, 1920],与Top相加不应超过画布的高。 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` // 字符串内容为待显示在该画面的主播对应的UserId,如果不指定,会按照主播加入房间的顺序匹配。 UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 画布的透明度值,取值范围[0, 255]。0表示不透明,255表示全透明。默认值为0。 Alpha *uint64 `json:"Alpha,omitnil,omitempty" name:"Alpha"` // 0 :拉伸模式,这个模式下整个视频内容会全部显示,并填满子画面,在源视频和目的视频宽高比不一致的时候,画面不会缺少内容,但是画面可能产生形变; // // 1 :剪裁模式(默认),这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸,并填满子画面画布,在源视频和目的视频宽高比不一致的时候,画面保持不变形,但是会被剪裁; // // 2 :填黑模式,这个模式下会严格保持源视频的宽高比进行等比缩放,在源视频和目的视频宽高比不一致的时候,画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景; // // 3 :智能拉伸模式,这个模式类似剪裁模式,区别是在源视频和目的视频宽高比不一致的时候,限制了最大剪裁比例为画面的宽度或者高度的20%; RenderMode *uint64 `json:"RenderMode,omitnil,omitempty" name:"RenderMode"` // 对应订阅流的主辅路标识: // 0:主流(默认); // 1:辅流; MediaId *uint64 `json:"MediaId,omitnil,omitempty" name:"MediaId"` // 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。 ImageLayer *uint64 `json:"ImageLayer,omitnil,omitempty" name:"ImageLayer"` // 图片的url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。 SubBackgroundImage *string `json:"SubBackgroundImage,omitnil,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,omitnil,omitempty" name:"MixLayoutMode"` // 如果MixLayoutMode 选择为4自定义布局模式的话,设置此参数为每个主播所对应的布局画面的详细信息,最大不超过25个。 MixLayoutList []*MixLayout `json:"MixLayoutList,omitnil,omitempty" name:"MixLayoutList"` // 录制背景颜色,RGB的颜色表的16进制表示,每个颜色通过8bit长度标识,默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500,格式规范:‘#‘开头,后面跟固定RGB的颜色值 BackGroundColor *string `json:"BackGroundColor,omitnil,omitempty" name:"BackGroundColor"` // 在布局模式为1:悬浮布局和 2:屏幕分享布局时,设定为显示大视频画面的UserId。不填的话:悬浮布局默认是第一个进房间的主播,屏幕分享布局默认是背景色 MaxResolutionUserId *string `json:"MaxResolutionUserId,omitnil,omitempty" name:"MaxResolutionUserId"` // 主辅路标识, // 0:主流(默认); // 1:辅流(屏幕分享); // 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路,MixLayoutList内代表的是自定义用户的主辅路。 MediaId *uint64 `json:"MediaId,omitnil,omitempty" name:"MediaId"` // 图片的url地址, 只支持jpg, png,大小限制不超过5M,url不可包含中文。 BackgroundImageUrl *string `json:"BackgroundImageUrl,omitnil,omitempty" name:"BackgroundImageUrl"` // 设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 PlaceHolderMode *uint64 `json:"PlaceHolderMode,omitnil,omitempty" name:"PlaceHolderMode"` // 背景画面宽高比不一致的时候处理方案,与MixLayoufList定义的RenderMode一致。 BackgroundImageRenderMode *uint64 `json:"BackgroundImageRenderMode,omitnil,omitempty" name:"BackgroundImageRenderMode"` // 子画面占位图url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。 DefaultSubBackgroundImage *string `json:"DefaultSubBackgroundImage,omitnil,omitempty" name:"DefaultSubBackgroundImage"` // 水印布局参数, 最多支持25个。 WaterMarkList []*WaterMark `json:"WaterMarkList,omitnil,omitempty" name:"WaterMarkList"` // 模板布局下,背景画面宽高比不一致的时候处理方案。自定义布局不生效,与MixLayoufList定义的RenderMode一致。 RenderMode *uint64 `json:"RenderMode,omitnil,omitempty" name:"RenderMode"` // 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 MaxResolutionUserAlign *uint64 `json:"MaxResolutionUserAlign,omitnil,omitempty" name:"MaxResolutionUserAlign"` }
type MixTranscodeParams ¶ added in v1.0.400
type MixTranscodeParams struct { // 录制视频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。 VideoParams *VideoParams `json:"VideoParams,omitnil,omitempty" name:"VideoParams"` // 录制音频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。 AudioParams *AudioParams `json:"AudioParams,omitnil,omitempty" name:"AudioParams"` }
type MixUserInfo ¶ added in v1.0.515
type MixUserInfo struct { // 用户ID。 UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 动态布局时房间信息必须和主房间信息保持一致,自定义布局时房间信息必须和MixLayoutList中对应用户的房间信息保持一致,不填时默认与主房间信息一致。 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 房间号类型,0为整型房间号,1为字符串房间号。 RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"` }
type ModifyCloudRecordingRequest ¶ added in v1.0.400
type ModifyCloudRecordingRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 录制任务的唯一Id,在启动录制成功后会返回。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 需要更新的混流的布局参数。 MixLayoutParams *MixLayoutParams `json:"MixLayoutParams,omitnil,omitempty" name:"MixLayoutParams"` // 指定订阅流白名单或者黑名单。 SubscribeStreamUserIds *SubscribeStreamUserIds `json:"SubscribeStreamUserIds,omitnil,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 ModifyCloudRecordingRequestParams ¶ added in v1.0.426
type ModifyCloudRecordingRequestParams struct { // TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 录制任务的唯一Id,在启动录制成功后会返回。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 需要更新的混流的布局参数。 MixLayoutParams *MixLayoutParams `json:"MixLayoutParams,omitnil,omitempty" name:"MixLayoutParams"` // 指定订阅流白名单或者黑名单。 SubscribeStreamUserIds *SubscribeStreamUserIds `json:"SubscribeStreamUserIds,omitnil,omitempty" name:"SubscribeStreamUserIds"` }
Predefined struct for user
type ModifyCloudRecordingResponse ¶ added in v1.0.400
type ModifyCloudRecordingResponse struct { *tchttp.BaseResponse Response *ModifyCloudRecordingResponseParams `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 ModifyCloudRecordingResponseParams ¶ added in v1.0.426
type ModifyCloudRecordingResponseParams struct { // 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type ModifyPictureRequest ¶
type ModifyPictureRequest struct { *tchttp.BaseRequest // 图片id PictureId *uint64 `json:"PictureId,omitnil,omitempty" name:"PictureId"` // 应用id SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 图片长度 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` // 图片宽度 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 显示位置x轴方向 XPosition *uint64 `json:"XPosition,omitnil,omitempty" name:"XPosition"` // 显示位置y轴方向 YPosition *uint64 `json:"YPosition,omitnil,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 ModifyPictureRequestParams ¶ added in v1.0.426
type ModifyPictureRequestParams struct { // 图片id PictureId *uint64 `json:"PictureId,omitnil,omitempty" name:"PictureId"` // 应用id SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 图片长度 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` // 图片宽度 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 显示位置x轴方向 XPosition *uint64 `json:"XPosition,omitnil,omitempty" name:"XPosition"` // 显示位置y轴方向 YPosition *uint64 `json:"YPosition,omitnil,omitempty" name:"YPosition"` }
Predefined struct for user
type ModifyPictureResponse ¶
type ModifyPictureResponse struct { *tchttp.BaseResponse Response *ModifyPictureResponseParams `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 ModifyPictureResponseParams ¶ added in v1.0.426
type ModifyPictureResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type OneSdkAppIdTranscodeTimeUsagesInfo ¶
type OneSdkAppIdTranscodeTimeUsagesInfo struct { // 旁路转码时长查询结果数组 SdkAppIdTranscodeTimeUsages []*SdkAppIdTrtcMcuTranscodeTimeUsage `json:"SdkAppIdTranscodeTimeUsages,omitnil,omitempty" name:"SdkAppIdTranscodeTimeUsages"` // 查询记录数量 TotalNum *uint64 `json:"TotalNum,omitnil,omitempty" name:"TotalNum"` // 所查询的应用ID,可能值为:1-应用的应用ID,2-total,显示为total则表示查询的是所有应用的用量合计值。 SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` }
type OutputParams ¶
type OutputParams struct { // 直播流 ID,由用户自定义设置,该流 ID 不能与用户旁路的流 ID 相同,限制64字节。 StreamId *string `json:"StreamId,omitnil,omitempty" name:"StreamId"` // 取值范围[0,1], 填0:直播流为音视频(默认); 填1:直播流为纯音频 PureAudioStream *uint64 `json:"PureAudioStream,omitnil,omitempty" name:"PureAudioStream"` // 自定义录制文件名称前缀。请先在实时音视频控制台开通录制功能,https://cloud.tencent.com/document/product/647/50768。 // 【注意】该方式仅对旧版云端录制功能的应用生效,新版云端录制功能的应用请用接口CreateCloudRecording发起录制。新、旧云端录制类型判断方式请见:https://cloud.tencent.com/document/product/647/50768#record RecordId *string `json:"RecordId,omitnil,omitempty" name:"RecordId"` // 取值范围[0,1],填0无实际含义; 填1:指定录制文件格式为mp3。此参数不建议使用,建议在实时音视频控制台配置纯音频录制模板。 RecordAudioOnly *uint64 `json:"RecordAudioOnly,omitnil,omitempty" name:"RecordAudioOnly"` }
type PictureInfo ¶
type PictureInfo struct { // 图片长度 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` // 图片宽度 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 显示位置x轴方向 XPosition *uint64 `json:"XPosition,omitnil,omitempty" name:"XPosition"` // 显示位置y轴方向 YPosition *uint64 `json:"YPosition,omitnil,omitempty" name:"YPosition"` // 应用id SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 图片id PictureId *uint64 `json:"PictureId,omitnil,omitempty" name:"PictureId"` }
type PresetLayoutConfig ¶
type PresetLayoutConfig struct { // 指定显示在该画面上的用户ID。如果不指定用户ID,会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。 UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 当该画面指定用户时,代表用户的流类型。0为摄像头,1为屏幕分享。小画面为web用户时此值填0。 StreamType *uint64 `json:"StreamType,omitnil,omitempty" name:"StreamType"` // 该画面在输出时的宽度,单位为像素值,不填默认为0。 ImageWidth *uint64 `json:"ImageWidth,omitnil,omitempty" name:"ImageWidth"` // 该画面在输出时的高度,单位为像素值,不填默认为0。 ImageHeight *uint64 `json:"ImageHeight,omitnil,omitempty" name:"ImageHeight"` // 该画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。 LocationX *uint64 `json:"LocationX,omitnil,omitempty" name:"LocationX"` // 该画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。 LocationY *uint64 `json:"LocationY,omitnil,omitempty" name:"LocationY"` // 该画面在输出时的层级,不填默认为0。 ZOrder *uint64 `json:"ZOrder,omitnil,omitempty" name:"ZOrder"` // 该画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底。不填默认为0。 RenderMode *uint64 `json:"RenderMode,omitnil,omitempty" name:"RenderMode"` // 该当前位置用户混入的流类型:0为混入音视频,1为只混入视频,2为只混入音频。默认为0,建议配合指定用户ID使用。 MixInputType *uint64 `json:"MixInputType,omitnil,omitempty" name:"MixInputType"` // 占位图ID。启用占位图功能时,在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M,在实时音视频控制台上传并生成,https://cloud.tencent.com/document/product/647/50769 PlaceImageId *uint64 `json:"PlaceImageId,omitnil,omitempty" name:"PlaceImageId"` }
type PublishCdnParams ¶
type QualityData ¶
type QualityData struct { // 数据内容 Content []*TimeValue `json:"Content,omitnil,omitempty" name:"Content"` // 用户ID UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 对端Id,为空时表示上行数据 // 注意:此字段可能返回 null,表示取不到有效值。 PeerId *string `json:"PeerId,omitnil,omitempty" name:"PeerId"` // 数据类型 DataType *string `json:"DataType,omitnil,omitempty" name:"DataType"` }
type RecognizeConfig ¶ added in v1.0.925
type RecognizeConfig struct { // 语音识别支持的语言,默认是"zh"。目前全量支持的语言如下,等号左面是语言英文名,右面是Language字段需要填写的值,该值遵循[ISO639](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes): // Chinese = "zh" // Chinese_TW = "zh-TW" // English = "en" // Vietnamese = "vi" // Japanese = "ja" // Korean = "ko" // Indonesia = "id" // Thai = "th" // Portuguese = "pt" // Turkish = "tr" // Arabic = "ar" // Spanish = "es" // Hindi = "hi" // French = "fr" // Malay = "ms" // Filipino = "fil" // German = "de" // Italian = "it" // Russian = "ru" // // 注意: // 如果缺少满足您需求的语言,请联系我们技术人员。 // tencent asr不支持"it"和"ru",google asr全都支持。 Language *string `json:"Language,omitnil,omitempty" name:"Language"` // 使用的模型,目前支持tencent和google,默认是tencent。 Model *string `json:"Model,omitnil,omitempty" name:"Model"` // 翻译功能支持的语言,如果填写,则会启用翻译,不填则只会使用语音识别。 // 目前全量支持的语言如下,等号左面是语言英文名,右面是Language字段需要填写的值,该值遵循[ISO639](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes): // Chinese = "zh" // Chinese_TW = "zh-TW" // English = "en" // Vietnamese = "vi" // Japanese = "ja" // Korean = "ko" // Indonesia = "id" // Thai = "th" // Portuguese = "pt" // Turkish = "tr" // Arabic = "ar" // Spanish = "es" // Hindi = "hi" // French = "fr" // Malay = "ms" // Filipino = "fil" // German = "de" // Italian = "it" // Russian = "ru" // // 注意: // 如果缺少满足您需求的语言,请联系我们技术人员。 // google支持上述语言两两之间翻译,tencent只支持部分语言之间翻译。 // // tencnet目标语言,各源语言的目标语言支持列表如下,冒号左侧是目标语言,右侧是源语言: // - zh(简体中文):zh-TW(繁体中文)、en(英语)、ja(日语)、ko(韩语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)、vi(越南语)、id(印尼语)、th(泰语)、ms(马来语) // - zh-TW(繁体中文):zh(简体中文)、en(英语)、ja(日语)、ko(韩语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)、vi(越南语)、id(印尼语)、th(泰语)、ms(马来语) // - en(英语):zh(中文)、zh-TW(繁体中文)、ja(日语)、ko(韩语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)、vi(越南语)、id(印尼语)、th(泰语)、ms(马来语)、ar(阿拉伯语)、hi(印地语) // - ja(日语):zh(中文)、zh-TW(繁体中文)、en(英语)、ko(韩语) // - ko(韩语):zh(中文)、zh-TW(繁体中文)、en(英语)、ja(日语) // - fr(法语):zh(中文)、zh-TW(繁体中文)、en(英语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语) // - es(西班牙语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语) // - it(意大利语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语) // - de(德语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、it(意大利语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语) // - tr(土耳其语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、ru(俄语)、pt(葡萄牙语) // - ru(俄语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、pt(葡萄牙语) // - pt(葡萄牙语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语) // - vi(越南语):zh(中文)、zh-TW(繁体中文)、en(英语) // - id(印尼语):zh(中文)、zh-TW(繁体中文)、en(英语) // - th(泰语):zh(中文)、zh-TW(繁体中文)、en(英语) // - ms(马来语):zh(中文)、zh-TW(繁体中文)、en(英语) // - ar(阿拉伯语):en(英语) // - hi(印地语):en(英语) TranslationLanguage *string `json:"TranslationLanguage,omitnil,omitempty" name:"TranslationLanguage"` }
type RecordParams ¶ added in v1.0.400
type RecordParams struct { // 录制模式: // 1:单流录制,分别录制房间的订阅UserId的音频和视频,将录制文件上传至云存储; // 2:合流录制,将房间内订阅UserId的音视频混录成一个音视频文件,将录制文件上传至云存储; RecordMode *uint64 `json:"RecordMode,omitnil,omitempty" name:"RecordMode"` // 房间内持续没有用户(主播)上行推流的状态超过MaxIdleTime的时长,自动停止录制,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。 MaxIdleTime *uint64 `json:"MaxIdleTime,omitnil,omitempty" name:"MaxIdleTime"` // 录制的媒体流类型: // 0:录制音频+视频流(默认); // 1:仅录制音频流; // 2:仅录制视频流, StreamType *uint64 `json:"StreamType,omitnil,omitempty" name:"StreamType"` // 指定订阅流白名单或者黑名单。 SubscribeStreamUserIds *SubscribeStreamUserIds `json:"SubscribeStreamUserIds,omitnil,omitempty" name:"SubscribeStreamUserIds"` // 输出文件的格式(存储至COS等第三方存储时有效)。0:(默认)输出文件为hls格式。1:输出文件格式为hls+mp4。2:输出文件格式为hls+aac 。3:输出文件格式为mp4。4:输出文件格式为aac。 // // 存储到云点播VOD时此参数无效,存储到VOD时请通过TencentVod(https://cloud.tencent.com/document/api/647/44055#TencentVod)内的MediaType设置。 OutputFormat *uint64 `json:"OutputFormat,omitnil,omitempty" name:"OutputFormat"` // 单流录制模式下,用户的音视频是否合并,0:单流音视频不合并(默认)。1:单流音视频合并成一个ts。合流录制此参数无需设置,默认音视频合并。 AvMerge *uint64 `json:"AvMerge,omitnil,omitempty" name:"AvMerge"` // 如果是aac或者mp4文件格式,超过长度限制后,系统会自动拆分视频文件。单位:分钟。默认为1440min(24h),取值范围为1-1440。【单文件限制最大为2G,满足文件大小 >2G 或录制时长度 > 24h任意一个条件,文件都会自动切分】 // Hls 格式录制此参数不生效。 MaxMediaFileDuration *uint64 `json:"MaxMediaFileDuration,omitnil,omitempty" name:"MaxMediaFileDuration"` // 指定录制主辅流,0:主流+辅流(默认);1:主流;2:辅流。 MediaId *uint64 `json:"MediaId,omitnil,omitempty" name:"MediaId"` // 上行视频停止时,录制的补帧类型,0:补最后一帧 1:补黑帧 FillType *uint64 `json:"FillType,omitnil,omitempty" name:"FillType"` }
type RecordUsage ¶
type RecordUsage struct { // 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。 TimeKey *string `json:"TimeKey,omitnil,omitempty" name:"TimeKey"` // 视频时长-标清SD,单位:秒。 Class1VideoTime *uint64 `json:"Class1VideoTime,omitnil,omitempty" name:"Class1VideoTime"` // 视频时长-高清HD,单位:秒。 Class2VideoTime *uint64 `json:"Class2VideoTime,omitnil,omitempty" name:"Class2VideoTime"` // 视频时长-超清HD,单位:秒。 Class3VideoTime *uint64 `json:"Class3VideoTime,omitnil,omitempty" name:"Class3VideoTime"` // 语音时长,单位:秒。 AudioTime *uint64 `json:"AudioTime,omitnil,omitempty" name:"AudioTime"` }
type RemoveUserByStrRoomIdRequest ¶
type RemoveUserByStrRoomIdRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 房间号。 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 要移出的用户列表,最多10个。 UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"` }
func NewRemoveUserByStrRoomIdRequest ¶
func NewRemoveUserByStrRoomIdRequest() (request *RemoveUserByStrRoomIdRequest)
func (*RemoveUserByStrRoomIdRequest) FromJsonString ¶
func (r *RemoveUserByStrRoomIdRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*RemoveUserByStrRoomIdRequest) ToJsonString ¶
func (r *RemoveUserByStrRoomIdRequest) ToJsonString() string
type RemoveUserByStrRoomIdRequestParams ¶ added in v1.0.426
type RemoveUserByStrRoomIdRequestParams struct { // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 房间号。 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 要移出的用户列表,最多10个。 UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"` }
Predefined struct for user
type RemoveUserByStrRoomIdResponse ¶
type RemoveUserByStrRoomIdResponse struct { *tchttp.BaseResponse Response *RemoveUserByStrRoomIdResponseParams `json:"Response"` }
func NewRemoveUserByStrRoomIdResponse ¶
func NewRemoveUserByStrRoomIdResponse() (response *RemoveUserByStrRoomIdResponse)
func (*RemoveUserByStrRoomIdResponse) FromJsonString ¶
func (r *RemoveUserByStrRoomIdResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*RemoveUserByStrRoomIdResponse) ToJsonString ¶
func (r *RemoveUserByStrRoomIdResponse) ToJsonString() string
type RemoveUserByStrRoomIdResponseParams ¶ added in v1.0.426
type RemoveUserByStrRoomIdResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type RemoveUserRequest ¶
type RemoveUserRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 房间号。 RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 要移出的用户列表,最多10个。 UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"` }
func NewRemoveUserRequest ¶
func NewRemoveUserRequest() (request *RemoveUserRequest)
func (*RemoveUserRequest) FromJsonString ¶
func (r *RemoveUserRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*RemoveUserRequest) ToJsonString ¶
func (r *RemoveUserRequest) ToJsonString() string
type RemoveUserRequestParams ¶ added in v1.0.426
type RemoveUserRequestParams struct { // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 房间号。 RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 要移出的用户列表,最多10个。 UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"` }
Predefined struct for user
type RemoveUserResponse ¶
type RemoveUserResponse struct { *tchttp.BaseResponse Response *RemoveUserResponseParams `json:"Response"` }
func NewRemoveUserResponse ¶
func NewRemoveUserResponse() (response *RemoveUserResponse)
func (*RemoveUserResponse) FromJsonString ¶
func (r *RemoveUserResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*RemoveUserResponse) ToJsonString ¶
func (r *RemoveUserResponse) ToJsonString() string
type RemoveUserResponseParams ¶ added in v1.0.426
type RemoveUserResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type RoomState ¶
type RoomState struct { // 通话ID(唯一标识一次通话) CommId *string `json:"CommId,omitnil,omitempty" name:"CommId"` // 房间号 RoomString *string `json:"RoomString,omitnil,omitempty" name:"RoomString"` // 房间创建时间 CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"` // 房间销毁时间 DestroyTime *uint64 `json:"DestroyTime,omitnil,omitempty" name:"DestroyTime"` // 房间是否已经结束 IsFinished *bool `json:"IsFinished,omitnil,omitempty" name:"IsFinished"` // 房间创建者Id UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` }
type RowValues ¶ added in v1.0.732
type RowValues struct { // 数据值 // 注意:此字段可能返回 null,表示取不到有效值。 RowValue []*int64 `json:"RowValue,omitnil,omitempty" name:"RowValue"` }
type ScaleInfomation ¶
type ScaleInfomation struct { // 每天开始的时间 Time *uint64 `json:"Time,omitnil,omitempty" name:"Time"` // 房间人数,用户重复进入同一个房间为1次 // 注意:此字段可能返回 null,表示取不到有效值。 UserNumber *uint64 `json:"UserNumber,omitnil,omitempty" name:"UserNumber"` // 房间人次,用户每次进入房间为一次 // 注意:此字段可能返回 null,表示取不到有效值。 UserCount *uint64 `json:"UserCount,omitnil,omitempty" name:"UserCount"` // sdkappid下一天内的房间数 // 注意:此字段可能返回 null,表示取不到有效值。 RoomNumbers *uint64 `json:"RoomNumbers,omitnil,omitempty" name:"RoomNumbers"` }
type SdkAppIdRecordUsage ¶
type SdkAppIdRecordUsage struct { // SdkAppId的值。 SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 统计的时间点数据。 Usages []*RecordUsage `json:"Usages,omitnil,omitempty" name:"Usages"` }
type SdkAppIdTrtcMcuTranscodeTimeUsage ¶
type SdkAppIdTrtcMcuTranscodeTimeUsage struct { // 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。 TimeKey *string `json:"TimeKey,omitnil,omitempty" name:"TimeKey"` // 语音时长,单位:秒。 AudioTime *uint64 `json:"AudioTime,omitnil,omitempty" name:"AudioTime"` // 视频时长-标清SD,单位:秒。 VideoTimeSd *uint64 `json:"VideoTimeSd,omitnil,omitempty" name:"VideoTimeSd"` // 视频时长-高清HD,单位:秒。 VideoTimeHd *uint64 `json:"VideoTimeHd,omitnil,omitempty" name:"VideoTimeHd"` // 视频时长-全高清FHD,单位:秒。 VideoTimeFhd *uint64 `json:"VideoTimeFhd,omitnil,omitempty" name:"VideoTimeFhd"` // 带宽,单位:Mbps。 Flux *float64 `json:"Flux,omitnil,omitempty" name:"Flux"` }
type SeriesInfo ¶ added in v1.0.530
type SeriesInfos ¶ added in v1.0.732
type SingleSubscribeParams ¶ added in v1.0.515
type SingleSubscribeParams struct { // 用户媒体流参数。 UserMediaStream *UserMediaStream `json:"UserMediaStream,omitnil,omitempty" name:"UserMediaStream"` }
type SmallVideoLayoutParams ¶
type SmallVideoLayoutParams struct { // 代表小画面对应的用户ID。 UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 代表小画面对应的流类型,0为摄像头,1为屏幕分享。小画面为web用户时此值填0。 StreamType *uint64 `json:"StreamType,omitnil,omitempty" name:"StreamType"` // 小画面在输出时的宽度,单位为像素值,不填默认为0。 ImageWidth *uint64 `json:"ImageWidth,omitnil,omitempty" name:"ImageWidth"` // 小画面在输出时的高度,单位为像素值,不填默认为0。 ImageHeight *uint64 `json:"ImageHeight,omitnil,omitempty" name:"ImageHeight"` // 小画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。 LocationX *uint64 `json:"LocationX,omitnil,omitempty" name:"LocationX"` // 小画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。 LocationY *uint64 `json:"LocationY,omitnil,omitempty" name:"LocationY"` }
type StartAITranscriptionRequest ¶ added in v1.0.925
type StartAITranscriptionRequest struct { *tchttp.BaseRequest // TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和开启转录任务的房间使用的SdkAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),表示开启转录任务的房间号。 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 转录机器人的参数。 TranscriptionParams *TranscriptionParams `json:"TranscriptionParams,omitnil,omitempty" name:"TranscriptionParams"` // 调用方传入的唯一Id,服务端用来去重。 // 注意: // 如果传入该参数,服务端优先使用该参数来去重。 // 如果不传该参数,服务端的去重策略如下: // - 如果TranscriptionMode字段是0,则一个房间只能开启一个任务 // - 如果TranscriptionMode字段是1,则一个TargetUserId只能开启一个任务 SessionId *string `json:"SessionId,omitnil,omitempty" name:"SessionId"` // TRTC房间号的类型,0代表数字房间号,1代表字符串房间号。不填默认是数字房间号。 RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"` // 语音识别配置。 RecognizeConfig *RecognizeConfig `json:"RecognizeConfig,omitnil,omitempty" name:"RecognizeConfig"` }
func NewStartAITranscriptionRequest ¶ added in v1.0.925
func NewStartAITranscriptionRequest() (request *StartAITranscriptionRequest)
func (*StartAITranscriptionRequest) FromJsonString ¶ added in v1.0.925
func (r *StartAITranscriptionRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StartAITranscriptionRequest) ToJsonString ¶ added in v1.0.925
func (r *StartAITranscriptionRequest) ToJsonString() string
type StartAITranscriptionRequestParams ¶ added in v1.0.925
type StartAITranscriptionRequestParams struct { // TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和开启转录任务的房间使用的SdkAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),表示开启转录任务的房间号。 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 转录机器人的参数。 TranscriptionParams *TranscriptionParams `json:"TranscriptionParams,omitnil,omitempty" name:"TranscriptionParams"` // 调用方传入的唯一Id,服务端用来去重。 // 注意: // 如果传入该参数,服务端优先使用该参数来去重。 // 如果不传该参数,服务端的去重策略如下: // - 如果TranscriptionMode字段是0,则一个房间只能开启一个任务 // - 如果TranscriptionMode字段是1,则一个TargetUserId只能开启一个任务 SessionId *string `json:"SessionId,omitnil,omitempty" name:"SessionId"` // TRTC房间号的类型,0代表数字房间号,1代表字符串房间号。不填默认是数字房间号。 RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"` // 语音识别配置。 RecognizeConfig *RecognizeConfig `json:"RecognizeConfig,omitnil,omitempty" name:"RecognizeConfig"` }
Predefined struct for user
type StartAITranscriptionResponse ¶ added in v1.0.925
type StartAITranscriptionResponse struct { *tchttp.BaseResponse Response *StartAITranscriptionResponseParams `json:"Response"` }
func NewStartAITranscriptionResponse ¶ added in v1.0.925
func NewStartAITranscriptionResponse() (response *StartAITranscriptionResponse)
func (*StartAITranscriptionResponse) FromJsonString ¶ added in v1.0.925
func (r *StartAITranscriptionResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StartAITranscriptionResponse) ToJsonString ¶ added in v1.0.925
func (r *StartAITranscriptionResponse) ToJsonString() string
type StartAITranscriptionResponseParams ¶ added in v1.0.925
type StartAITranscriptionResponseParams struct { // 用于唯一标识转录任务。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type StartMCUMixTranscodeByStrRoomIdRequest ¶
type StartMCUMixTranscodeByStrRoomIdRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 字符串房间号。 StrRoomId *string `json:"StrRoomId,omitnil,omitempty" name:"StrRoomId"` // 混流输出控制参数。 OutputParams *OutputParams `json:"OutputParams,omitnil,omitempty" name:"OutputParams"` // 混流输出编码参数。 EncodeParams *EncodeParams `json:"EncodeParams,omitnil,omitempty" name:"EncodeParams"` // 混流输出布局参数。 LayoutParams *LayoutParams `json:"LayoutParams,omitnil,omitempty" name:"LayoutParams"` // 第三方CDN转推参数。如需转推至腾讯云云直播,此参数无需填写,会默认转推 PublishCdnParams *PublishCdnParams `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"` }
func NewStartMCUMixTranscodeByStrRoomIdRequest ¶
func NewStartMCUMixTranscodeByStrRoomIdRequest() (request *StartMCUMixTranscodeByStrRoomIdRequest)
func (*StartMCUMixTranscodeByStrRoomIdRequest) FromJsonString ¶
func (r *StartMCUMixTranscodeByStrRoomIdRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StartMCUMixTranscodeByStrRoomIdRequest) ToJsonString ¶
func (r *StartMCUMixTranscodeByStrRoomIdRequest) ToJsonString() string
type StartMCUMixTranscodeByStrRoomIdRequestParams ¶ added in v1.0.426
type StartMCUMixTranscodeByStrRoomIdRequestParams struct { // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 字符串房间号。 StrRoomId *string `json:"StrRoomId,omitnil,omitempty" name:"StrRoomId"` // 混流输出控制参数。 OutputParams *OutputParams `json:"OutputParams,omitnil,omitempty" name:"OutputParams"` // 混流输出编码参数。 EncodeParams *EncodeParams `json:"EncodeParams,omitnil,omitempty" name:"EncodeParams"` // 混流输出布局参数。 LayoutParams *LayoutParams `json:"LayoutParams,omitnil,omitempty" name:"LayoutParams"` // 第三方CDN转推参数。如需转推至腾讯云云直播,此参数无需填写,会默认转推 PublishCdnParams *PublishCdnParams `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"` }
Predefined struct for user
type StartMCUMixTranscodeByStrRoomIdResponse ¶
type StartMCUMixTranscodeByStrRoomIdResponse struct { *tchttp.BaseResponse Response *StartMCUMixTranscodeByStrRoomIdResponseParams `json:"Response"` }
func NewStartMCUMixTranscodeByStrRoomIdResponse ¶
func NewStartMCUMixTranscodeByStrRoomIdResponse() (response *StartMCUMixTranscodeByStrRoomIdResponse)
func (*StartMCUMixTranscodeByStrRoomIdResponse) FromJsonString ¶
func (r *StartMCUMixTranscodeByStrRoomIdResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StartMCUMixTranscodeByStrRoomIdResponse) ToJsonString ¶
func (r *StartMCUMixTranscodeByStrRoomIdResponse) ToJsonString() string
type StartMCUMixTranscodeByStrRoomIdResponseParams ¶ added in v1.0.426
type StartMCUMixTranscodeByStrRoomIdResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type StartMCUMixTranscodeRequest ¶
type StartMCUMixTranscodeRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 房间号。 RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 混流输出控制参数。 OutputParams *OutputParams `json:"OutputParams,omitnil,omitempty" name:"OutputParams"` // 混流输出编码参数。 EncodeParams *EncodeParams `json:"EncodeParams,omitnil,omitempty" name:"EncodeParams"` // 混流输出布局参数。 LayoutParams *LayoutParams `json:"LayoutParams,omitnil,omitempty" name:"LayoutParams"` // 第三方CDN转推参数。如需转推至腾讯云云直播,此参数无需填写,会默认转推 PublishCdnParams *PublishCdnParams `json:"PublishCdnParams,omitnil,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 StartMCUMixTranscodeRequestParams ¶ added in v1.0.426
type StartMCUMixTranscodeRequestParams struct { // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 房间号。 RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 混流输出控制参数。 OutputParams *OutputParams `json:"OutputParams,omitnil,omitempty" name:"OutputParams"` // 混流输出编码参数。 EncodeParams *EncodeParams `json:"EncodeParams,omitnil,omitempty" name:"EncodeParams"` // 混流输出布局参数。 LayoutParams *LayoutParams `json:"LayoutParams,omitnil,omitempty" name:"LayoutParams"` // 第三方CDN转推参数。如需转推至腾讯云云直播,此参数无需填写,会默认转推 PublishCdnParams *PublishCdnParams `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"` }
Predefined struct for user
type StartMCUMixTranscodeResponse ¶
type StartMCUMixTranscodeResponse struct { *tchttp.BaseResponse Response *StartMCUMixTranscodeResponseParams `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 StartMCUMixTranscodeResponseParams ¶ added in v1.0.426
type StartMCUMixTranscodeResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type StartPublishCdnStreamRequest ¶ added in v1.0.515
type StartPublishCdnStreamRequest struct { *tchttp.BaseRequest // TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 主房间信息RoomId,转推的TRTC房间所对应的RoomId。 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 主房间信息RoomType,必须和转推的房间所对应的RoomId类型相同,0为整型房间号,1为字符串房间号。 RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"` // 转推服务加入TRTC房间的机器人参数。 AgentParams *AgentParams `json:"AgentParams,omitnil,omitempty" name:"AgentParams"` // 是否转码,0表示无需转码,1表示需要转码。是否收取转码费是由WithTranscoding参数决定的,WithTranscoding为0,表示旁路转推,不会收取转码费用,WithTranscoding为1,表示混流转推,会收取转码费用。 WithTranscoding *uint64 `json:"WithTranscoding,omitnil,omitempty" name:"WithTranscoding"` // 转推流的音频编码参数。由于音频是必转码的(不会收取转码费用),所以启动任务的时候,必须填写。 AudioParams *McuAudioParams `json:"AudioParams,omitnil,omitempty" name:"AudioParams"` // 转推流的视频编码参数,不填表示纯音频转推。 VideoParams *McuVideoParams `json:"VideoParams,omitnil,omitempty" name:"VideoParams"` // 需要单流旁路转推的用户上行参数,单流旁路转推时,WithTranscoding需要设置为0。 SingleSubscribeParams *SingleSubscribeParams `json:"SingleSubscribeParams,omitnil,omitempty" name:"SingleSubscribeParams"` // 转推的CDN参数。和回推房间参数必须要有一个。 PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"` // 混流SEI参数 SeiParams *McuSeiParams `json:"SeiParams,omitnil,omitempty" name:"SeiParams"` // 回推房间信息,和转推CDN参数必须要有一个。注:回推房间需使用10.4及以上SDK版本,如您有需求,请联系腾讯云技术支持。 FeedBackRoomParams []*McuFeedBackRoomParams `json:"FeedBackRoomParams,omitnil,omitempty" name:"FeedBackRoomParams"` }
func NewStartPublishCdnStreamRequest ¶ added in v1.0.515
func NewStartPublishCdnStreamRequest() (request *StartPublishCdnStreamRequest)
func (*StartPublishCdnStreamRequest) FromJsonString ¶ added in v1.0.515
func (r *StartPublishCdnStreamRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StartPublishCdnStreamRequest) ToJsonString ¶ added in v1.0.515
func (r *StartPublishCdnStreamRequest) ToJsonString() string
type StartPublishCdnStreamRequestParams ¶ added in v1.0.515
type StartPublishCdnStreamRequestParams struct { // TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 主房间信息RoomId,转推的TRTC房间所对应的RoomId。 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // 主房间信息RoomType,必须和转推的房间所对应的RoomId类型相同,0为整型房间号,1为字符串房间号。 RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"` // 转推服务加入TRTC房间的机器人参数。 AgentParams *AgentParams `json:"AgentParams,omitnil,omitempty" name:"AgentParams"` // 是否转码,0表示无需转码,1表示需要转码。是否收取转码费是由WithTranscoding参数决定的,WithTranscoding为0,表示旁路转推,不会收取转码费用,WithTranscoding为1,表示混流转推,会收取转码费用。 WithTranscoding *uint64 `json:"WithTranscoding,omitnil,omitempty" name:"WithTranscoding"` // 转推流的音频编码参数。由于音频是必转码的(不会收取转码费用),所以启动任务的时候,必须填写。 AudioParams *McuAudioParams `json:"AudioParams,omitnil,omitempty" name:"AudioParams"` // 转推流的视频编码参数,不填表示纯音频转推。 VideoParams *McuVideoParams `json:"VideoParams,omitnil,omitempty" name:"VideoParams"` // 需要单流旁路转推的用户上行参数,单流旁路转推时,WithTranscoding需要设置为0。 SingleSubscribeParams *SingleSubscribeParams `json:"SingleSubscribeParams,omitnil,omitempty" name:"SingleSubscribeParams"` // 转推的CDN参数。和回推房间参数必须要有一个。 PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"` // 混流SEI参数 SeiParams *McuSeiParams `json:"SeiParams,omitnil,omitempty" name:"SeiParams"` // 回推房间信息,和转推CDN参数必须要有一个。注:回推房间需使用10.4及以上SDK版本,如您有需求,请联系腾讯云技术支持。 FeedBackRoomParams []*McuFeedBackRoomParams `json:"FeedBackRoomParams,omitnil,omitempty" name:"FeedBackRoomParams"` }
Predefined struct for user
type StartPublishCdnStreamResponse ¶ added in v1.0.515
type StartPublishCdnStreamResponse struct { *tchttp.BaseResponse Response *StartPublishCdnStreamResponseParams `json:"Response"` }
func NewStartPublishCdnStreamResponse ¶ added in v1.0.515
func NewStartPublishCdnStreamResponse() (response *StartPublishCdnStreamResponse)
func (*StartPublishCdnStreamResponse) FromJsonString ¶ added in v1.0.515
func (r *StartPublishCdnStreamResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StartPublishCdnStreamResponse) ToJsonString ¶ added in v1.0.515
func (r *StartPublishCdnStreamResponse) ToJsonString() string
type StartPublishCdnStreamResponseParams ¶ added in v1.0.515
type StartPublishCdnStreamResponseParams struct { // 用于唯一标识转推任务,由腾讯云服务端生成,后续更新和停止请求都需要携带TaskiD参数。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type StartStreamIngestRequest ¶ added in v1.0.803
type StartStreamIngestRequest struct { *tchttp.BaseRequest // TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和TRTC的房间所对应的SdkAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // TRTC房间号的类型。 // 【*注意】必须和录制的房间所对应的RoomId类型相同: // 0: 字符串类型的RoomId // 1: 32位整型的RoomId(默认) RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"` // 输入在线媒体流机器人的UserId,用于进房发起拉流转推任务。 UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 输入在线媒体流机器人UserId对应的校验签名,即UserId和UserSig相当于机器人进房的登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。 UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"` // 源流URL。历史原因本字段【必填】。如果是视频流,分辨率请保持不变。 StreamUrl *string `json:"StreamUrl,omitnil,omitempty" name:"StreamUrl"` // TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。 PrivateMapKey *string `json:"PrivateMapKey,omitnil,omitempty" name:"PrivateMapKey"` // 【本字段已废弃】视频编码参数。可选,如果不填,保持原始流的参数。 VideoEncodeParams *VideoEncodeParams `json:"VideoEncodeParams,omitnil,omitempty" name:"VideoEncodeParams"` // 【本字段已废弃】音频编码参数。可选,如果不填,保持原始流的参数。 AudioEncodeParams *AudioEncodeParams `json:"AudioEncodeParams,omitnil,omitempty" name:"AudioEncodeParams"` // 【本字段已废弃,请使用 StreamUrl 字段】源流URL,支持一个地址。 SourceUrl []*string `json:"SourceUrl,omitnil,omitempty" name:"SourceUrl"` // 指定视频从某个秒时间戳播放 SeekSecond *int64 `json:"SeekSecond,omitnil,omitempty" name:"SeekSecond"` }
func NewStartStreamIngestRequest ¶ added in v1.0.803
func NewStartStreamIngestRequest() (request *StartStreamIngestRequest)
func (*StartStreamIngestRequest) FromJsonString ¶ added in v1.0.803
func (r *StartStreamIngestRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StartStreamIngestRequest) ToJsonString ¶ added in v1.0.803
func (r *StartStreamIngestRequest) ToJsonString() string
type StartStreamIngestRequestParams ¶ added in v1.0.803
type StartStreamIngestRequestParams struct { // TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和TRTC的房间所对应的SdkAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。 RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"` // TRTC房间号的类型。 // 【*注意】必须和录制的房间所对应的RoomId类型相同: // 0: 字符串类型的RoomId // 1: 32位整型的RoomId(默认) RoomIdType *uint64 `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"` // 输入在线媒体流机器人的UserId,用于进房发起拉流转推任务。 UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 输入在线媒体流机器人UserId对应的校验签名,即UserId和UserSig相当于机器人进房的登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。 UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"` // 源流URL。历史原因本字段【必填】。如果是视频流,分辨率请保持不变。 StreamUrl *string `json:"StreamUrl,omitnil,omitempty" name:"StreamUrl"` // TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。 PrivateMapKey *string `json:"PrivateMapKey,omitnil,omitempty" name:"PrivateMapKey"` // 【本字段已废弃】视频编码参数。可选,如果不填,保持原始流的参数。 VideoEncodeParams *VideoEncodeParams `json:"VideoEncodeParams,omitnil,omitempty" name:"VideoEncodeParams"` // 【本字段已废弃】音频编码参数。可选,如果不填,保持原始流的参数。 AudioEncodeParams *AudioEncodeParams `json:"AudioEncodeParams,omitnil,omitempty" name:"AudioEncodeParams"` // 【本字段已废弃,请使用 StreamUrl 字段】源流URL,支持一个地址。 SourceUrl []*string `json:"SourceUrl,omitnil,omitempty" name:"SourceUrl"` // 指定视频从某个秒时间戳播放 SeekSecond *int64 `json:"SeekSecond,omitnil,omitempty" name:"SeekSecond"` }
Predefined struct for user
type StartStreamIngestResponse ¶ added in v1.0.803
type StartStreamIngestResponse struct { *tchttp.BaseResponse Response *StartStreamIngestResponseParams `json:"Response"` }
func NewStartStreamIngestResponse ¶ added in v1.0.803
func NewStartStreamIngestResponse() (response *StartStreamIngestResponse)
func (*StartStreamIngestResponse) FromJsonString ¶ added in v1.0.803
func (r *StartStreamIngestResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StartStreamIngestResponse) ToJsonString ¶ added in v1.0.803
func (r *StartStreamIngestResponse) ToJsonString() string
type StartStreamIngestResponseParams ¶ added in v1.0.803
type StartStreamIngestResponseParams struct { // 输入在线媒体流的任务 ID。任务 ID 是对一次输入在线媒体流生命周期过程的唯一标识,结束任务时会失去意义。任务 ID 需要业务保存下来,作为下次针对这个任务操作的参数。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type StartWebRecordRequest ¶ added in v1.0.883
type StartWebRecordRequest struct { *tchttp.BaseRequest // 需要录制的网页URL RecordUrl *string `json:"RecordUrl,omitnil,omitempty" name:"RecordUrl"` // 录制最大时长限制, 单位 s, 合法取值范围[1800, 36000], 默认 36000s(10 小时) MaxDurationLimit *uint64 `json:"MaxDurationLimit,omitnil,omitempty" name:"MaxDurationLimit"` // 云存储相关的参数,目前支持腾讯云对象存储以及腾讯云云点播VOD,不支持第三方云存储 StorageParams *StorageParams `json:"StorageParams,omitnil,omitempty" name:"StorageParams"` // 页面录制视频参数 WebRecordVideoParams *WebRecordVideoParams `json:"WebRecordVideoParams,omitnil,omitempty" name:"WebRecordVideoParams"` // TRTC的SdkAppId SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 当对重复任务敏感时,请关注此值: 为了避免任务在短时间内重复发起,导致任务重复 // 传入录制RecordId来标识此次任务, 小于32字节,若携带RecordId发起两次以上的开始录制请求,任务只会启动一个,第二个报错FailedOperation.TaskExist。注意StartWebRecord调用失败时而非FailedOperation.TaskExist错误,请更换RecordId重新发起。 RecordId *string `json:"RecordId,omitnil,omitempty" name:"RecordId"` // 若您想要推流到CDN,可以使用PublishCdnParams.N参数设置,支持最多同时推流到10个CDN地址。若转推地址是腾讯云CDN时,请将IsTencentCdn明确设置为1 PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"` }
func NewStartWebRecordRequest ¶ added in v1.0.883
func NewStartWebRecordRequest() (request *StartWebRecordRequest)
func (*StartWebRecordRequest) FromJsonString ¶ added in v1.0.883
func (r *StartWebRecordRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StartWebRecordRequest) ToJsonString ¶ added in v1.0.883
func (r *StartWebRecordRequest) ToJsonString() string
type StartWebRecordRequestParams ¶ added in v1.0.883
type StartWebRecordRequestParams struct { // 需要录制的网页URL RecordUrl *string `json:"RecordUrl,omitnil,omitempty" name:"RecordUrl"` // 录制最大时长限制, 单位 s, 合法取值范围[1800, 36000], 默认 36000s(10 小时) MaxDurationLimit *uint64 `json:"MaxDurationLimit,omitnil,omitempty" name:"MaxDurationLimit"` // 云存储相关的参数,目前支持腾讯云对象存储以及腾讯云云点播VOD,不支持第三方云存储 StorageParams *StorageParams `json:"StorageParams,omitnil,omitempty" name:"StorageParams"` // 页面录制视频参数 WebRecordVideoParams *WebRecordVideoParams `json:"WebRecordVideoParams,omitnil,omitempty" name:"WebRecordVideoParams"` // TRTC的SdkAppId SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 当对重复任务敏感时,请关注此值: 为了避免任务在短时间内重复发起,导致任务重复 // 传入录制RecordId来标识此次任务, 小于32字节,若携带RecordId发起两次以上的开始录制请求,任务只会启动一个,第二个报错FailedOperation.TaskExist。注意StartWebRecord调用失败时而非FailedOperation.TaskExist错误,请更换RecordId重新发起。 RecordId *string `json:"RecordId,omitnil,omitempty" name:"RecordId"` // 若您想要推流到CDN,可以使用PublishCdnParams.N参数设置,支持最多同时推流到10个CDN地址。若转推地址是腾讯云CDN时,请将IsTencentCdn明确设置为1 PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"` }
Predefined struct for user
type StartWebRecordResponse ¶ added in v1.0.883
type StartWebRecordResponse struct { *tchttp.BaseResponse Response *StartWebRecordResponseParams `json:"Response"` }
func NewStartWebRecordResponse ¶ added in v1.0.883
func NewStartWebRecordResponse() (response *StartWebRecordResponse)
func (*StartWebRecordResponse) FromJsonString ¶ added in v1.0.883
func (r *StartWebRecordResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StartWebRecordResponse) ToJsonString ¶ added in v1.0.883
func (r *StartWebRecordResponse) ToJsonString() string
type StartWebRecordResponseParams ¶ added in v1.0.883
type StartWebRecordResponseParams struct { // 录制任务的唯一Id TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type StopAITranscriptionRequest ¶ added in v1.0.925
type StopAITranscriptionRequest struct { *tchttp.BaseRequest // 唯一标识转录任务。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` }
func NewStopAITranscriptionRequest ¶ added in v1.0.925
func NewStopAITranscriptionRequest() (request *StopAITranscriptionRequest)
func (*StopAITranscriptionRequest) FromJsonString ¶ added in v1.0.925
func (r *StopAITranscriptionRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StopAITranscriptionRequest) ToJsonString ¶ added in v1.0.925
func (r *StopAITranscriptionRequest) ToJsonString() string
type StopAITranscriptionRequestParams ¶ added in v1.0.925
type StopAITranscriptionRequestParams struct { // 唯一标识转录任务。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` }
Predefined struct for user
type StopAITranscriptionResponse ¶ added in v1.0.925
type StopAITranscriptionResponse struct { *tchttp.BaseResponse Response *StopAITranscriptionResponseParams `json:"Response"` }
func NewStopAITranscriptionResponse ¶ added in v1.0.925
func NewStopAITranscriptionResponse() (response *StopAITranscriptionResponse)
func (*StopAITranscriptionResponse) FromJsonString ¶ added in v1.0.925
func (r *StopAITranscriptionResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StopAITranscriptionResponse) ToJsonString ¶ added in v1.0.925
func (r *StopAITranscriptionResponse) ToJsonString() string
type StopAITranscriptionResponseParams ¶ added in v1.0.925
type StopAITranscriptionResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type StopMCUMixTranscodeByStrRoomIdRequest ¶
type StopMCUMixTranscodeByStrRoomIdRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 字符串房间号。 StrRoomId *string `json:"StrRoomId,omitnil,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 ¶
func (r *StopMCUMixTranscodeByStrRoomIdRequest) ToJsonString() string
type StopMCUMixTranscodeByStrRoomIdRequestParams ¶ added in v1.0.426
type StopMCUMixTranscodeByStrRoomIdRequestParams struct { // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 字符串房间号。 StrRoomId *string `json:"StrRoomId,omitnil,omitempty" name:"StrRoomId"` }
Predefined struct for user
type StopMCUMixTranscodeByStrRoomIdResponse ¶
type StopMCUMixTranscodeByStrRoomIdResponse struct { *tchttp.BaseResponse Response *StopMCUMixTranscodeByStrRoomIdResponseParams `json:"Response"` }
func NewStopMCUMixTranscodeByStrRoomIdResponse ¶
func NewStopMCUMixTranscodeByStrRoomIdResponse() (response *StopMCUMixTranscodeByStrRoomIdResponse)
func (*StopMCUMixTranscodeByStrRoomIdResponse) FromJsonString ¶
func (r *StopMCUMixTranscodeByStrRoomIdResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StopMCUMixTranscodeByStrRoomIdResponse) ToJsonString ¶
func (r *StopMCUMixTranscodeByStrRoomIdResponse) ToJsonString() string
type StopMCUMixTranscodeByStrRoomIdResponseParams ¶ added in v1.0.426
type StopMCUMixTranscodeByStrRoomIdResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type StopMCUMixTranscodeRequest ¶
type StopMCUMixTranscodeRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 房间号。 RoomId *uint64 `json:"RoomId,omitnil,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 StopMCUMixTranscodeRequestParams ¶ added in v1.0.426
type StopMCUMixTranscodeRequestParams struct { // TRTC的SDKAppId。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 房间号。 RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"` }
Predefined struct for user
type StopMCUMixTranscodeResponse ¶
type StopMCUMixTranscodeResponse struct { *tchttp.BaseResponse Response *StopMCUMixTranscodeResponseParams `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 StopMCUMixTranscodeResponseParams ¶ added in v1.0.426
type StopMCUMixTranscodeResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type StopPublishCdnStreamRequest ¶ added in v1.0.515
type StopPublishCdnStreamRequest struct { *tchttp.BaseRequest // TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 唯一标识转推任务。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` }
func NewStopPublishCdnStreamRequest ¶ added in v1.0.515
func NewStopPublishCdnStreamRequest() (request *StopPublishCdnStreamRequest)
func (*StopPublishCdnStreamRequest) FromJsonString ¶ added in v1.0.515
func (r *StopPublishCdnStreamRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StopPublishCdnStreamRequest) ToJsonString ¶ added in v1.0.515
func (r *StopPublishCdnStreamRequest) ToJsonString() string
type StopPublishCdnStreamRequestParams ¶ added in v1.0.515
type StopPublishCdnStreamRequestParams struct { // TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 唯一标识转推任务。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` }
Predefined struct for user
type StopPublishCdnStreamResponse ¶ added in v1.0.515
type StopPublishCdnStreamResponse struct { *tchttp.BaseResponse Response *StopPublishCdnStreamResponseParams `json:"Response"` }
func NewStopPublishCdnStreamResponse ¶ added in v1.0.515
func NewStopPublishCdnStreamResponse() (response *StopPublishCdnStreamResponse)
func (*StopPublishCdnStreamResponse) FromJsonString ¶ added in v1.0.515
func (r *StopPublishCdnStreamResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StopPublishCdnStreamResponse) ToJsonString ¶ added in v1.0.515
func (r *StopPublishCdnStreamResponse) ToJsonString() string
type StopPublishCdnStreamResponseParams ¶ added in v1.0.515
type StopPublishCdnStreamResponseParams struct { // 转推任务唯一的String Id TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type StopStreamIngestRequest ¶ added in v1.0.803
type StopStreamIngestRequest struct { *tchttp.BaseRequest // TRTC的SDKAppId,和任务的房间所对应的SDKAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 任务的唯一Id,在启动任务成功后会返回。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` }
func NewStopStreamIngestRequest ¶ added in v1.0.803
func NewStopStreamIngestRequest() (request *StopStreamIngestRequest)
func (*StopStreamIngestRequest) FromJsonString ¶ added in v1.0.803
func (r *StopStreamIngestRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StopStreamIngestRequest) ToJsonString ¶ added in v1.0.803
func (r *StopStreamIngestRequest) ToJsonString() string
type StopStreamIngestRequestParams ¶ added in v1.0.803
type StopStreamIngestRequestParams struct { // TRTC的SDKAppId,和任务的房间所对应的SDKAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 任务的唯一Id,在启动任务成功后会返回。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` }
Predefined struct for user
type StopStreamIngestResponse ¶ added in v1.0.803
type StopStreamIngestResponse struct { *tchttp.BaseResponse Response *StopStreamIngestResponseParams `json:"Response"` }
func NewStopStreamIngestResponse ¶ added in v1.0.803
func NewStopStreamIngestResponse() (response *StopStreamIngestResponse)
func (*StopStreamIngestResponse) FromJsonString ¶ added in v1.0.803
func (r *StopStreamIngestResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StopStreamIngestResponse) ToJsonString ¶ added in v1.0.803
func (r *StopStreamIngestResponse) ToJsonString() string
type StopStreamIngestResponseParams ¶ added in v1.0.803
type StopStreamIngestResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type StopWebRecordRequest ¶ added in v1.0.883
type StopWebRecordRequest struct { *tchttp.BaseRequest // 需要停止的任务Id TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` }
func NewStopWebRecordRequest ¶ added in v1.0.883
func NewStopWebRecordRequest() (request *StopWebRecordRequest)
func (*StopWebRecordRequest) FromJsonString ¶ added in v1.0.883
func (r *StopWebRecordRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StopWebRecordRequest) ToJsonString ¶ added in v1.0.883
func (r *StopWebRecordRequest) ToJsonString() string
type StopWebRecordRequestParams ¶ added in v1.0.883
type StopWebRecordRequestParams struct { // 需要停止的任务Id TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` }
Predefined struct for user
type StopWebRecordResponse ¶ added in v1.0.883
type StopWebRecordResponse struct { *tchttp.BaseResponse Response *StopWebRecordResponseParams `json:"Response"` }
func NewStopWebRecordResponse ¶ added in v1.0.883
func NewStopWebRecordResponse() (response *StopWebRecordResponse)
func (*StopWebRecordResponse) FromJsonString ¶ added in v1.0.883
func (r *StopWebRecordResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*StopWebRecordResponse) ToJsonString ¶ added in v1.0.883
func (r *StopWebRecordResponse) ToJsonString() string
type StopWebRecordResponseParams ¶ added in v1.0.883
type StopWebRecordResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type StorageFile ¶ added in v1.0.400
type StorageFile struct { // 录制文件对应的UserId,如果是混流的话的这里返回的是空串。 // 注意:此字段可能返回 null,表示取不到有效值。 UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 录制索引文件名。 FileName *string `json:"FileName,omitnil,omitempty" name:"FileName"` // 录制文件流信息。 // video:视频录制文件 // audio:音频录制文件 // audio_video:音视频录制文件 // 注意:此字段可能返回 null,表示取不到有效值。 TrackType *string `json:"TrackType,omitnil,omitempty" name:"TrackType"` // 录制文件开始Unix时间戳。 BeginTimeStamp *uint64 `json:"BeginTimeStamp,omitnil,omitempty" name:"BeginTimeStamp"` }
type StorageParams ¶ added in v1.0.400
type StorageParams struct { // 腾讯云对象存储COS以及第三方云存储的账号信息 CloudStorage *CloudStorage `json:"CloudStorage,omitnil,omitempty" name:"CloudStorage"` // 腾讯云云点播Vod的存储信息 CloudVod *CloudVod `json:"CloudVod,omitnil,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,omitnil,omitempty" name:"SubscribeAudioUserIds"` // 订阅音频流黑名单,指定不订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的音频流;["1.*$"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流,订阅列表用户数不超过32。 UnSubscribeAudioUserIds []*string `json:"UnSubscribeAudioUserIds,omitnil,omitempty" name:"UnSubscribeAudioUserIds"` // 订阅视频流白名单,指定订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的视频流;["1.*$"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。 SubscribeVideoUserIds []*string `json:"SubscribeVideoUserIds,omitnil,omitempty" name:"SubscribeVideoUserIds"` // 订阅视频流黑名单,指定不订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的视频流;["1.*$"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。 UnSubscribeVideoUserIds []*string `json:"UnSubscribeVideoUserIds,omitnil,omitempty" name:"UnSubscribeVideoUserIds"` }
type SummarizeTranscriptionRequest ¶ added in v1.0.925
type SummarizeTranscriptionRequest struct {
*tchttp.BaseRequest
}
func NewSummarizeTranscriptionRequest ¶ added in v1.0.925
func NewSummarizeTranscriptionRequest() (request *SummarizeTranscriptionRequest)
func (*SummarizeTranscriptionRequest) FromJsonString ¶ added in v1.0.925
func (r *SummarizeTranscriptionRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SummarizeTranscriptionRequest) ToJsonString ¶ added in v1.0.925
func (r *SummarizeTranscriptionRequest) ToJsonString() string
type SummarizeTranscriptionRequestParams ¶ added in v1.0.925
type SummarizeTranscriptionRequestParams struct { }
Predefined struct for user
type SummarizeTranscriptionResponse ¶ added in v1.0.925
type SummarizeTranscriptionResponse struct { *tchttp.BaseResponse Response *SummarizeTranscriptionResponseParams `json:"Response"` }
func NewSummarizeTranscriptionResponse ¶ added in v1.0.925
func NewSummarizeTranscriptionResponse() (response *SummarizeTranscriptionResponse)
func (*SummarizeTranscriptionResponse) FromJsonString ¶ added in v1.0.925
func (r *SummarizeTranscriptionResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SummarizeTranscriptionResponse) ToJsonString ¶ added in v1.0.925
func (r *SummarizeTranscriptionResponse) ToJsonString() string
type SummarizeTranscriptionResponseParams ¶ added in v1.0.925
type SummarizeTranscriptionResponseParams struct { // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type TRTCDataResp ¶ added in v1.0.530
type TRTCDataResp struct { // StatementID值,监控仪表盘下固定为0。 // 注意:此字段可能返回 null,表示取不到有效值。 StatementID *int64 `json:"StatementID,omitnil,omitempty" name:"StatementID"` // 查询结果数据,以Columns-Values形式返回。 // 注意:此字段可能返回 null,表示取不到有效值。 Series []*SeriesInfo `json:"Series,omitnil,omitempty" name:"Series"` // Total值,监控仪表盘功能下固定为1。 // 注意:此字段可能返回 null,表示取不到有效值。 Total *int64 `json:"Total,omitnil,omitempty" name:"Total"` }
type TRTCDataResult ¶ added in v1.0.732
type TRTCDataResult struct { // StatementID值,监控仪表盘下固定为0。 // 注意:此字段可能返回 null,表示取不到有效值。 StatementID *int64 `json:"StatementID,omitnil,omitempty" name:"StatementID"` // 查询结果数据,以Columns-Values形式返回。 // 注意:此字段可能返回 null,表示取不到有效值。 Series []*SeriesInfos `json:"Series,omitnil,omitempty" name:"Series"` // Total值,监控仪表盘功能下固定为1。 // 注意:此字段可能返回 null,表示取不到有效值。 Total *int64 `json:"Total,omitnil,omitempty" name:"Total"` }
type TencentVod ¶ added in v1.0.400
type TencentVod struct { // 媒体后续任务处理操作,即完成媒体上传后,可自动发起任务流操作。参数值为任务流模板名,云点播支持 创建任务流模板 并为模板命名。 Procedure *string `json:"Procedure,omitnil,omitempty" name:"Procedure"` // 媒体文件过期时间,为当前时间的绝对过期时间;保存一天,就填"86400",永久保存就填"0",默认永久保存。 ExpireTime *uint64 `json:"ExpireTime,omitnil,omitempty" name:"ExpireTime"` // 指定上传园区,仅适用于对上传地域有特殊需求的用户。 StorageRegion *string `json:"StorageRegion,omitnil,omitempty" name:"StorageRegion"` // 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。 // 默认值:0,表示其他分类。 ClassId *uint64 `json:"ClassId,omitnil,omitempty" name:"ClassId"` // 点播 子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。 SubAppId *uint64 `json:"SubAppId,omitnil,omitempty" name:"SubAppId"` // 任务流上下文,任务完成回调时透传。 SessionContext *string `json:"SessionContext,omitnil,omitempty" name:"SessionContext"` // 上传上下文,上传完成回调时透传。 SourceContext *string `json:"SourceContext,omitnil,omitempty" name:"SourceContext"` // 上传到vod平台的录制文件格式类型,0:mp4(默认), 1: hls, 2:aac(StreamType=1纯音频录制时有效), // 3: hls+mp4, 4: hls+aac(StreamType=1纯音频录制时有效)。 MediaType *uint64 `json:"MediaType,omitnil,omitempty" name:"MediaType"` // 仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用`__UserDefine_u_` 分开。 UserDefineRecordId *string `json:"UserDefineRecordId,omitnil,omitempty" name:"UserDefineRecordId"` }
type TranscriptionParams ¶ added in v1.0.925
type TranscriptionParams struct { // 转录机器人的UserId,用于进房发起转录任务。【注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个转录任务时,机器人的userid也不能相互重复,否则会中断前一个任务。需要保证转录机器人UserId在房间内唯一。 UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 转录机器人UserId对应的校验签名,即UserId和UserSig相当于转录机器人进房的登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。 UserSig *string `json:"UserSig,omitnil,omitempty" name:"UserSig"` // IM[管理员账户]( // https://cloud.tencent.com/document/product/269/31999#app-.E7.AE.A1.E7.90.86.E5.91.98),如果填写,后台下发消息会使用IM通道,而不是TRTC自定义消息。 IMAdminUserId *string `json:"IMAdminUserId,omitnil,omitempty" name:"IMAdminUserId"` // IM管理员账户生成的签名,用于向特定群组发送消息。如果填写,后台下发消息会使用IM通道,而不是TRTC自定义消息。必须和IM管理员的UserId一起填写。 IMAdminUserSig *string `json:"IMAdminUserSig,omitnil,omitempty" name:"IMAdminUserSig"` // 房间内推流用户全部退出后超过MaxIdleTime秒,后台自动关闭转录任务,默认值是60s。 MaxIdleTime *uint64 `json:"MaxIdleTime,omitnil,omitempty" name:"MaxIdleTime"` // 1表示机器人只订阅单个人的流,0表示机器人订阅整个房间的流,如果不填默认订阅整个房间的流。 TranscriptionMode *uint64 `json:"TranscriptionMode,omitnil,omitempty" name:"TranscriptionMode"` // TranscriptionMode为1时必填,机器人只会拉该userid的流,忽略房间里其他用户。 TargetUserId *string `json:"TargetUserId,omitnil,omitempty" name:"TargetUserId"` }
type UpdatePublishCdnStreamRequest ¶ added in v1.0.515
type UpdatePublishCdnStreamRequest struct { *tchttp.BaseRequest // TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 唯一标识转推任务。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 客户保证同一个任务,每次更新请求中的SequenceNumber递增,防止请求乱序。 SequenceNumber *uint64 `json:"SequenceNumber,omitnil,omitempty" name:"SequenceNumber"` // 是否转码,0表示无需转码,1表示需要转码。 WithTranscoding *uint64 `json:"WithTranscoding,omitnil,omitempty" name:"WithTranscoding"` // 更新相关参数,只支持更新参与混音的主播列表参数。不填表示不更新此参数。 AudioParams *McuAudioParams `json:"AudioParams,omitnil,omitempty" name:"AudioParams"` // 更新视频相关参数,转码时支持更新除编码类型之外的编码参数,视频布局参数,背景图片和背景颜色参数,水印参数。不填表示不更新此参数。 VideoParams *McuVideoParams `json:"VideoParams,omitnil,omitempty" name:"VideoParams"` // 更新单流转推的用户上行参数,仅在非转码时有效。不填表示不更新此参数。 SingleSubscribeParams *SingleSubscribeParams `json:"SingleSubscribeParams,omitnil,omitempty" name:"SingleSubscribeParams"` // 更新转推的CDN参数。不填表示不更新此参数。 PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"` // 混流SEI参数 SeiParams *McuSeiParams `json:"SeiParams,omitnil,omitempty" name:"SeiParams"` // 回推房间信息 FeedBackRoomParams []*McuFeedBackRoomParams `json:"FeedBackRoomParams,omitnil,omitempty" name:"FeedBackRoomParams"` }
func NewUpdatePublishCdnStreamRequest ¶ added in v1.0.515
func NewUpdatePublishCdnStreamRequest() (request *UpdatePublishCdnStreamRequest)
func (*UpdatePublishCdnStreamRequest) FromJsonString ¶ added in v1.0.515
func (r *UpdatePublishCdnStreamRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdatePublishCdnStreamRequest) ToJsonString ¶ added in v1.0.515
func (r *UpdatePublishCdnStreamRequest) ToJsonString() string
type UpdatePublishCdnStreamRequestParams ¶ added in v1.0.515
type UpdatePublishCdnStreamRequestParams struct { // TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。 SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"` // 唯一标识转推任务。 TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 客户保证同一个任务,每次更新请求中的SequenceNumber递增,防止请求乱序。 SequenceNumber *uint64 `json:"SequenceNumber,omitnil,omitempty" name:"SequenceNumber"` // 是否转码,0表示无需转码,1表示需要转码。 WithTranscoding *uint64 `json:"WithTranscoding,omitnil,omitempty" name:"WithTranscoding"` // 更新相关参数,只支持更新参与混音的主播列表参数。不填表示不更新此参数。 AudioParams *McuAudioParams `json:"AudioParams,omitnil,omitempty" name:"AudioParams"` // 更新视频相关参数,转码时支持更新除编码类型之外的编码参数,视频布局参数,背景图片和背景颜色参数,水印参数。不填表示不更新此参数。 VideoParams *McuVideoParams `json:"VideoParams,omitnil,omitempty" name:"VideoParams"` // 更新单流转推的用户上行参数,仅在非转码时有效。不填表示不更新此参数。 SingleSubscribeParams *SingleSubscribeParams `json:"SingleSubscribeParams,omitnil,omitempty" name:"SingleSubscribeParams"` // 更新转推的CDN参数。不填表示不更新此参数。 PublishCdnParams []*McuPublishCdnParam `json:"PublishCdnParams,omitnil,omitempty" name:"PublishCdnParams"` // 混流SEI参数 SeiParams *McuSeiParams `json:"SeiParams,omitnil,omitempty" name:"SeiParams"` // 回推房间信息 FeedBackRoomParams []*McuFeedBackRoomParams `json:"FeedBackRoomParams,omitnil,omitempty" name:"FeedBackRoomParams"` }
Predefined struct for user
type UpdatePublishCdnStreamResponse ¶ added in v1.0.515
type UpdatePublishCdnStreamResponse struct { *tchttp.BaseResponse Response *UpdatePublishCdnStreamResponseParams `json:"Response"` }
func NewUpdatePublishCdnStreamResponse ¶ added in v1.0.515
func NewUpdatePublishCdnStreamResponse() (response *UpdatePublishCdnStreamResponse)
func (*UpdatePublishCdnStreamResponse) FromJsonString ¶ added in v1.0.515
func (r *UpdatePublishCdnStreamResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdatePublishCdnStreamResponse) ToJsonString ¶ added in v1.0.515
func (r *UpdatePublishCdnStreamResponse) ToJsonString() string
type UpdatePublishCdnStreamResponseParams ¶ added in v1.0.515
type UpdatePublishCdnStreamResponseParams struct { // 转推任务唯一的String Id TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"` // 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type UserInformation ¶
type UserInformation struct { // 房间号 RoomStr *string `json:"RoomStr,omitnil,omitempty" name:"RoomStr"` // 用户Id UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"` // 用户进房时间 JoinTs *uint64 `json:"JoinTs,omitnil,omitempty" name:"JoinTs"` // 用户退房时间,用户没有退房则返回当前时间 LeaveTs *uint64 `json:"LeaveTs,omitnil,omitempty" name:"LeaveTs"` // 终端类型 DeviceType *string `json:"DeviceType,omitnil,omitempty" name:"DeviceType"` // Sdk版本号 SdkVersion *string `json:"SdkVersion,omitnil,omitempty" name:"SdkVersion"` // 客户端IP地址 ClientIp *string `json:"ClientIp,omitnil,omitempty" name:"ClientIp"` // 判断用户是否已经离开房间 Finished *bool `json:"Finished,omitnil,omitempty" name:"Finished"` }
type UserMediaStream ¶ added in v1.0.515
type UserMediaStream struct { // TRTC用户参数。 UserInfo *MixUserInfo `json:"UserInfo,omitnil,omitempty" name:"UserInfo"` // 主辅路流类型,0为摄像头,1为屏幕分享,不填默认为0。 StreamType *uint64 `json:"StreamType,omitnil,omitempty" name:"StreamType"` }
type VideoEncode ¶ added in v1.0.515
type VideoEncode struct { // 输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` // 输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。 Fps *uint64 `json:"Fps,omitnil,omitempty" name:"Fps"` // 输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。 BitRate *uint64 `json:"BitRate,omitnil,omitempty" name:"BitRate"` // 输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。 Gop *uint64 `json:"Gop,omitnil,omitempty" name:"Gop"` }
type VideoEncodeParams ¶ added in v1.0.803
type VideoEncodeParams struct { // 宽。取值范围[0,1920],单位为像素值。 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 高。取值范围[0,1080],单位为像素值。 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` // 帧率。取值范围[1,60],表示帧率可选范围为1到60fps。 Fps *uint64 `json:"Fps,omitnil,omitempty" name:"Fps"` // 码率。取值范围[1,10000],单位为kbps。 BitRate *uint64 `json:"BitRate,omitnil,omitempty" name:"BitRate"` // gop。取值范围[1,2],单位为秒。 Gop *uint64 `json:"Gop,omitnil,omitempty" name:"Gop"` }
type VideoParams ¶ added in v1.0.400
type VideoParams struct { // 视频的宽度值,单位为像素,默认值360。不能超过1920,与height的乘积不能超过1920*1080。 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 视频的高度值,单位为像素,默认值640。不能超过1920,与width的乘积不能超过1920*1080。 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` // 视频的帧率,范围[1, 60],默认15。 Fps *uint64 `json:"Fps,omitnil,omitempty" name:"Fps"` // 视频的码率,单位是bps,范围[64000, 8192000],默认550000bps。 BitRate *uint64 `json:"BitRate,omitnil,omitempty" name:"BitRate"` // 视频关键帧时间间隔,单位秒,默认值10秒。 Gop *uint64 `json:"Gop,omitnil,omitempty" name:"Gop"` }
type WaterMark ¶ added in v1.0.400
type WaterMark struct { // 水印类型,0为图片(默认),1为文字,2为时间戳。 WaterMarkType *uint64 `json:"WaterMarkType,omitnil,omitempty" name:"WaterMarkType"` // 水印为图片时的参数列表,水印为图片时校验必填。 WaterMarkImage *WaterMarkImage `json:"WaterMarkImage,omitnil,omitempty" name:"WaterMarkImage"` // 水印为文字时的参数列表,水印为文字时校验必填。 WaterMarkChar *WaterMarkChar `json:"WaterMarkChar,omitnil,omitempty" name:"WaterMarkChar"` // 水印为时间戳时的参数列表,水印为时间戳时校验必填。 WaterMarkTimestamp *WaterMarkTimestamp `json:"WaterMarkTimestamp,omitnil,omitempty" name:"WaterMarkTimestamp"` }
type WaterMarkChar ¶ added in v1.0.617
type WaterMarkChar struct { // 文字水印的起始坐标Y值,从左上角开始 Top *uint64 `json:"Top,omitnil,omitempty" name:"Top"` // 文字水印的起始坐标X值,从左上角开始 Left *uint64 `json:"Left,omitnil,omitempty" name:"Left"` // 文字水印的宽度,单位像素值 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 文字水印的高度,单位像素值 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` // 水印文字的内容 Chars *string `json:"Chars,omitnil,omitempty" name:"Chars"` // 水印文字的大小,单位像素,默认14 FontSize *uint64 `json:"FontSize,omitnil,omitempty" name:"FontSize"` // 水印文字的颜色,默认白色 FontColor *string `json:"FontColor,omitnil,omitempty" name:"FontColor"` // 水印文字的背景色,为空代表背景透明,默认为空 BackGroundColor *string `json:"BackGroundColor,omitnil,omitempty" name:"BackGroundColor"` // 文字水印的字体,支持设置以下值: // 1. Tencent (默认) // 2. SourceHanSans Font *string `json:"Font,omitnil,omitempty" name:"Font"` }
type WaterMarkImage ¶ added in v1.0.400
type WaterMarkImage struct { // 下载的url地址, 只支持jpg, png,大小限制不超过5M。 WaterMarkUrl *string `json:"WaterMarkUrl,omitnil,omitempty" name:"WaterMarkUrl"` // 画布上该画面左上角的 y 轴坐标,取值范围 [0, 2560],不能超过画布的高。 Top *uint64 `json:"Top,omitnil,omitempty" name:"Top"` // 画布上该画面左上角的 x 轴坐标,取值范围 [0, 2560],不能超过画布的宽。 Left *uint64 `json:"Left,omitnil,omitempty" name:"Left"` // 画布上该画面宽度的相对值,取值范围 [0, 2560],与Left相加不应超过画布的宽。 Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 画布上该画面高度的相对值,取值范围 [0, 2560],与Top相加不应超过画布的高。 Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` }
type WaterMarkParams ¶
type WaterMarkParams struct { // 混流-水印图片ID。取值为实时音视频控制台上传的图片ID。 WaterMarkId *uint64 `json:"WaterMarkId,omitnil,omitempty" name:"WaterMarkId"` // 混流-水印宽。单位为像素值。水印宽+X偏移不能超过整个画布宽。 WaterMarkWidth *uint64 `json:"WaterMarkWidth,omitnil,omitempty" name:"WaterMarkWidth"` // 混流-水印高。单位为像素值。水印高+Y偏移不能超过整个画布高。 WaterMarkHeight *uint64 `json:"WaterMarkHeight,omitnil,omitempty" name:"WaterMarkHeight"` // 水印在输出时的X偏移。单位为像素值。水印宽+X偏移不能超过整个画布宽。 LocationX *uint64 `json:"LocationX,omitnil,omitempty" name:"LocationX"` // 水印在输出时的Y偏移。单位为像素值。水印高+Y偏移不能超过整个画布高。 LocationY *uint64 `json:"LocationY,omitnil,omitempty" name:"LocationY"` // 混流-水印图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。WaterMarkUrl和WaterMarkId参数都填时,以WaterMarkUrl为准。图片大小限制不超过2MB。 WaterMarkUrl *string `json:"WaterMarkUrl,omitnil,omitempty" name:"WaterMarkUrl"` }
type WaterMarkTimestamp ¶ added in v1.0.617
type WaterMarkTimestamp struct { // 时间戳的位置,取值范围0-6,分别代表上左,上右,下左,下右,上居中,下居中,居中 Pos *uint64 `json:"Pos,omitnil,omitempty" name:"Pos"` // 显示时间戳的时区,默认东八区 TimeZone *uint64 `json:"TimeZone,omitnil,omitempty" name:"TimeZone"` // 文字水印的字体,支持设置以下值: // 1. Tencent (默认) // 2. SourceHanSans Font *string `json:"Font,omitnil,omitempty" name:"Font"` }
type WebRecordVideoParams ¶ added in v1.0.883
type WebRecordVideoParams struct { // 录制画面宽度,默认为1280,取值范围[0, 1920] Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"` // 录制画面高度,默认为720,取值范围[0, 1080] Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"` // 指定输出格式,可选hls,mp4 Format *string `json:"Format,omitnil,omitempty" name:"Format"` // 如果是aac或者mp4文件格式,超过长度限制后,系统会自动拆分视频文件。单位:分钟。默认为1440min(24h),取值范围为1-1440。【单文件限制最大为2G,满足文件大小 >2G 或录制时长度 > 24h任意一个条件,文件都会自动切分】 // Hls 格式录制此参数不生效。 // 示例值:1440 MaxMediaFileDuration *int64 `json:"MaxMediaFileDuration,omitnil,omitempty" name:"MaxMediaFileDuration"` }