Documentation
¶
Index ¶
- Constants
- type AbnormalEvent
- type AbnormalExperience
- type Client
- func (c *Client) CreateTroubleInfo(request *CreateTroubleInfoRequest) (response *CreateTroubleInfoResponse, err error)
- func (c *Client) DescribeAbnormalEvent(request *DescribeAbnormalEventRequest) (response *DescribeAbnormalEventResponse, err error)
- func (c *Client) DescribeCallDetail(request *DescribeCallDetailRequest) (response *DescribeCallDetailResponse, err error)
- func (c *Client) DescribeDetailEvent(request *DescribeDetailEventRequest) (response *DescribeDetailEventResponse, err error)
- func (c *Client) DescribeHistoryScale(request *DescribeHistoryScaleRequest) (response *DescribeHistoryScaleResponse, err error)
- func (c *Client) DescribeRealtimeNetwork(request *DescribeRealtimeNetworkRequest) (response *DescribeRealtimeNetworkResponse, err error)
- func (c *Client) DescribeRealtimeQuality(request *DescribeRealtimeQualityRequest) (response *DescribeRealtimeQualityResponse, err error)
- func (c *Client) DescribeRealtimeScale(request *DescribeRealtimeScaleRequest) (response *DescribeRealtimeScaleResponse, err error)
- func (c *Client) DescribeRoomInformation(request *DescribeRoomInformationRequest) (response *DescribeRoomInformationResponse, err error)
- func (c *Client) DismissRoom(request *DismissRoomRequest) (response *DismissRoomResponse, err error)
- func (c *Client) RemoveUser(request *RemoveUserRequest) (response *RemoveUserResponse, err error)
- func (c *Client) StartMCUMixTranscode(request *StartMCUMixTranscodeRequest) (response *StartMCUMixTranscodeResponse, err error)
- func (c *Client) StopMCUMixTranscode(request *StopMCUMixTranscodeRequest) (response *StopMCUMixTranscodeResponse, err error)
- type CreateTroubleInfoRequest
- type CreateTroubleInfoResponse
- type DescribeAbnormalEventRequest
- type DescribeAbnormalEventResponse
- type DescribeCallDetailRequest
- type DescribeCallDetailResponse
- type DescribeDetailEventRequest
- type DescribeDetailEventResponse
- type DescribeHistoryScaleRequest
- type DescribeHistoryScaleResponse
- type DescribeRealtimeNetworkRequest
- type DescribeRealtimeNetworkResponse
- type DescribeRealtimeQualityRequest
- type DescribeRealtimeQualityResponse
- type DescribeRealtimeScaleRequest
- type DescribeRealtimeScaleResponse
- type DescribeRoomInformationRequest
- type DescribeRoomInformationResponse
- type DismissRoomRequest
- type DismissRoomResponse
- type EncodeParams
- type EventList
- type EventMessage
- type LayoutParams
- type OutputParams
- type QualityData
- type RealtimeData
- type RemoveUserRequest
- type RemoveUserResponse
- type RoomState
- type ScaleInfomation
- type StartMCUMixTranscodeRequest
- type StartMCUMixTranscodeResponse
- type StopMCUMixTranscodeRequest
- type StopMCUMixTranscodeResponse
- type TimeValue
- type UserInformation
Constants ¶
const APIVersion = "2019-07-22"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AbnormalEvent ¶
type AbnormalEvent struct {
// 异常事件ID,具体值查看附录:异常体验ID映射表:https://cloud.tencent.com/document/product/647/44916
AbnormalEventId *uint64 `json:"AbnormalEventId,omitempty" name:"AbnormalEventId"`
// 远端用户ID,"":表示异常事件不是由远端用户产生
// 注意:此字段可能返回 null,表示取不到有效值。
PeerId *string `json:"PeerId,omitempty" name:"PeerId"`
}
type AbnormalExperience ¶
type AbnormalExperience struct {
// 用户ID
UserId *string `json:"UserId,omitempty" name:"UserId"`
// 异常体验ID
ExperienceId *uint64 `json:"ExperienceId,omitempty" name:"ExperienceId"`
// 字符串房间号
RoomId *string `json:"RoomId,omitempty" name:"RoomId"`
// 异常事件数组
AbnormalEventList []*AbnormalEvent `json:"AbnormalEventList,omitempty" name:"AbnormalEventList" list`
// 异常事件的上报时间
EventTime *uint64 `json:"EventTime,omitempty" name:"EventTime"`
}
type Client ¶
func NewClient ¶
func NewClient(credential *common.Credential, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) CreateTroubleInfo ¶
func (c *Client) CreateTroubleInfo(request *CreateTroubleInfoRequest) (response *CreateTroubleInfoResponse, err error)
创建异常信息
func (*Client) DescribeAbnormalEvent ¶
func (c *Client) DescribeAbnormalEvent(request *DescribeAbnormalEventRequest) (response *DescribeAbnormalEventResponse, err error)
查询SDKAppID下用户的异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询24小时内数据,查询起止时间不超过1个小时。支持跨天查询。异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916
func (*Client) DescribeCallDetail ¶
func (c *Client) DescribeCallDetail(request *DescribeCallDetailRequest) (response *DescribeCallDetailResponse, err error)
查询指定时间内的用户列表及用户通话质量数据。可查询5天内数据,查询起止时间不超过1个小时,查询用户不超过6个,不支持跨天查询。
func (*Client) DescribeDetailEvent ¶
func (c *Client) DescribeDetailEvent(request *DescribeDetailEventRequest) (response *DescribeDetailEventResponse, err error)
查询用户某次通话内的进退房,视频开关等详细事件。可查询5天内数据。
func (*Client) DescribeHistoryScale ¶
func (c *Client) DescribeHistoryScale(request *DescribeHistoryScaleRequest) (response *DescribeHistoryScaleResponse, err error)
可查询sdkqppid 每天的房间数和用户数,每分钟1次,可查询最近5天的数据。当天未结束,无法查到当天的房间数与用户数。
func (*Client) DescribeRealtimeNetwork ¶
func (c *Client) DescribeRealtimeNetwork(request *DescribeRealtimeNetworkRequest) (response *DescribeRealtimeNetworkResponse, err error)
查询sdkappid维度下实时网络状态,包括上行丢包与下行丢包。可查询24小时内数据,查询起止时间不超过1个小时。
func (*Client) DescribeRealtimeQuality ¶
func (c *Client) DescribeRealtimeQuality(request *DescribeRealtimeQualityRequest) (response *DescribeRealtimeQualityResponse, err error)
查询sdkappid维度下实时质量数据,包括:进房成功率,首帧秒开率,音频卡顿率,视频卡顿率。可查询24小时内数据,查询起止时间不超过1个小时。
func (*Client) DescribeRealtimeScale ¶
func (c *Client) DescribeRealtimeScale(request *DescribeRealtimeScaleRequest) (response *DescribeRealtimeScaleResponse, err error)
查询sdkappid维度下实时规模,可查询24小时内数据,查询起止时间不超过1个小时。
func (*Client) DescribeRoomInformation ¶
func (c *Client) DescribeRoomInformation(request *DescribeRoomInformationRequest) (response *DescribeRoomInformationResponse, err error)
查询sdkappid下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询5天内的数据。
func (*Client) DismissRoom ¶
func (c *Client) DismissRoom(request *DismissRoomRequest) (response *DismissRoomResponse, err error)
接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
func (*Client) RemoveUser ¶
func (c *Client) RemoveUser(request *RemoveUserRequest) (response *RemoveUserResponse, err error)
接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
func (*Client) StartMCUMixTranscode ¶
func (c *Client) StartMCUMixTranscode(request *StartMCUMixTranscodeRequest) (response *StartMCUMixTranscodeResponse, err error)
接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
您可以通过此接口实现如下目标: - 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。 - 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。 - 设置录制文件名,用于二次回放。 - 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。
目前已经支持了如下几种布局模板: - 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。 - 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。 - 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
func (*Client) StopMCUMixTranscode ¶
func (c *Client) StopMCUMixTranscode(request *StopMCUMixTranscodeRequest) (response *StopMCUMixTranscodeResponse, err error)
接口说明:结束云端混流
type CreateTroubleInfoRequest ¶
type CreateTroubleInfoRequest struct {
*tchttp.BaseRequest
// 应用的ID
SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`
// 房间ID
RoomId *string `json:"RoomId,omitempty" name:"RoomId"`
// 老师用户ID
TeacherUserId *string `json:"TeacherUserId,omitempty" name:"TeacherUserId"`
// 学生用户ID
StudentUserId *string `json:"StudentUserId,omitempty" name:"StudentUserId"`
// 体验异常端(老师或学生)的用户 ID。
TroubleUserId *string `json:"TroubleUserId,omitempty" name:"TroubleUserId"`
// 异常类型。
// 1. 仅视频异常
// 2. 仅声音异常
// 3. 音视频都异常
// 5. 进房异常
// 4. 切课
// 6. 求助
// 7. 问题反馈
// 8. 投诉
TroubleType *uint64 `json:"TroubleType,omitempty" name:"TroubleType"`
// 异常发生的UNIX 时间戳,单位为秒。
TroubleTime *uint64 `json:"TroubleTime,omitempty" name:"TroubleTime"`
// 异常详情
TroubleMsg *string `json:"TroubleMsg,omitempty" name:"TroubleMsg"`
}
func NewCreateTroubleInfoRequest ¶
func NewCreateTroubleInfoRequest() (request *CreateTroubleInfoRequest)
func (*CreateTroubleInfoRequest) FromJsonString ¶
func (r *CreateTroubleInfoRequest) FromJsonString(s string) error
func (*CreateTroubleInfoRequest) ToJsonString ¶
func (r *CreateTroubleInfoRequest) ToJsonString() string
type CreateTroubleInfoResponse ¶
type CreateTroubleInfoResponse struct {
*tchttp.BaseResponse
Response *struct {
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewCreateTroubleInfoResponse ¶
func NewCreateTroubleInfoResponse() (response *CreateTroubleInfoResponse)
func (*CreateTroubleInfoResponse) FromJsonString ¶
func (r *CreateTroubleInfoResponse) FromJsonString(s string) error
func (*CreateTroubleInfoResponse) ToJsonString ¶
func (r *CreateTroubleInfoResponse) ToJsonString() string
type DescribeAbnormalEventRequest ¶
type DescribeAbnormalEventRequest struct {
*tchttp.BaseRequest
// 用户SDKAppID,查询SDKAppID下任意20条异常体验事件(可能不同房间)
SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`
// 查询开始时间
StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`
// 查询结束时间
EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
// 房间号,查询房间内任意20条以内异常体验事件
RoomId *string `json:"RoomId,omitempty" name:"RoomId"`
}
func NewDescribeAbnormalEventRequest ¶
func NewDescribeAbnormalEventRequest() (request *DescribeAbnormalEventRequest)
func (*DescribeAbnormalEventRequest) FromJsonString ¶
func (r *DescribeAbnormalEventRequest) FromJsonString(s string) error
func (*DescribeAbnormalEventRequest) ToJsonString ¶
func (r *DescribeAbnormalEventRequest) ToJsonString() string
type DescribeAbnormalEventResponse ¶
type DescribeAbnormalEventResponse struct {
*tchttp.BaseResponse
Response *struct {
// 返回的数据总条数
Total *uint64 `json:"Total,omitempty" name:"Total"`
// 异常体验列表
AbnormalExperienceList []*AbnormalExperience `json:"AbnormalExperienceList,omitempty" name:"AbnormalExperienceList" list`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeAbnormalEventResponse ¶
func NewDescribeAbnormalEventResponse() (response *DescribeAbnormalEventResponse)
func (*DescribeAbnormalEventResponse) FromJsonString ¶
func (r *DescribeAbnormalEventResponse) FromJsonString(s string) error
func (*DescribeAbnormalEventResponse) ToJsonString ¶
func (r *DescribeAbnormalEventResponse) ToJsonString() string
type DescribeCallDetailRequest ¶
type DescribeCallDetailRequest struct {
*tchttp.BaseRequest
// 通话 ID(唯一标识一次通话): sdkappid_roomgString(房间号_createTime(房间创建时间,unix时间戳,单位为s)例:1400353843_218695_1590065777。通过 DescribeRoomInformation(查询房间列表)接口获取(链接:https://cloud.tencent.com/document/product/647/44050)
CommId *string `json:"CommId,omitempty" name:"CommId"`
// 查询开始时间,5天内。本地unix时间戳(1588031999s)
StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`
// 查询结束时间,本地unix时间戳(1588031999s)
EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
// 用户sdkappid(1400188366)
SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`
// 需查询的用户数组,不填默认返回6个用户,最多可填6个用户
UserIds []*string `json:"UserIds,omitempty" name:"UserIds" list`
// 需查询的指标,不填则只返回用户列表,填all则返回所有指标。
// appCpu:APP CPU使用率;
// sysCpu:系统 CPU使用率;
// aBit:上/下行音频码率;
// aBlock:音频卡顿时长;
// bigvBit:上/下行视频码率;
// bigvCapFps:视频采集帧率;
// bigvEncFps:视频发送帧率;
// bigvDecFps:渲染帧率;
// bigvBlock:视频卡顿时长;
// aLoss:上/下行音频丢包;
// bigvLoss:上/下行视频丢包;
// bigvWidth:上/下行分辨率宽;
// bigvHeight:上/下行分辨率高
DataType []*string `json:"DataType,omitempty" name:"DataType" list`
}
func NewDescribeCallDetailRequest ¶
func NewDescribeCallDetailRequest() (request *DescribeCallDetailRequest)
func (*DescribeCallDetailRequest) FromJsonString ¶
func (r *DescribeCallDetailRequest) FromJsonString(s string) error
func (*DescribeCallDetailRequest) ToJsonString ¶
func (r *DescribeCallDetailRequest) ToJsonString() string
type DescribeCallDetailResponse ¶
type DescribeCallDetailResponse struct {
*tchttp.BaseResponse
Response *struct {
// 返回的用户总条数
Total *uint64 `json:"Total,omitempty" name:"Total"`
// 用户信息列表
// 注意:此字段可能返回 null,表示取不到有效值。
UserList []*UserInformation `json:"UserList,omitempty" name:"UserList" list`
// 质量数据
// 注意:此字段可能返回 null,表示取不到有效值。
Data []*QualityData `json:"Data,omitempty" name:"Data" list`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeCallDetailResponse ¶
func NewDescribeCallDetailResponse() (response *DescribeCallDetailResponse)
func (*DescribeCallDetailResponse) FromJsonString ¶
func (r *DescribeCallDetailResponse) FromJsonString(s string) error
func (*DescribeCallDetailResponse) ToJsonString ¶
func (r *DescribeCallDetailResponse) ToJsonString() string
type DescribeDetailEventRequest ¶
type DescribeDetailEventRequest struct {
*tchttp.BaseRequest
// 通话 ID(唯一标识一次通话): sdkappid_roomgString(房间号_createTime(房间创建时间,unix时间戳,单位s)。通过 DescribeRoomInformation(查询房间列表)接口获取。(链接:https://cloud.tencent.com/document/product/647/44050)
CommId *string `json:"CommId,omitempty" name:"CommId"`
// 查询开始时间,5天内。本地unix时间戳(1588031999s)
StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`
// 查询结束时间,本地unix时间戳(1588031999s)
EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
// 用户id
UserId *string `json:"UserId,omitempty" name:"UserId"`
// 房间号
RoomId *string `json:"RoomId,omitempty" name:"RoomId"`
}
func NewDescribeDetailEventRequest ¶
func NewDescribeDetailEventRequest() (request *DescribeDetailEventRequest)
func (*DescribeDetailEventRequest) FromJsonString ¶
func (r *DescribeDetailEventRequest) FromJsonString(s string) error
func (*DescribeDetailEventRequest) ToJsonString ¶
func (r *DescribeDetailEventRequest) ToJsonString() string
type DescribeDetailEventResponse ¶
type DescribeDetailEventResponse struct {
*tchttp.BaseResponse
Response *struct {
// 返回的事件列表
Data []*EventList `json:"Data,omitempty" name:"Data" list`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeDetailEventResponse ¶
func NewDescribeDetailEventResponse() (response *DescribeDetailEventResponse)
func (*DescribeDetailEventResponse) FromJsonString ¶
func (r *DescribeDetailEventResponse) FromJsonString(s string) error
func (*DescribeDetailEventResponse) ToJsonString ¶
func (r *DescribeDetailEventResponse) ToJsonString() string
type DescribeHistoryScaleRequest ¶
type DescribeHistoryScaleRequest struct {
*tchttp.BaseRequest
// 用户sdkappid
SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`
// 查询开始时间,5天内。本地unix时间戳(1588031999s)
StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`
// 查询结束时间,本地unix时间戳(1588031999s)
EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
}
func NewDescribeHistoryScaleRequest ¶
func NewDescribeHistoryScaleRequest() (request *DescribeHistoryScaleRequest)
func (*DescribeHistoryScaleRequest) FromJsonString ¶
func (r *DescribeHistoryScaleRequest) FromJsonString(s string) error
func (*DescribeHistoryScaleRequest) ToJsonString ¶
func (r *DescribeHistoryScaleRequest) ToJsonString() string
type DescribeHistoryScaleResponse ¶
type DescribeHistoryScaleResponse struct {
*tchttp.BaseResponse
Response *struct {
// 返回的数据条数
Total *uint64 `json:"Total,omitempty" name:"Total"`
// 返回的数据
// 注意:此字段可能返回 null,表示取不到有效值。
ScaleList []*ScaleInfomation `json:"ScaleList,omitempty" name:"ScaleList" list`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeHistoryScaleResponse ¶
func NewDescribeHistoryScaleResponse() (response *DescribeHistoryScaleResponse)
func (*DescribeHistoryScaleResponse) FromJsonString ¶
func (r *DescribeHistoryScaleResponse) FromJsonString(s string) error
func (*DescribeHistoryScaleResponse) ToJsonString ¶
func (r *DescribeHistoryScaleResponse) ToJsonString() string
type DescribeRealtimeNetworkRequest ¶
type DescribeRealtimeNetworkRequest struct {
*tchttp.BaseRequest
// 查询开始时间,24小时内,本地unix时间戳(1588031999s)
StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`
// 查询结束时间,本地unix时间戳(1588031999s)
EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
// 用户sdkappid
SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`
// 需查询的数据类型
// sendLossRateRaw:上行丢包率
// recvLossRateRaw:下行丢包率
DataType []*string `json:"DataType,omitempty" name:"DataType" list`
}
func NewDescribeRealtimeNetworkRequest ¶
func NewDescribeRealtimeNetworkRequest() (request *DescribeRealtimeNetworkRequest)
func (*DescribeRealtimeNetworkRequest) FromJsonString ¶
func (r *DescribeRealtimeNetworkRequest) FromJsonString(s string) error
func (*DescribeRealtimeNetworkRequest) ToJsonString ¶
func (r *DescribeRealtimeNetworkRequest) ToJsonString() string
type DescribeRealtimeNetworkResponse ¶
type DescribeRealtimeNetworkResponse struct {
*tchttp.BaseResponse
Response *struct {
// 查询返回的数据
Data []*RealtimeData `json:"Data,omitempty" name:"Data" list`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeRealtimeNetworkResponse ¶
func NewDescribeRealtimeNetworkResponse() (response *DescribeRealtimeNetworkResponse)
func (*DescribeRealtimeNetworkResponse) FromJsonString ¶
func (r *DescribeRealtimeNetworkResponse) FromJsonString(s string) error
func (*DescribeRealtimeNetworkResponse) ToJsonString ¶
func (r *DescribeRealtimeNetworkResponse) ToJsonString() string
type DescribeRealtimeQualityRequest ¶
type DescribeRealtimeQualityRequest struct {
*tchttp.BaseRequest
// 查询开始时间,24小时内。本地unix时间戳(1588031999s)
StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`
// 查询结束时间,本地unix时间戳(1588031999s)
EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
// 用户sdkappid
SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`
// 查询的数据类型
// enterTotalSuccPercent:进房成功率
// fistFreamInSecRate:首帧秒开率
// blockPercent:视频卡顿率
// audioBlockPercent:音频卡顿率
DataType []*string `json:"DataType,omitempty" name:"DataType" list`
}
func NewDescribeRealtimeQualityRequest ¶
func NewDescribeRealtimeQualityRequest() (request *DescribeRealtimeQualityRequest)
func (*DescribeRealtimeQualityRequest) FromJsonString ¶
func (r *DescribeRealtimeQualityRequest) FromJsonString(s string) error
func (*DescribeRealtimeQualityRequest) ToJsonString ¶
func (r *DescribeRealtimeQualityRequest) ToJsonString() string
type DescribeRealtimeQualityResponse ¶
type DescribeRealtimeQualityResponse struct {
*tchttp.BaseResponse
Response *struct {
// 返回的数据类型
Data []*RealtimeData `json:"Data,omitempty" name:"Data" list`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeRealtimeQualityResponse ¶
func NewDescribeRealtimeQualityResponse() (response *DescribeRealtimeQualityResponse)
func (*DescribeRealtimeQualityResponse) FromJsonString ¶
func (r *DescribeRealtimeQualityResponse) FromJsonString(s string) error
func (*DescribeRealtimeQualityResponse) ToJsonString ¶
func (r *DescribeRealtimeQualityResponse) ToJsonString() string
type DescribeRealtimeScaleRequest ¶
type DescribeRealtimeScaleRequest struct {
*tchttp.BaseRequest
// 查询开始时间,24小时内。本地unix时间戳(1588031999s)
StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`
// 查询结束时间,本地unix时间戳(1588031999s)
EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
// 用户sdkappid
SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`
// 查询的数据类型
// UserNum:通话人数;
// RoomNum:房间数
DataType []*string `json:"DataType,omitempty" name:"DataType" list`
}
func NewDescribeRealtimeScaleRequest ¶
func NewDescribeRealtimeScaleRequest() (request *DescribeRealtimeScaleRequest)
func (*DescribeRealtimeScaleRequest) FromJsonString ¶
func (r *DescribeRealtimeScaleRequest) FromJsonString(s string) error
func (*DescribeRealtimeScaleRequest) ToJsonString ¶
func (r *DescribeRealtimeScaleRequest) ToJsonString() string
type DescribeRealtimeScaleResponse ¶
type DescribeRealtimeScaleResponse struct {
*tchttp.BaseResponse
Response *struct {
// 返回的数据数组
Data []*RealtimeData `json:"Data,omitempty" name:"Data" list`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeRealtimeScaleResponse ¶
func NewDescribeRealtimeScaleResponse() (response *DescribeRealtimeScaleResponse)
func (*DescribeRealtimeScaleResponse) FromJsonString ¶
func (r *DescribeRealtimeScaleResponse) FromJsonString(s string) error
func (*DescribeRealtimeScaleResponse) ToJsonString ¶
func (r *DescribeRealtimeScaleResponse) ToJsonString() string
type DescribeRoomInformationRequest ¶
type DescribeRoomInformationRequest struct {
*tchttp.BaseRequest
// 用户sdkappid
SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`
// 查询开始时间,5天内。本地unix时间戳(1588031999s)
StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`
// 查询结束时间,本地unix时间戳(1588031999s)
EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
// 数字房间号
RoomId *string `json:"RoomId,omitempty" name:"RoomId"`
// 分页index(不填默认只返回10个)
PageNumber *string `json:"PageNumber,omitempty" name:"PageNumber"`
// 分页大小(不填默认返回10个,最多不超过100条)
PageSize *string `json:"PageSize,omitempty" name:"PageSize"`
}
func NewDescribeRoomInformationRequest ¶
func NewDescribeRoomInformationRequest() (request *DescribeRoomInformationRequest)
func (*DescribeRoomInformationRequest) FromJsonString ¶
func (r *DescribeRoomInformationRequest) FromJsonString(s string) error
func (*DescribeRoomInformationRequest) ToJsonString ¶
func (r *DescribeRoomInformationRequest) ToJsonString() string
type DescribeRoomInformationResponse ¶
type DescribeRoomInformationResponse struct {
*tchttp.BaseResponse
Response *struct {
// 返回的数据总条数
Total *int64 `json:"Total,omitempty" name:"Total"`
// 房间信息列表
RoomList []*RoomState `json:"RoomList,omitempty" name:"RoomList" list`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeRoomInformationResponse ¶
func NewDescribeRoomInformationResponse() (response *DescribeRoomInformationResponse)
func (*DescribeRoomInformationResponse) FromJsonString ¶
func (r *DescribeRoomInformationResponse) FromJsonString(s string) error
func (*DescribeRoomInformationResponse) ToJsonString ¶
func (r *DescribeRoomInformationResponse) ToJsonString() string
type DismissRoomRequest ¶
type DismissRoomRequest struct {
*tchttp.BaseRequest
// TRTC的SDKAppId。
SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`
// 房间号。
RoomId *uint64 `json:"RoomId,omitempty" name:"RoomId"`
}
func NewDismissRoomRequest ¶
func NewDismissRoomRequest() (request *DismissRoomRequest)
func (*DismissRoomRequest) FromJsonString ¶
func (r *DismissRoomRequest) FromJsonString(s string) error
func (*DismissRoomRequest) ToJsonString ¶
func (r *DismissRoomRequest) ToJsonString() string
type DismissRoomResponse ¶
type DismissRoomResponse struct {
*tchttp.BaseResponse
Response *struct {
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDismissRoomResponse ¶
func NewDismissRoomResponse() (response *DismissRoomResponse)
func (*DismissRoomResponse) FromJsonString ¶
func (r *DismissRoomResponse) FromJsonString(s string) error
func (*DismissRoomResponse) ToJsonString ¶
func (r *DismissRoomResponse) ToJsonString() string
type EncodeParams ¶
type EncodeParams struct {
// 混流-输出流音频采样率。取值为[48000, 44100, 32000,24000, 22050, 16000, 12000, 11025, 8000]。
AudioSampleRate *uint64 `json:"AudioSampleRate,omitempty" name:"AudioSampleRate"`
// 混流-输出流音频码率。取值范围[8,500],单位为Kbps。
AudioBitrate *uint64 `json:"AudioBitrate,omitempty" name:"AudioBitrate"`
// 混流-输出流音频声道数,取值范围[1,2]。
AudioChannels *uint64 `json:"AudioChannels,omitempty" name:"AudioChannels"`
// 混流-输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。
VideoWidth *uint64 `json:"VideoWidth,omitempty" name:"VideoWidth"`
// 混流-输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。
VideoHeight *uint64 `json:"VideoHeight,omitempty" name:"VideoHeight"`
// 混流-输出流码率,音视频输出时必填。取值范围[1,10000],单位为Kbps。
VideoBitrate *uint64 `json:"VideoBitrate,omitempty" name:"VideoBitrate"`
// 混流-输出流帧率,音视频输出时必填。取值为[6,12,15,24,30,48,60],不在上述帧率值内系统会自动调整。
VideoFramerate *uint64 `json:"VideoFramerate,omitempty" name:"VideoFramerate"`
// 混流-输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。
VideoGop *uint64 `json:"VideoGop,omitempty" name:"VideoGop"`
// 混流-输出流背景色。
BackgroundColor *uint64 `json:"BackgroundColor,omitempty" name:"BackgroundColor"`
// 混流-输出流背景图片,取值为实时音视频控制台上传的图片ID。
BackgroundImageId *uint64 `json:"BackgroundImageId,omitempty" name:"BackgroundImageId"`
}
type EventList ¶
type EventList struct {
// 数据内容
Content []*EventMessage `json:"Content,omitempty" name:"Content" list`
// 发送端的userId
PeerId *string `json:"PeerId,omitempty" name:"PeerId"`
}
type EventMessage ¶
type EventMessage struct {
// 视频流类型:
// 0:与视频无关的事件;
// 2:视频为大画面;
// 3:视频为小画面;
// 7:视频为旁路画面;
Type *uint64 `json:"Type,omitempty" name:"Type"`
// 事件上报的时间戳,unix时间(1589891188801ms)
Time *uint64 `json:"Time,omitempty" name:"Time"`
// 事件Id:分为sdk的事件和webrtc的事件,详情见:附录/事件 ID 映射表:https://cloud.tencent.com/document/product/647/44916
EventId *uint64 `json:"EventId,omitempty" name:"EventId"`
// 事件的第一个参数,如视频分辨率宽
ParamOne *int64 `json:"ParamOne,omitempty" name:"ParamOne"`
// 事件的第二个参数,如视频分辨率高
ParamTwo *int64 `json:"ParamTwo,omitempty" name:"ParamTwo"`
}
type LayoutParams ¶
type LayoutParams struct {
// 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板
Template *uint64 `json:"Template,omitempty" name:"Template"`
// 屏幕分享模板中有效,代表左侧大画面对应的用户ID
MainVideoUserId *string `json:"MainVideoUserId,omitempty" name:"MainVideoUserId"`
// 屏幕分享模板中有效,代表左侧大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0
MainVideoStreamType *uint64 `json:"MainVideoStreamType,omitempty" name:"MainVideoStreamType"`
}
type OutputParams ¶
type OutputParams struct {
// 直播流 ID,由用户自定义设置,该流 ID 不能与用户旁路的流 ID 相同。
StreamId *string `json:"StreamId,omitempty" name:"StreamId"`
// 取值范围[0,1], 填0:直播流为音视频(默认); 填1:直播流为纯音频
PureAudioStream *uint64 `json:"PureAudioStream,omitempty" name:"PureAudioStream"`
// 自定义录制文件名
RecordId *string `json:"RecordId,omitempty" name:"RecordId"`
// 取值范围[0,1],填0无实际含义; 填1:指定录制文件格式为mp3
RecordAudioOnly *uint64 `json:"RecordAudioOnly,omitempty" name:"RecordAudioOnly"`
}
type QualityData ¶
type QualityData struct {
// 数据内容
Content []*TimeValue `json:"Content,omitempty" name:"Content" list`
// 用户ID
UserId *string `json:"UserId,omitempty" name:"UserId"`
// 对端Id,为空时表示上行数据
// 注意:此字段可能返回 null,表示取不到有效值。
PeerId *string `json:"PeerId,omitempty" name:"PeerId"`
// 数据类型
DataType *string `json:"DataType,omitempty" name:"DataType"`
}
type RealtimeData ¶
type RemoveUserRequest ¶
type RemoveUserRequest struct {
*tchttp.BaseRequest
// TRTC的SDKAppId。
SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`
// 房间号。
RoomId *uint64 `json:"RoomId,omitempty" name:"RoomId"`
// 要移出的用户列表,最多10个。
UserIds []*string `json:"UserIds,omitempty" name:"UserIds" list`
}
func NewRemoveUserRequest ¶
func NewRemoveUserRequest() (request *RemoveUserRequest)
func (*RemoveUserRequest) FromJsonString ¶
func (r *RemoveUserRequest) FromJsonString(s string) error
func (*RemoveUserRequest) ToJsonString ¶
func (r *RemoveUserRequest) ToJsonString() string
type RemoveUserResponse ¶
type RemoveUserResponse struct {
*tchttp.BaseResponse
Response *struct {
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewRemoveUserResponse ¶
func NewRemoveUserResponse() (response *RemoveUserResponse)
func (*RemoveUserResponse) FromJsonString ¶
func (r *RemoveUserResponse) FromJsonString(s string) error
func (*RemoveUserResponse) ToJsonString ¶
func (r *RemoveUserResponse) ToJsonString() string
type RoomState ¶
type RoomState struct {
// 通话ID(唯一标识一次通话)
CommId *string `json:"CommId,omitempty" name:"CommId"`
// 房间号
RoomString *string `json:"RoomString,omitempty" name:"RoomString"`
// 房间创建时间
CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`
// 房间销毁时间
DestroyTime *uint64 `json:"DestroyTime,omitempty" name:"DestroyTime"`
// 房间是否已经结束
IsFinished *bool `json:"IsFinished,omitempty" name:"IsFinished"`
// 房间创建者Id
UserId *string `json:"UserId,omitempty" name:"UserId"`
}
type ScaleInfomation ¶
type ScaleInfomation struct {
// 每天开始的时间
Time *uint64 `json:"Time,omitempty" name:"Time"`
// 房间人数,用户重复进入同一个房间为1次
// 注意:此字段可能返回 null,表示取不到有效值。
UserNumber *uint64 `json:"UserNumber,omitempty" name:"UserNumber"`
// 房间人次,用户每次进入房间为一次
// 注意:此字段可能返回 null,表示取不到有效值。
UserCount *uint64 `json:"UserCount,omitempty" name:"UserCount"`
// sdkappid下一天内的房间数
// 注意:此字段可能返回 null,表示取不到有效值。
RoomNumbers *uint64 `json:"RoomNumbers,omitempty" name:"RoomNumbers"`
}
type StartMCUMixTranscodeRequest ¶
type StartMCUMixTranscodeRequest struct {
*tchttp.BaseRequest
// TRTC的SDKAppId。
SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`
// 房间号。
RoomId *uint64 `json:"RoomId,omitempty" name:"RoomId"`
// 混流输出控制参数。
OutputParams *OutputParams `json:"OutputParams,omitempty" name:"OutputParams"`
// 混流输出编码参数。
EncodeParams *EncodeParams `json:"EncodeParams,omitempty" name:"EncodeParams"`
// 混流输出布局参数。
LayoutParams *LayoutParams `json:"LayoutParams,omitempty" name:"LayoutParams"`
}
func NewStartMCUMixTranscodeRequest ¶
func NewStartMCUMixTranscodeRequest() (request *StartMCUMixTranscodeRequest)
func (*StartMCUMixTranscodeRequest) FromJsonString ¶
func (r *StartMCUMixTranscodeRequest) FromJsonString(s string) error
func (*StartMCUMixTranscodeRequest) ToJsonString ¶
func (r *StartMCUMixTranscodeRequest) ToJsonString() string
type StartMCUMixTranscodeResponse ¶
type StartMCUMixTranscodeResponse struct {
*tchttp.BaseResponse
Response *struct {
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewStartMCUMixTranscodeResponse ¶
func NewStartMCUMixTranscodeResponse() (response *StartMCUMixTranscodeResponse)
func (*StartMCUMixTranscodeResponse) FromJsonString ¶
func (r *StartMCUMixTranscodeResponse) FromJsonString(s string) error
func (*StartMCUMixTranscodeResponse) ToJsonString ¶
func (r *StartMCUMixTranscodeResponse) ToJsonString() string
type StopMCUMixTranscodeRequest ¶
type StopMCUMixTranscodeRequest struct {
*tchttp.BaseRequest
// TRTC的SDKAppId。
SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`
// 房间号。
RoomId *uint64 `json:"RoomId,omitempty" name:"RoomId"`
}
func NewStopMCUMixTranscodeRequest ¶
func NewStopMCUMixTranscodeRequest() (request *StopMCUMixTranscodeRequest)
func (*StopMCUMixTranscodeRequest) FromJsonString ¶
func (r *StopMCUMixTranscodeRequest) FromJsonString(s string) error
func (*StopMCUMixTranscodeRequest) ToJsonString ¶
func (r *StopMCUMixTranscodeRequest) ToJsonString() string
type StopMCUMixTranscodeResponse ¶
type StopMCUMixTranscodeResponse struct {
*tchttp.BaseResponse
Response *struct {
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewStopMCUMixTranscodeResponse ¶
func NewStopMCUMixTranscodeResponse() (response *StopMCUMixTranscodeResponse)
func (*StopMCUMixTranscodeResponse) FromJsonString ¶
func (r *StopMCUMixTranscodeResponse) FromJsonString(s string) error
func (*StopMCUMixTranscodeResponse) ToJsonString ¶
func (r *StopMCUMixTranscodeResponse) ToJsonString() string
type UserInformation ¶
type UserInformation struct {
// 房间号
RoomStr *string `json:"RoomStr,omitempty" name:"RoomStr"`
// 用户Id
UserId *string `json:"UserId,omitempty" name:"UserId"`
// 用户进房时间
JoinTs *uint64 `json:"JoinTs,omitempty" name:"JoinTs"`
// 用户退房时间
LeaveTs *uint64 `json:"LeaveTs,omitempty" name:"LeaveTs"`
// 终端类型
DeviceType *string `json:"DeviceType,omitempty" name:"DeviceType"`
// Sdk版本号
SdkVersion *string `json:"SdkVersion,omitempty" name:"SdkVersion"`
// 客户端IP地址
ClientIp *string `json:"ClientIp,omitempty" name:"ClientIp"`
// 判断用户是否已经离开房间
Finished *bool `json:"Finished,omitempty" name:"Finished"`
}