TrtcClient (tencentcloud-sdk-java 3.1.68 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.trtc.v20190722.TrtcClient

public class TrtcClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`TrtcClient(Credential credential, String region)`
`TrtcClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateTroubleInfoResponse`	`CreateTroubleInfo(CreateTroubleInfoRequest req)` 创建异常信息
`DescribeCallDetailResponse`	`DescribeCallDetail(DescribeCallDetailRequest req)` 查询指定时间内的用户列表及用户通话质量数据。可查询5天内数据，查询起止时间不超过1个小时，查询用户不超过6个
`DescribeDetailEventResponse`	`DescribeDetailEvent(DescribeDetailEventRequest req)` 查询用户某次通话内的进退房，视频开关等详细事件。可查询5天内数据。
`DescribeHistoryScaleResponse`	`DescribeHistoryScale(DescribeHistoryScaleRequest req)` 可查询sdkqppid 每天的房间数和用户数，每分钟1次，可查询最近5天的数据。当天未结束，无法查到当天的房间数与用户数。
`DescribeRealtimeNetworkResponse`	`DescribeRealtimeNetwork(DescribeRealtimeNetworkRequest req)` 查询sdkappid维度下实时网络状态，包括上行丢包与下行丢包。可查询24小时内数据，查询起止时间不超过1个小时。
`DescribeRealtimeQualityResponse`	`DescribeRealtimeQuality(DescribeRealtimeQualityRequest req)` 查询sdkappid维度下实时质量数据，包括：进房成功率，首帧秒开率，音频卡顿率，视频卡顿率。可查询24小时内数据，查询起止时间不超过1个小时。
`DescribeRealtimeScaleResponse`	`DescribeRealtimeScale(DescribeRealtimeScaleRequest req)` 查询sdkappid维度下实时规模，可查询24小时内数据，查询起止时间不超过1个小时。
`DescribeRoomInformationResponse`	`DescribeRoomInformation(DescribeRoomInformationRequest req)` 查询sdkappid下的房间列表。默认返回10条通话，一次最多返回100条通话。可查询5天内的数据。
`DismissRoomResponse`	`DismissRoom(DismissRoomRequest req)` 接口说明：把房间所有用户从房间移出，解散房间。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
`RemoveUserResponse`	`RemoveUser(RemoveUserRequest req)` 接口说明：将用户从房间移出，适用于主播/房主/管理员踢人等场景。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
`StartMCUMixTranscodeResponse`	`StartMCUMixTranscode(StartMCUMixTranscodeRequest req)` 接口说明：启动云端混流，并指定混流画面中各路画面的布局位置。 TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过此 API 接口，通知腾讯云服务端将多路视频画面合成一路，并指定每一路画面的位置，同时将多路声音进行混音，最终形成一路音视频流，以便用于录制和直播观看。您可以通过此接口实现如下目标： - 设置最终直播流的画质和音质，包括视频分辨率、视频码率、视频帧率、以及声音质量等。 - 设置各路画面的位置和布局，您只需要在启动时设置一次，排版引擎会自动完成后续的画面排布。 - 设置录制文件名，用于二次回放。 - 设置 CDN 直播流 ID，用于在 CDN 进行直播观看。目前已经支持了如下几种布局模板： - 悬浮模板：第一个进入房间的用户的视频画面会铺满整个屏幕，其他用户的视频画面从左下角依次水平排列，显示为小画面，最多4行，每行4个，小画面悬浮于大画面之上。最多支持1个大画面和15个小画面，如果用户只发送音频，仍然会占用画面位置。 - 九宫格模板：所有用户的视频画面大小一致，平分整个屏幕，人数越多，每个画面的尺寸越小。最多支持16个画面，如果用户只发送音频，仍然会占用画面位置。 - 屏幕分享模板：适合视频会议和在线教育场景的布局，屏幕分享（或者主讲的摄像头）始终占据屏幕左侧的大画面位置，其他用户依次垂直排列于右侧，最多两列，每列最多8个小画面。最多支持1个大画面和15个小画面，如果用户只发送音频，仍然会占用画面位置。
`StopMCUMixTranscodeResponse`	`StopMCUMixTranscode(StopMCUMixTranscodeRequest req)` 接口说明：结束云端混流

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TrtcClient
```
public TrtcClient(Credential credential,
                  String region)
```
  - TrtcClient
```
public TrtcClient(Credential credential,
                  String region,
                  ClientProfile profile)
```
- Method Detail
  - CreateTroubleInfo
```
public CreateTroubleInfoResponse CreateTroubleInfo(CreateTroubleInfoRequest req)
                                            throws TencentCloudSDKException
```
    创建异常信息
    
    Parameters:
    
    req - CreateTroubleInfoRequest
    
    Returns:
    
    CreateTroubleInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCallDetail
```
public DescribeCallDetailResponse DescribeCallDetail(DescribeCallDetailRequest req)
                                              throws TencentCloudSDKException
```
    查询指定时间内的用户列表及用户通话质量数据。可查询5天内数据，查询起止时间不超过1个小时，查询用户不超过6个
    
    Parameters:
    
    req - DescribeCallDetailRequest
    
    Returns:
    
    DescribeCallDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDetailEvent
```
public DescribeDetailEventResponse DescribeDetailEvent(DescribeDetailEventRequest req)
                                                throws TencentCloudSDKException
```
    查询用户某次通话内的进退房，视频开关等详细事件。可查询5天内数据。
    
    Parameters:
    
    req - DescribeDetailEventRequest
    
    Returns:
    
    DescribeDetailEventResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeHistoryScale
```
public DescribeHistoryScaleResponse DescribeHistoryScale(DescribeHistoryScaleRequest req)
                                                  throws TencentCloudSDKException
```
    可查询sdkqppid 每天的房间数和用户数，每分钟1次，可查询最近5天的数据。当天未结束，无法查到当天的房间数与用户数。
    
    Parameters:
    
    req - DescribeHistoryScaleRequest
    
    Returns:
    
    DescribeHistoryScaleResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRealtimeNetwork
```
public DescribeRealtimeNetworkResponse DescribeRealtimeNetwork(DescribeRealtimeNetworkRequest req)
                                                        throws TencentCloudSDKException
```
    查询sdkappid维度下实时网络状态，包括上行丢包与下行丢包。可查询24小时内数据，查询起止时间不超过1个小时。
    
    Parameters:
    
    req - DescribeRealtimeNetworkRequest
    
    Returns:
    
    DescribeRealtimeNetworkResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRealtimeQuality
```
public DescribeRealtimeQualityResponse DescribeRealtimeQuality(DescribeRealtimeQualityRequest req)
                                                        throws TencentCloudSDKException
```
    查询sdkappid维度下实时质量数据，包括：进房成功率，首帧秒开率，音频卡顿率，视频卡顿率。可查询24小时内数据，查询起止时间不超过1个小时。
    
    Parameters:
    
    req - DescribeRealtimeQualityRequest
    
    Returns:
    
    DescribeRealtimeQualityResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRealtimeScale
```
public DescribeRealtimeScaleResponse DescribeRealtimeScale(DescribeRealtimeScaleRequest req)
                                                    throws TencentCloudSDKException
```
    查询sdkappid维度下实时规模，可查询24小时内数据，查询起止时间不超过1个小时。
    
    Parameters:
    
    req - DescribeRealtimeScaleRequest
    
    Returns:
    
    DescribeRealtimeScaleResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRoomInformation
```
public DescribeRoomInformationResponse DescribeRoomInformation(DescribeRoomInformationRequest req)
                                                        throws TencentCloudSDKException
```
    查询sdkappid下的房间列表。默认返回10条通话，一次最多返回100条通话。可查询5天内的数据。
    
    Parameters:
    
    req - DescribeRoomInformationRequest
    
    Returns:
    
    DescribeRoomInformationResponse
    
    Throws:
    
    TencentCloudSDKException
  - DismissRoom
```
public DismissRoomResponse DismissRoom(DismissRoomRequest req)
                                throws TencentCloudSDKException
```
    接口说明：把房间所有用户从房间移出，解散房间。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
    
    Parameters:
    
    req - DismissRoomRequest
    
    Returns:
    
    DismissRoomResponse
    
    Throws:
    
    TencentCloudSDKException
  - RemoveUser
```
public RemoveUserResponse RemoveUser(RemoveUserRequest req)
                              throws TencentCloudSDKException
```
    接口说明：将用户从房间移出，适用于主播/房主/管理员踢人等场景。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
    
    Parameters:
    
    req - RemoveUserRequest
    
    Returns:
    
    RemoveUserResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartMCUMixTranscode
```
public StartMCUMixTranscodeResponse StartMCUMixTranscode(StartMCUMixTranscodeRequest req)
                                                  throws TencentCloudSDKException
```
    接口说明：启动云端混流，并指定混流画面中各路画面的布局位置。 TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过此 API 接口，通知腾讯云服务端将多路视频画面合成一路，并指定每一路画面的位置，同时将多路声音进行混音，最终形成一路音视频流，以便用于录制和直播观看。您可以通过此接口实现如下目标： - 设置最终直播流的画质和音质，包括视频分辨率、视频码率、视频帧率、以及声音质量等。 - 设置各路画面的位置和布局，您只需要在启动时设置一次，排版引擎会自动完成后续的画面排布。 - 设置录制文件名，用于二次回放。 - 设置 CDN 直播流 ID，用于在 CDN 进行直播观看。目前已经支持了如下几种布局模板： - 悬浮模板：第一个进入房间的用户的视频画面会铺满整个屏幕，其他用户的视频画面从左下角依次水平排列，显示为小画面，最多4行，每行4个，小画面悬浮于大画面之上。最多支持1个大画面和15个小画面，如果用户只发送音频，仍然会占用画面位置。 - 九宫格模板：所有用户的视频画面大小一致，平分整个屏幕，人数越多，每个画面的尺寸越小。最多支持16个画面，如果用户只发送音频，仍然会占用画面位置。 - 屏幕分享模板：适合视频会议和在线教育场景的布局，屏幕分享（或者主讲的摄像头）始终占据屏幕左侧的大画面位置，其他用户依次垂直排列于右侧，最多两列，每列最多8个小画面。最多支持1个大画面和15个小画面，如果用户只发送音频，仍然会占用画面位置。
    
    Parameters:
    
    req - StartMCUMixTranscodeRequest
    
    Returns:
    
    StartMCUMixTranscodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopMCUMixTranscode
```
public StopMCUMixTranscodeResponse StopMCUMixTranscode(StopMCUMixTranscodeRequest req)
                                                throws TencentCloudSDKException
```
    接口说明：结束云端混流
    
    Parameters:
    
    req - StopMCUMixTranscodeRequest
    
    Returns:
    
    StopMCUMixTranscodeResponse
    
    Throws:
    
    TencentCloudSDKException

Class TrtcClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

TrtcClient

TrtcClient

Method Detail

CreateTroubleInfo

DescribeCallDetail

DescribeDetailEvent

DescribeHistoryScale

DescribeRealtimeNetwork

DescribeRealtimeQuality

DescribeRealtimeScale

DescribeRoomInformation

DismissRoom

RemoveUser

StartMCUMixTranscode

StopMCUMixTranscode