com.tencentcloudapi.trtc.v20190722

Class TrtcClient

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

Modifier and Type	Method and Description
DescribeCallDetailResponse	DescribeCallDetail(DescribeCallDetailRequest req) This API is used to query the user list and user call quality data in a specified time period.
DescribeHistoryScaleResponse	DescribeHistoryScale(DescribeHistoryScaleRequest req) This API is used to query the number of historical rooms and users for the last 5 days.
DescribeRealtimeNetworkResponse	DescribeRealtimeNetwork(DescribeRealtimeNetworkRequest req) This API is used to query real-time network status for the last 24 hours according to `sdkappid`, including upstream and downstream packet losses.
DescribeRealtimeQualityResponse	DescribeRealtimeQuality(DescribeRealtimeQualityRequest req) This API is used to query real-time quality data for the last 24 hours according to `sdkappid`, including the room entry success rate, instant playback rate of the first frame, audio lag rate, and video lag rate.
DescribeRealtimeScaleResponse	DescribeRealtimeScale(DescribeRealtimeScaleRequest req) This API is used to query the real-time scale for the last 24 hours according to `sdkappid`.
DescribeRoomInformationResponse	DescribeRoomInformation(DescribeRoomInformationRequest req) This API is used to query the room list for the last 5 days according to `sdkappid`.
DismissRoomResponse	DismissRoom(DismissRoomRequest req) This API is used to remove all users from a room and dismiss the room.
RemoveUserResponse	RemoveUser(RemoveUserRequest req) This API is used to remove a user from a room.

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

DescribeCallDetail

public DescribeCallDetailResponse DescribeCallDetail(DescribeCallDetailRequest req)
                                              throws TencentCloudSDKException

This API is used to query the user list and user call quality data in a specified time period. It can query data of up to 6 users for the last 5 days, and the query time range cannot exceed 1 hour.

Parameters:

req - DescribeCallDetailRequest

Returns:

DescribeCallDetailResponse

Throws:

TencentCloudSDKException

DescribeHistoryScale

public DescribeHistoryScaleResponse DescribeHistoryScale(DescribeHistoryScaleRequest req)
                                                  throws TencentCloudSDKException

This API is used to query the number of historical rooms and users for the last 5 days. It can query once per minute.

Parameters:

req - DescribeHistoryScaleRequest

Returns:

DescribeHistoryScaleResponse

Throws:

TencentCloudSDKException

DescribeRealtimeNetwork

public DescribeRealtimeNetworkResponse DescribeRealtimeNetwork(DescribeRealtimeNetworkRequest req)
                                                        throws TencentCloudSDKException

This API is used to query real-time network status for the last 24 hours according to `sdkappid`, including upstream and downstream packet losses. The query time range cannot exceed 1 hour.

Parameters:

req - DescribeRealtimeNetworkRequest

Returns:

DescribeRealtimeNetworkResponse

Throws:

TencentCloudSDKException

DescribeRealtimeQuality

public DescribeRealtimeQualityResponse DescribeRealtimeQuality(DescribeRealtimeQualityRequest req)
                                                        throws TencentCloudSDKException

This API is used to query real-time quality data for the last 24 hours according to `sdkappid`, including the room entry success rate, instant playback rate of the first frame, audio lag rate, and video lag rate. The query time range cannot exceed 1 hour.

Parameters:

req - DescribeRealtimeQualityRequest

Returns:

DescribeRealtimeQualityResponse

Throws:

TencentCloudSDKException

DescribeRealtimeScale

public DescribeRealtimeScaleResponse DescribeRealtimeScale(DescribeRealtimeScaleRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the real-time scale for the last 24 hours according to `sdkappid`. The query time range cannot exceed 1 hour.

Parameters:

req - DescribeRealtimeScaleRequest

Returns:

DescribeRealtimeScaleResponse

Throws:

TencentCloudSDKException

DescribeRoomInformation

public DescribeRoomInformationResponse DescribeRoomInformation(DescribeRoomInformationRequest req)
                                                        throws TencentCloudSDKException

This API is used to query the room list for the last 5 days according to `sdkappid`. It returns 10 calls by default and up to 100 calls at a time.

Parameters:

req - DescribeRoomInformationRequest

Returns:

DescribeRoomInformationResponse

Throws:

TencentCloudSDKException

DismissRoom

public DismissRoomResponse DismissRoom(DismissRoomRequest req)
                                throws TencentCloudSDKException

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

Parameters:

req - DismissRoomRequest

Returns:

DismissRoomResponse

Throws:

TencentCloudSDKException

RemoveUser

public RemoveUserResponse RemoveUser(RemoveUserRequest req)
                              throws TencentCloudSDKException

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

Parameters:

req - RemoveUserRequest

Returns:

RemoveUserResponse

Throws:

TencentCloudSDKException