TrtcClient (tencentcloud-sdk-java-intl-en 3.0.50 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)` This API is used to create exception information.
`DescribeAbnormalEventResponse`	`DescribeAbnormalEvent(DescribeAbnormalEventRequest req)` This API is used to query users’ exceptional experience events according to `SDKAppID` and return the exceptional experience ID and possible causes.
`DescribeCallDetailResponse`	`DescribeCallDetail(DescribeCallDetailRequest req)` This API is used to query the user list and user call quality data in a specified time period.
`DescribeDetailEventResponse`	`DescribeDetailEvent(DescribeDetailEventRequest req)` This API is used to query detailed events of a user such as room entry/exit and video enablement/disablement during a call.
`DescribeHistoryScaleResponse`	`DescribeHistoryScale(DescribeHistoryScaleRequest req)` This API is used to query the daily numbers of rooms and users under a specified `sdkqppid`.
`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.
`StartMCUMixTranscodeResponse`	`StartMCUMixTranscode(StartMCUMixTranscodeRequest req)` This API is used to enable on-cloud stream mix and specify the layout position of each channel of video image in the mixed video image.
`StopMCUMixTranscodeResponse`	`StopMCUMixTranscode(StopMCUMixTranscodeRequest req)` This API is used to end On-Cloud MixTranscoding.

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
```
    This API is used to create exception information.
    
    Parameters:
    
    req - CreateTroubleInfoRequest
    
    Returns:
    
    CreateTroubleInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAbnormalEvent
```
public DescribeAbnormalEventResponse DescribeAbnormalEvent(DescribeAbnormalEventRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to query users’ exceptional experience events according to `SDKAppID` and return the exceptional experience ID and possible causes. It queries data in last 24 hours, and the query period is up to 1 hour which can start and end on different days. For more information about exceptional experience ID mapping, please see here.
    
    Parameters:
    
    req - DescribeAbnormalEventRequest
    
    Returns:
    
    DescribeAbnormalEventResponse
    
    Throws:
    
    TencentCloudSDKException
  - 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 queries data of up to 6 users in the last 5 days. The query period is up to 1 hour, which must start and end on the same day.
    
    Parameters:
    
    req - DescribeCallDetailRequest
    
    Returns:
    
    DescribeCallDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDetailEvent
```
public DescribeDetailEventResponse DescribeDetailEvent(DescribeDetailEventRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to query detailed events of a user such as room entry/exit and video enablement/disablement during a call. It can query data for the last 5 days.
    
    Parameters:
    
    req - DescribeDetailEventRequest
    
    Returns:
    
    DescribeDetailEventResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeHistoryScale
```
public DescribeHistoryScaleResponse DescribeHistoryScale(DescribeHistoryScaleRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to query the daily numbers of rooms and users under a specified `sdkqppid`. It can query data once per minute for the last 5 days. If a day has not ended, the numbers of rooms and users on the day cannot be queried.
    
    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
  - StartMCUMixTranscode
```
public StartMCUMixTranscodeResponse StartMCUMixTranscode(StartMCUMixTranscodeRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to enable on-cloud stream mix and specify the layout position of each channel of video image in the mixed video image. There may be multiple channels of audio/video streams in a TRTC room. You can call this API to request the Tencent Cloud server to combine multiple channels of video images into one channel, specify the position of each channel, and mix the multiple channels of audio so as to output one channel of audio/video stream for easier recording and live streaming. You can use this API to perform the following operations: - Set the image and audio quality parameters of the final live stream, including video resolution, video bitrate, video frame rate, and audio quality. - Set the image layout, i.e., positions of all channels of images. You only need to set the layout once when enabling on-cloud stream mix, and the layout engine will automatically arrange the video images in the configured layout in subsequent operations. - Set the recording file name for future playback. - Set the CDN live stream ID for live streaming over CDN. Currently, the following layout templates are supported: - Floating template: the entire screen will be covered by the video image of the first user who enters the room, and the video images of other users will be displayed as small images in horizontal rows from the bottom-left corner in room entry sequence. The screen can contain up to 4 lines with 4 small images each row, which float over the big image. Up to 1 big image and 15 small images are supported. If a user sends audio only, the user will still use an image spot. - Grid template: the screen is divided into user video images with the same dimensions. The more the users, the smaller the image dimensions. Up to 16 images are supported. If a user sends audio only, the user will still use an image spot. - Screen sharing template: it is suitable for video conferencing and online education. The shared screen (or camera of the anchor) is always displayed in the big image on the left of the screen, and the video images of other users are vertically displayed on the right in up to 2 columns with up to 8 small images in each column. Up to 1 big image and 15 small images are supported. If a user sends audio only, the user will still use an image spot. - Picture-in-picture template: it is suitable for mixing a pair of big/small images or a big image with the audio of other users. The small image floats over the big image, and the users in the big/small images and the display position of the small image can be specified.
    
    Parameters:
    
    req - StartMCUMixTranscodeRequest
    
    Returns:
    
    StartMCUMixTranscodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopMCUMixTranscode
```
public StopMCUMixTranscodeResponse StopMCUMixTranscode(StopMCUMixTranscodeRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to end On-Cloud MixTranscoding.
    
    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

DescribeAbnormalEvent

DescribeCallDetail

DescribeDetailEvent

DescribeHistoryScale

DescribeRealtimeNetwork

DescribeRealtimeQuality

DescribeRealtimeScale

DescribeRoomInformation

DismissRoom

RemoveUser

StartMCUMixTranscode

StopMCUMixTranscode