TrtcClient (tencentcloud-sdk-java-intl-en 3.0.521 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
`CreateCloudRecordingResponse`	`CreateCloudRecording(CreateCloudRecordingRequest req)` API description: This API is used to start an on-cloud recording task.
`DeleteCloudRecordingResponse`	`DeleteCloudRecording(DeleteCloudRecordingRequest req)` This API is used to stop a recording task.
`DescribeCloudRecordingResponse`	`DescribeCloudRecording(DescribeCloudRecordingRequest req)` This API is used to query the status of a recording task after it starts.
`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.
`ModifyCloudRecordingResponse`	`ModifyCloudRecording(ModifyCloudRecordingRequest req)` This API is used to modify a recording task.
`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.
`StartPublishCdnStreamResponse`	`StartPublishCdnStream(StartPublishCdnStreamRequest req)` This API is used to mix streams and relay the mixed stream to CDNs.
`StopPublishCdnStreamResponse`	`StopPublishCdnStream(StopPublishCdnStreamRequest req)` This API is used to stop a relaying task.
`UpdatePublishCdnStreamResponse`	`UpdatePublishCdnStream(UpdatePublishCdnStreamRequest req)` This API is used to change the parameters of a relaying task.

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
  - CreateCloudRecording
```
public CreateCloudRecordingResponse CreateCloudRecording(CreateCloudRecordingRequest req)
                                                  throws TencentCloudSDKException
```
    API description: This API is used to start an on-cloud recording task. It records the audio and video streams in a room and saves them to the specified cloud storage. You can use this API to record the streams in a room separately, or you can mix the streams first and then record the mixed stream. You can use this API to perform the following operations: Specify the anchors whose streams you want or do not want to record by using the `RecordParams` parameter Specify the storage service you want to save recording files to by using the `StorageParams` parameter Specify transcoding settings for mixed-stream recording, including video resolution, video bitrate, frame rate, and audio quality, by using `MixTranscodeParams` Specify the layout of different videos in mixed-stream recording mode or select an auto-arranged layout template Key concepts: Single-stream recording: Record the audio and video of each subscribed user (`UserId`) in a room and save the recording files to VOD. Mixed-stream recording: Mix the audios and videos of subscribed users (`UserId`) in a room, record the mixed stream, and save the recording files to VOD.
    
    Parameters:
    
    req - CreateCloudRecordingRequest
    
    Returns:
    
    CreateCloudRecordingResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteCloudRecording
```
public DeleteCloudRecordingResponse DeleteCloudRecording(DeleteCloudRecordingRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to stop a recording task. If a task is stopped successfully, but the uploading of recording files has not completed, the backend will continue to upload the files and will notify you via a callback when the upload is completed.
    
    Parameters:
    
    req - DeleteCloudRecordingRequest
    
    Returns:
    
    DeleteCloudRecordingResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCloudRecording
```
public DescribeCloudRecordingResponse DescribeCloudRecording(DescribeCloudRecordingRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to query the status of a recording task after it starts. It works only when a task is in progress. If the task has already ended when this API is called, an error will be returned. If a recording file is being uploaded to VOD, the response parameter `StorageFileList` will not contain the information of the recording file. Please listen for the recording file callback to get the information.
    
    Parameters:
    
    req - DescribeCloudRecordingRequest
    
    Returns:
    
    DescribeCloudRecordingResponse
    
    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
  - ModifyCloudRecording
```
public ModifyCloudRecordingResponse ModifyCloudRecording(ModifyCloudRecordingRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to modify a recording task. It works only when a task is in progress. If the task has already ended when this API is called, an error will be returned. You need to specify all the parameters for each request instead of just the ones you want to modify.
    
    Parameters:
    
    req - ModifyCloudRecordingRequest
    
    Returns:
    
    ModifyCloudRecordingResponse
    
    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
  - StartPublishCdnStream
```
public StartPublishCdnStreamResponse StartPublishCdnStream(StartPublishCdnStreamRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to mix streams and relay the mixed stream to CDNs. You can use this API to do the following: 1. Publish (also known as “relay”) the audio/video stream of one anchor to CDNs. For details, see example 2 (starting a task to relay the audio and video of a stream) and example 3 (starting a task to relay only the audio of a stream). 2. Mix the streams of multiple anchors in a room or in different rooms and publish the mixed stream to CDNs. You can use `AudioParams.SubscribeAudioList` to specify the users whose audios are mixed, and use `VideoParams.LayoutParams` to specify the layout of the anchors’ videos. For details, see example 1 (mixing streams and publishing the mixed stream to a CDN). 3. Mix multiple streams in a room according to a template and publish the mixed stream to CDNs. The TRTC backend will detect the change of anchors in the room and adjust the video layout automatically according to the stream mixing template. The following template types are supported: - 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 rows in the bottom-left corner in room entry sequence. The screen allows up to 4 rows of 4 small images, which float over the large main image. Up to 1 large image and 15 small images can be displayed. - Grid: The images of all users split the screen evenly. The more the users, the smaller the image dimensions. Up to 16 images are supported. - Screen sharing: This is designed for video conferencing and online education. The shared screen (or camera image of the anchor) is always displayed as the large main image, which occupies the left half of the screen, and the images of other users occupy the right half in up to two columns of up to eight small images each. Up to 1 large image and 15 small images can be displayed. If the upstream aspect ratio does not match the output, the large image on the left will be scaled and displayed in whole, while the small images on the right will be cropped. 4. Publish audio/video streams to up to 10 CDNs at a time. You can use `PublishCdnParams.PublishCdnUrl` to specify the URLs of the CDNs to publish to. To publish to Tencent Cloud’s CDN, set `PublishCdnParams.IsTencentCdn` to 1. 5. Configure a server-side callback to have Tencent Cloud send relay status updates to your server in the form of HTTP/HTTPS POST requests. To use the callback for relay events, please contact Technical Support. Notes: 1. **Because On-Cloud MixTranscoding is a paid feature, calling this API will incur MixTranscoding fees. For details, see [Billing of MixTranscoding and Relay to CDN](https://intl.cloud.tencent.com/document/product/647/47631?lang=en&pg=).** 2. **Relaying to third-party CDNs will incur relaying fees. For details, see [Billing of MixTranscoding and Relay to CDN](https://intl.cloud.tencent.com/document/product/647/47631?lang=en&pg=).** Others: 1. You need to first call `StartPublishCdnStream` to start a relay task and get the task ID before you can use the `UpdatePublishCdnStream` API to modify the task and `StopPublishCdnStream` to stop the task. 2. To ensure the stability of relaying, you cannot switch between relaying audio only, relaying audio and video, and relaying video only for the same task. 3. To ensure the stability of relaying, you cannot change the video codec, audio codec, audio sample rate, audio bitrate, or sound channels using the `UpdatePublishCdnStream` API. 4. When you relay a single stream, specify both `AudioParams` and `VideoParams` to publish both audio and video, and specify only `AudioParams` to publish audio only. You cannot switch between the two modes during the relaying process. For `VideoParams`, set `Width`, `Height`, `Fps`, `Bitrate`, and `Gop` according to the actual settings used for publishing. 5. The `SequenceNumber` parameter is required when you call `UpdatePublishCdnStream` to change the relaying parameters. It ensures that multiple requests for the same relaying task are in the correct order. The value of `SequenceNumber` increases each time a new request is made for the same task. If `InternalError` is returned, try again using the same `SequenceNumber`. You don’t need to handle the `FailedOperation.OutdateRequest` error. 6. You can create a relay task before anchors enter a room, in which case you need to manually call `StopPublishCdnStream` to stop the task. If you don’t, after all the users whose streams are mixed leave the room, the TRTC backend will wait for the timeout period (`AgentParams.MaxIdleTime`) to elapse before stopping the relaying task.
    
    Parameters:
    
    req - StartPublishCdnStreamRequest
    
    Returns:
    
    StartPublishCdnStreamResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopPublishCdnStream
```
public StopPublishCdnStreamResponse StopPublishCdnStream(StopPublishCdnStreamRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to stop a relaying task.
    
    Parameters:
    
    req - StopPublishCdnStreamRequest
    
    Returns:
    
    StopPublishCdnStreamResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdatePublishCdnStream
```
public UpdatePublishCdnStreamResponse UpdatePublishCdnStream(UpdatePublishCdnStreamRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to change the parameters of a relaying task.
    
    Parameters:
    
    req - UpdatePublishCdnStreamRequest
    
    Returns:
    
    UpdatePublishCdnStreamResponse
    
    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

CreateCloudRecording

DeleteCloudRecording

DescribeCloudRecording

DismissRoom

DismissRoomByStrRoomId

ModifyCloudRecording

RemoveUser

RemoveUserByStrRoomId

StartPublishCdnStream

StopPublishCdnStream

UpdatePublishCdnStream