TrtcClient (tencentcloud-sdk-java-intl-en 3.0.177 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 exception occurrences under a specified `SDKAppID` and return the exception IDs and possible causes.
`DescribeCallDetailResponse`	`DescribeCallDetail(DescribeCallDetailRequest req)` This API is used to query the user list and call quality data of a specified time range in the last 14 days.
`DescribeDetailEventResponse`	`DescribeDetailEvent(DescribeDetailEventRequest req)` This API is used to query a user’s activity details 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 `SDKAppID`.
`DescribeRealtimeNetworkResponse`	`DescribeRealtimeNetwork(DescribeRealtimeNetworkRequest req)` This API is used to query the network conditions of an `SDKAppID`, including upstream and downstream packet loss, in the last 24 hours on a per-minute basis.
`DescribeRealtimeQualityResponse`	`DescribeRealtimeQuality(DescribeRealtimeQualityRequest req)` This API is used to query the quality metrics of an `SDKAppID` in the last 24 hours on a per-minute basis, including room entry success rate, instant playback rate of the first frame, and audio/video lag rate.
`DescribeRealtimeScaleResponse`	`DescribeRealtimeScale(DescribeRealtimeScaleRequest req)` This API is used to query the scale of an `SDKAppID` in the last 24 hours on a per-minute basis.
`DescribeRoomInformationResponse`	`DescribeRoomInformation(DescribeRoomInformationRequest req)` This API is used to query the room list of an `SDKAppID` in the last 14 days.
`DescribeUserInformationResponse`	`DescribeUserInformation(DescribeUserInformationRequest req)` This API is used to query the user list of a specified time range (up to 4 hours) in the last 14 days.
`DismissRoomResponse`	`DismissRoom(DismissRoomRequest req)` This API is used to remove all users from a room and dismiss the room.
`DismissRoomByStrRoomIdResponse`	`DismissRoomByStrRoomId(DismissRoomByStrRoomIdRequest req)` This API is used to remove all users from a room and close the room.
`RemoveUserResponse`	`RemoveUser(RemoveUserRequest req)` This API is used to remove a user from a room.
`RemoveUserByStrRoomIdResponse`	`RemoveUserByStrRoomId(RemoveUserByStrRoomIdRequest req)` This API is used to remove a user from a room.
`StartMCUMixTranscodeResponse`	`StartMCUMixTranscode(StartMCUMixTranscodeRequest req)` This API is used to enable On-Cloud MixTranscoding and specify the position of each channel of image in stream mixing.
`StartMCUMixTranscodeByStrRoomIdResponse`	`StartMCUMixTranscodeByStrRoomId(StartMCUMixTranscodeByStrRoomIdRequest req)` This API is used to enable On-Cloud MixTranscoding and specify the position of each channel of image in stream mixing.
`StopMCUMixTranscodeResponse`	`StopMCUMixTranscode(StopMCUMixTranscodeRequest req)` This API is used to end On-Cloud MixTranscoding.
`StopMCUMixTranscodeByStrRoomIdResponse`	`StopMCUMixTranscodeByStrRoomId(StopMCUMixTranscodeByStrRoomIdRequest req)` This API is used to stop 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 exception occurrences under a specified `SDKAppID` and return the exception IDs and possible causes. It queries data in last 15 days, and the query period is up to 1 hour, which can start and end on different days. For more information about exceptions, please see the exception event ID mapping table: https://intl.cloud.tencent.com/document/product/647/37906.
    
    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 call quality data of a specified time range in the last 14 days. When `DataType` is not null, data of up to 6 users during a period of up to 1 hour can be queried each time, and the period can start on one day and end on the next. When `DataType` and `UserIds` are null, 6 users are queried by default, and data of up to 100 users can be displayed on each page (`PageSize` set to 100 or lower). This API is used to query call quality and is not recommended for billing. Note: you are not advised to use the API for the processing of real-time business logic.
    
    Parameters:
    
    req - DescribeCallDetailRequest
    
    Returns:
    
    DescribeCallDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDetailEvent
```
public DescribeDetailEventResponse DescribeDetailEvent(DescribeDetailEventRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to query a user’s activity details such as room entry/exit and video enablement/disablement during a call. It can query data for the last 14 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 `SDKAppID`. It can query data once per minute for the last 14 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 the network conditions of an `SDKAppID`, including upstream and downstream packet loss, in the last 24 hours on a per-minute basis. The query period must be 1-60 minutes.
    
    Parameters:
    
    req - DescribeRealtimeNetworkRequest
    
    Returns:
    
    DescribeRealtimeNetworkResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRealtimeQuality
```
public DescribeRealtimeQualityResponse DescribeRealtimeQuality(DescribeRealtimeQualityRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to query the quality metrics of an `SDKAppID` in the last 24 hours on a per-minute basis, including room entry success rate, instant playback rate of the first frame, and audio/video lag rate. The query period must be 1-60 minutes.
    
    Parameters:
    
    req - DescribeRealtimeQualityRequest
    
    Returns:
    
    DescribeRealtimeQualityResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRealtimeScale
```
public DescribeRealtimeScaleResponse DescribeRealtimeScale(DescribeRealtimeScaleRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to query the scale of an `SDKAppID` in the last 24 hours on a per-minute basis. The query period must be 1-60 minutes.
    
    Parameters:
    
    req - DescribeRealtimeScaleRequest
    
    Returns:
    
    DescribeRealtimeScaleResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRoomInformation
```
public DescribeRoomInformationResponse DescribeRoomInformation(DescribeRoomInformationRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to query the room list of an `SDKAppID` in the last 14 days. It returns 10 calls by default and can return up to 100 calls per query. Note: you are not advised to use the API for the processing of real-time business logic.
    
    Parameters:
    
    req - DescribeRoomInformationRequest
    
    Returns:
    
    DescribeRoomInformationResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUserInformation
```
public DescribeUserInformationResponse DescribeUserInformation(DescribeUserInformationRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to query the user list of a specified time range (up to 4 hours) in the last 14 days. Data of 6 users is displayed on each page by default, and data of up to 100 users can be displayed on each page (`PageSize` set to 100 or lower). Note: you are not advised to use the API for the processing of real-time business logic.
    
    Parameters:
    
    req - DescribeUserInformationRequest
    
    Returns:
    
    DescribeUserInformationResponse
    
    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
  - DismissRoomByStrRoomId
```
public DismissRoomByStrRoomIdResponse DismissRoomByStrRoomId(DismissRoomByStrRoomIdRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to remove all users from a room and close the room. It works on all platforms. For Android, iOS, Windows, and macOS, you need to update the TRTC SDK to version 6.6 or above.
    
    Parameters:
    
    req - DismissRoomByStrRoomIdRequest
    
    Returns:
    
    DismissRoomByStrRoomIdResponse
    
    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
  - RemoveUserByStrRoomId
```
public RemoveUserByStrRoomIdResponse RemoveUserByStrRoomId(RemoveUserByStrRoomIdRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to remove a user from a room. It allows the anchor, room owner, or admin to kick out a user, and works on all platforms. For Android, iOS, Windows, and macOS, you need to update the TRTC SDK to version 6.6 or above.
    
    Parameters:
    
    req - RemoveUserByStrRoomIdRequest
    
    Returns:
    
    RemoveUserByStrRoomIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartMCUMixTranscode
```
public StartMCUMixTranscodeResponse StartMCUMixTranscode(StartMCUMixTranscodeRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to enable On-Cloud MixTranscoding and specify the position of each channel of image in stream mixing. 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 and audio into one channel and specify the position of each image so as to produce just one channel of audio/video stream for recording and live streaming. The mixing stops automatically after a room is destroyed. You can use this API to perform the following operations: - Set image and audio quality parameters of the final live stream, including video resolution, video bitrate, video frame rate, and audio quality. - Set the layout, i.e., the position of each channel of image. You only need to set it once when enabling On-Cloud MixTranscoding, and the layout engine will automatically arrange images as configured. - Set the names of recording files for future playback. - Set the stream ID for CDN live streaming. Currently, On-Cloud MixTranscoding supports the following layout templates: - Floating: the entire screen is covered by the video image of the first user who enters the room, and the images of other users are displayed as small images in horizontal rows in the bottom-left corner in room entry sequence. The screen can accommodate up to 4 rows of 4 small images, which float over the big image. Up to 1 big image and 15 small images can be displayed. A user sending audio only will still occupy an image spot. - Grid: the images of the users split the entire screen evenly. The more the users, the smaller the image dimensions. Up to 16 images can be displayed. A user sending audio only will still occupy an image spot. - Screen sharing: this is designed for video conferencing and online education. The shared screen (image of the anchor) is always displayed as the big image, which occupies the left half of the screen, and the images of other users occupy the right half in up to 2 columns of up to 8 small images each. Up to 1 big image and 15 small images can be displayed. If the aspect ratio of upstream images do not match that of output images, the big image on the left will be scaled and displayed in whole, while the small images on the right will be cropped. - Picture-in-picture: this is designed for mixing the dual-channel (small and big) image or big image with the audio of other users. The small images float over the big image. You can specify which users to be displayed as the big/small images as well as the positions of the small images. Up to 2 images are supported. - Custom: this is designed for cases where you want to specify the image positions of users in the mixed stream or preset image positions. If users are assigned to preset positions, the layout engine will reserve the positions for the users; if not, users will occupy the positions in room entry sequence. Once all preset positions are occupied, TRTC will stop mixing the audio and images of other users. If the placeholding feature is enabled for a custom template (`PlaceHolderMode` in `LayoutParams` set to 1), but a user for whom a place is reserved is not sending video data, the position will show the corresponding placeholder image (`PlaceImageId`). Note: only applications created on and after January 9, 2020 can call this API directly. Applications created before use the stream mixing service of LVB by default. If you want to switch to MCU On-Cloud MixTranscoding, please [submit a ticket](https://console.cloud.tencent.com/workorder/category).
    
    Parameters:
    
    req - StartMCUMixTranscodeRequest
    
    Returns:
    
    StartMCUMixTranscodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartMCUMixTranscodeByStrRoomId
```
public StartMCUMixTranscodeByStrRoomIdResponse StartMCUMixTranscodeByStrRoomId(StartMCUMixTranscodeByStrRoomIdRequest req)
                                                                        throws TencentCloudSDKException
```
    This API is used to enable On-Cloud MixTranscoding and specify the position of each channel of image in stream mixing. 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 mix multiple channels of video images and audio into one channel and specify the position of each image so as to produce only one channel of audio/video stream for recording and live streaming. You can use this API to perform the following operations: - Set image and audio quality parameters of the mixed stream, including video resolution, bitrate, frame rate, and audio quality. - Set the layout, i.e., the position of each channel of image. You only need to set it once when enabling On-Cloud MixTranscoding, and the layout engine will automatically arrange images as configured. - Set the names of recording files for future playback. - Set the stream ID for CDN live streaming. Currently, On-Cloud MixTranscoding supports the following layout templates: - Floating: the entire screen is covered by the video image of the first user who enters the room, and the images of other users are displayed as small images in horizontal rows in the bottom-left corner in room entry sequence. The screen can accommodate up to 4 rows of 4 small images, which float over the big image. Up to 1 big image and 15 small images can be displayed. A user sending audio only will still occupy an image spot. - Grid: the images of all users split the screen evenly. The more the users, the smaller the image dimensions. Up to 16 images can be displayed. A user sending audio only will still occupy an image spot. - Screen sharing: this template is designed for video conferencing and online classes. The shared screen (or camera image of the anchor) is always displayed as the big image, which occupies the left half of the screen, and the images of other users occupy the right half in up to 2 columns of a maximum of 8 small images each. Up to 1 big image and 15 small images can be displayed. If the aspect ratio of upstream images does not match that of output images, the big image on the left will be scaled and displayed in whole, while the small images on the right will be cropped. - Picture-in-picture: this template mixes the big and small images or big image of a user with the audio of other users. The small image floats over the big image. You can specify the user whose big and small images are displayed and the position of the small image. - Custom: you can use custom templates to specify the image positions of users in mixed streams or preset image positions. If users are assigned to preset positions, the layout engine will reserve the positions for the users; if not, users will occupy the positions in room entry sequence. Once all preset positions are occupied, TRTC will stop mixing the audio and images of other users. If the placeholding feature is enabled for a custom template (`PlaceHolderMode` in `LayoutParams` is set to 1), but a user for whom a place is reserved is not sending video data, the position will show the corresponding placeholder image (`PlaceImageId`). Note: only applications created on and after January 9, 2020 can call this API directly. Those created before use the stream mixing service of CSS by default. If you want to switch to MCU On-Cloud MixTranscoding, please [submit a ticket](https://console.cloud.tencent.com/workorder/category).
    
    Parameters:
    
    req - StartMCUMixTranscodeByStrRoomIdRequest
    
    Returns:
    
    StartMCUMixTranscodeByStrRoomIdResponse
    
    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
  - StopMCUMixTranscodeByStrRoomId
```
public StopMCUMixTranscodeByStrRoomIdResponse StopMCUMixTranscodeByStrRoomId(StopMCUMixTranscodeByStrRoomIdRequest req)
                                                                      throws TencentCloudSDKException
```
    This API is used to stop On-Cloud MixTranscoding.
    
    Parameters:
    
    req - StopMCUMixTranscodeByStrRoomIdRequest
    
    Returns:
    
    StopMCUMixTranscodeByStrRoomIdResponse
    
    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

DescribeUserInformation

DismissRoom

DismissRoomByStrRoomId

RemoveUser

RemoveUserByStrRoomId

StartMCUMixTranscode

StartMCUMixTranscodeByStrRoomId

StopMCUMixTranscode

StopMCUMixTranscodeByStrRoomId