TrroClient (tencentcloud-sdk-java 3.1.1355 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.trro.v20220325.TrroClient

public class TrroClient
extends AbstractClient

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchDeleteDevicesResponse`	`BatchDeleteDevices(BatchDeleteDevicesRequest req)` 用于批量删除设备
`BatchDeletePolicyResponse`	`BatchDeletePolicy(BatchDeletePolicyRequest req)` 用于批量删除修改权限配置
`BoundLicensesResponse`	`BoundLicenses(BoundLicensesRequest req)` 为推流设备绑定license，优先绑定到期时间最近的，到期时间相同优先绑定月包
`CreateCloudRecordingResponse`	`CreateCloudRecording(CreateCloudRecordingRequest req)` 启动云端录制功能，完成房间内的音视频录制，并上传到指定的云存储。
`CreateDeviceResponse`	`CreateDevice(CreateDeviceRequest req)` 用于创建设备
`CreateProjectResponse`	`CreateProject(CreateProjectRequest req)` 用于创建项目
`DeleteCloudRecordingResponse`	`DeleteCloudRecording(DeleteCloudRecordingRequest req)` 成功开启录制后，可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成，如果未完成后台将会继续上传文件，成功后通过事件回调通知客户文件全部传输完成状态。
`DeleteProjectResponse`	`DeleteProject(DeleteProjectRequest req)` 用于删除项目
`DescribeDeviceInfoResponse`	`DescribeDeviceInfo(DescribeDeviceInfoRequest req)` 用于获取指定设备信息
`DescribeDeviceListResponse`	`DescribeDeviceList(DescribeDeviceListRequest req)` 用于获取设备信息列表
`DescribeDeviceSessionDetailsResponse`	`DescribeDeviceSessionDetails(DescribeDeviceSessionDetailsRequest req)` 获取设备会话数据详单
`DescribeDeviceSessionListResponse`	`DescribeDeviceSessionList(DescribeDeviceSessionListRequest req)` 获取设备会话列表
`DescribePolicyResponse`	`DescribePolicy(DescribePolicyRequest req)` 用于查看权限配置
`DescribeProjectInfoResponse`	`DescribeProjectInfo(DescribeProjectInfoRequest req)` 用于获取项目信息
`DescribeProjectListResponse`	`DescribeProjectList(DescribeProjectListRequest req)` 用于获取项目列表
`DescribeRecentSessionListResponse`	`DescribeRecentSessionList(DescribeRecentSessionListRequest req)` 获取最新设备会话列表
`DescribeSessionStatisticsResponse`	`DescribeSessionStatistics(DescribeSessionStatisticsRequest req)` 获取会话统计值
`DescribeSessionStatisticsByIntervalResponse`	`DescribeSessionStatisticsByInterval(DescribeSessionStatisticsByIntervalRequest req)` 获取各时间段的会话统计值
`GetDeviceLicenseResponse`	`GetDeviceLicense(GetDeviceLicenseRequest req)` 获取设备已经绑定的可用授权数量
`GetDevicesResponse`	`GetDevices(GetDevicesRequest req)` 查询用户设备的授权绑定情况
`GetLicensesResponse`	`GetLicenses(GetLicensesRequest req)` 按授权查看license列表
`GetLicenseStatResponse`	`GetLicenseStat(GetLicenseStatRequest req)` 统计license类型数量
`ModifyCallbackUrlResponse`	`ModifyCallbackUrl(ModifyCallbackUrlRequest req)` 设置回调URL 录制回调事件内容参考：https://cloud.tencent.com/document/product/647/81113 转推回调事件内容参考：https://cloud.tencent.com/document/product/647/88552
`ModifyDeviceResponse`	`ModifyDevice(ModifyDeviceRequest req)` 用于修改设备信息
`ModifyPolicyResponse`	`ModifyPolicy(ModifyPolicyRequest req)` 用于修改权限配置
`ModifyProjectResponse`	`ModifyProject(ModifyProjectRequest req)` 用于修改项目信息
`ModifyProjectSecModeResponse`	`ModifyProjectSecMode(ModifyProjectSecModeRequest req)` 使用项目共享密钥可动态生成设备登录密钥，登录前无需对设备进行提前注册，适合希望简化业务流程的客户。由于是公共密钥，请务必注意保护项目共享密钥，并及时更新。建议项目共享密钥保存在服务器侧。由服务器生成设备登录密码下发给设备，避免密钥保存在客户端侧产生的密钥泄露风险。开启项目共享密钥后，对于已注册的设备，仍可使用原设备密码登录。若希望仅能通过共享密钥生成密码登录，请通过云 API 将设备密码更新为"USEPROJECTKEYPWD"。
`StartPublishLiveStreamResponse`	`StartPublishLiveStream(StartPublishLiveStreamRequest req)` 启动一个混流转推任务，将 TRTC 房间的多路音视频流混成一路音视频流，编码后推到直播 CDN 或者回推到 TRTC 房间。也支持不转码直接转推 TRTC 房间的单路流。启动成功后，会返回一个 SdkAppid 维度唯一的任务 Id（TaskId）。您需要保存该 TaskId，后续需要依赖此 TaskId 更新和结束任务。
`StopPublishLiveStreamResponse`	`StopPublishLiveStream(StopPublishLiveStreamRequest req)` 停止指定的混流转推任务。如果没有调用 Stop 接口停止任务，所有参与混流转推的主播离开房间超过MaxIdleTime 设置的时间后，任务也会自动停止。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

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

- Constructor Detail
  - TrroClient
```
public TrroClient(Credential credential,
                  String region)
```
  - TrroClient
```
public TrroClient(Credential credential,
                  String region,
                  ClientProfile profile)
```
- Method Detail
  - BatchDeleteDevices
```
public BatchDeleteDevicesResponse BatchDeleteDevices(BatchDeleteDevicesRequest req)
                                              throws TencentCloudSDKException
```
    用于批量删除设备
    
    Parameters:
    
    req - BatchDeleteDevicesRequest
    
    Returns:
    
    BatchDeleteDevicesResponse
    
    Throws:
    
    TencentCloudSDKException
  - BatchDeletePolicy
```
public BatchDeletePolicyResponse BatchDeletePolicy(BatchDeletePolicyRequest req)
                                            throws TencentCloudSDKException
```
    用于批量删除修改权限配置
    
    Parameters:
    
    req - BatchDeletePolicyRequest
    
    Returns:
    
    BatchDeletePolicyResponse
    
    Throws:
    
    TencentCloudSDKException
  - BoundLicenses
```
public BoundLicensesResponse BoundLicenses(BoundLicensesRequest req)
                                    throws TencentCloudSDKException
```
    为推流设备绑定license，优先绑定到期时间最近的，到期时间相同优先绑定月包
    
    Parameters:
    
    req - BoundLicensesRequest
    
    Returns:
    
    BoundLicensesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateCloudRecording
```
public CreateCloudRecordingResponse CreateCloudRecording(CreateCloudRecordingRequest req)
                                                  throws TencentCloudSDKException
```
    启动云端录制功能，完成房间内的音视频录制，并上传到指定的云存储。
    
    Parameters:
    
    req - CreateCloudRecordingRequest
    
    Returns:
    
    CreateCloudRecordingResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateDevice
```
public CreateDeviceResponse CreateDevice(CreateDeviceRequest req)
                                  throws TencentCloudSDKException
```
    用于创建设备
    
    Parameters:
    
    req - CreateDeviceRequest
    
    Returns:
    
    CreateDeviceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateProject
```
public CreateProjectResponse CreateProject(CreateProjectRequest req)
                                    throws TencentCloudSDKException
```
    用于创建项目
    
    Parameters:
    
    req - CreateProjectRequest
    
    Returns:
    
    CreateProjectResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteCloudRecording
```
public DeleteCloudRecordingResponse DeleteCloudRecording(DeleteCloudRecordingRequest req)
                                                  throws TencentCloudSDKException
```
    成功开启录制后，可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成，如果未完成后台将会继续上传文件，成功后通过事件回调通知客户文件全部传输完成状态。
    
    Parameters:
    
    req - DeleteCloudRecordingRequest
    
    Returns:
    
    DeleteCloudRecordingResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteProject
```
public DeleteProjectResponse DeleteProject(DeleteProjectRequest req)
                                    throws TencentCloudSDKException
```
    用于删除项目
    
    Parameters:
    
    req - DeleteProjectRequest
    
    Returns:
    
    DeleteProjectResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDeviceInfo
```
public DescribeDeviceInfoResponse DescribeDeviceInfo(DescribeDeviceInfoRequest req)
                                              throws TencentCloudSDKException
```
    用于获取指定设备信息
    
    Parameters:
    
    req - DescribeDeviceInfoRequest
    
    Returns:
    
    DescribeDeviceInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDeviceList
```
public DescribeDeviceListResponse DescribeDeviceList(DescribeDeviceListRequest req)
                                              throws TencentCloudSDKException
```
    用于获取设备信息列表
    
    Parameters:
    
    req - DescribeDeviceListRequest
    
    Returns:
    
    DescribeDeviceListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDeviceSessionDetails
```
public DescribeDeviceSessionDetailsResponse DescribeDeviceSessionDetails(DescribeDeviceSessionDetailsRequest req)
                                                                  throws TencentCloudSDKException
```
    获取设备会话数据详单
    
    Parameters:
    
    req - DescribeDeviceSessionDetailsRequest
    
    Returns:
    
    DescribeDeviceSessionDetailsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDeviceSessionList
```
public DescribeDeviceSessionListResponse DescribeDeviceSessionList(DescribeDeviceSessionListRequest req)
                                                            throws TencentCloudSDKException
```
    获取设备会话列表
    
    Parameters:
    
    req - DescribeDeviceSessionListRequest
    
    Returns:
    
    DescribeDeviceSessionListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePolicy
```
public DescribePolicyResponse DescribePolicy(DescribePolicyRequest req)
                                      throws TencentCloudSDKException
```
    用于查看权限配置
    
    Parameters:
    
    req - DescribePolicyRequest
    
    Returns:
    
    DescribePolicyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeProjectInfo
```
public DescribeProjectInfoResponse DescribeProjectInfo(DescribeProjectInfoRequest req)
                                                throws TencentCloudSDKException
```
    用于获取项目信息
    
    Parameters:
    
    req - DescribeProjectInfoRequest
    
    Returns:
    
    DescribeProjectInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeProjectList
```
public DescribeProjectListResponse DescribeProjectList(DescribeProjectListRequest req)
                                                throws TencentCloudSDKException
```
    用于获取项目列表
    
    Parameters:
    
    req - DescribeProjectListRequest
    
    Returns:
    
    DescribeProjectListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRecentSessionList
```
public DescribeRecentSessionListResponse DescribeRecentSessionList(DescribeRecentSessionListRequest req)
                                                            throws TencentCloudSDKException
```
    获取最新设备会话列表
    
    Parameters:
    
    req - DescribeRecentSessionListRequest
    
    Returns:
    
    DescribeRecentSessionListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSessionStatistics
```
public DescribeSessionStatisticsResponse DescribeSessionStatistics(DescribeSessionStatisticsRequest req)
                                                            throws TencentCloudSDKException
```
    获取会话统计值
    
    Parameters:
    
    req - DescribeSessionStatisticsRequest
    
    Returns:
    
    DescribeSessionStatisticsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSessionStatisticsByInterval
```
public DescribeSessionStatisticsByIntervalResponse DescribeSessionStatisticsByInterval(DescribeSessionStatisticsByIntervalRequest req)
                                                                                throws TencentCloudSDKException
```
    获取各时间段的会话统计值
    
    Parameters:
    
    req - DescribeSessionStatisticsByIntervalRequest
    
    Returns:
    
    DescribeSessionStatisticsByIntervalResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetDeviceLicense
```
public GetDeviceLicenseResponse GetDeviceLicense(GetDeviceLicenseRequest req)
                                          throws TencentCloudSDKException
```
    获取设备已经绑定的可用授权数量
    
    Parameters:
    
    req - GetDeviceLicenseRequest
    
    Returns:
    
    GetDeviceLicenseResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetDevices
```
public GetDevicesResponse GetDevices(GetDevicesRequest req)
                              throws TencentCloudSDKException
```
    查询用户设备的授权绑定情况
    
    Parameters:
    
    req - GetDevicesRequest
    
    Returns:
    
    GetDevicesResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetLicenseStat
```
public GetLicenseStatResponse GetLicenseStat(GetLicenseStatRequest req)
                                      throws TencentCloudSDKException
```
    统计license类型数量
    
    Parameters:
    
    req - GetLicenseStatRequest
    
    Returns:
    
    GetLicenseStatResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetLicenses
```
public GetLicensesResponse GetLicenses(GetLicensesRequest req)
                                throws TencentCloudSDKException
```
    按授权查看license列表
    
    Parameters:
    
    req - GetLicensesRequest
    
    Returns:
    
    GetLicensesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyCallbackUrl
```
public ModifyCallbackUrlResponse ModifyCallbackUrl(ModifyCallbackUrlRequest req)
                                            throws TencentCloudSDKException
```
    设置回调URL 录制回调事件内容参考：https://cloud.tencent.com/document/product/647/81113 转推回调事件内容参考：https://cloud.tencent.com/document/product/647/88552
    
    Parameters:
    
    req - ModifyCallbackUrlRequest
    
    Returns:
    
    ModifyCallbackUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyDevice
```
public ModifyDeviceResponse ModifyDevice(ModifyDeviceRequest req)
                                  throws TencentCloudSDKException
```
    用于修改设备信息
    
    Parameters:
    
    req - ModifyDeviceRequest
    
    Returns:
    
    ModifyDeviceResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPolicy
```
public ModifyPolicyResponse ModifyPolicy(ModifyPolicyRequest req)
                                  throws TencentCloudSDKException
```
    用于修改权限配置
    
    Parameters:
    
    req - ModifyPolicyRequest
    
    Returns:
    
    ModifyPolicyResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyProject
```
public ModifyProjectResponse ModifyProject(ModifyProjectRequest req)
                                    throws TencentCloudSDKException
```
    用于修改项目信息
    
    Parameters:
    
    req - ModifyProjectRequest
    
    Returns:
    
    ModifyProjectResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyProjectSecMode
```
public ModifyProjectSecModeResponse ModifyProjectSecMode(ModifyProjectSecModeRequest req)
                                                  throws TencentCloudSDKException
```
    使用项目共享密钥可动态生成设备登录密钥，登录前无需对设备进行提前注册，适合希望简化业务流程的客户。由于是公共密钥，请务必注意保护项目共享密钥，并及时更新。建议项目共享密钥保存在服务器侧。由服务器生成设备登录密码下发给设备，避免密钥保存在客户端侧产生的密钥泄露风险。开启项目共享密钥后，对于已注册的设备，仍可使用原设备密码登录。若希望仅能通过共享密钥生成密码登录，请通过云 API 将设备密码更新为"USEPROJECTKEYPWD"。
    
    Parameters:
    
    req - ModifyProjectSecModeRequest
    
    Returns:
    
    ModifyProjectSecModeResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartPublishLiveStream
```
public StartPublishLiveStreamResponse StartPublishLiveStream(StartPublishLiveStreamRequest req)
                                                      throws TencentCloudSDKException
```
    启动一个混流转推任务，将 TRTC 房间的多路音视频流混成一路音视频流，编码后推到直播 CDN 或者回推到 TRTC 房间。也支持不转码直接转推 TRTC 房间的单路流。启动成功后，会返回一个 SdkAppid 维度唯一的任务 Id（TaskId）。您需要保存该 TaskId，后续需要依赖此 TaskId 更新和结束任务。
    
    Parameters:
    
    req - StartPublishLiveStreamRequest
    
    Returns:
    
    StartPublishLiveStreamResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopPublishLiveStream
```
public StopPublishLiveStreamResponse StopPublishLiveStream(StopPublishLiveStreamRequest req)
                                                    throws TencentCloudSDKException
```
    停止指定的混流转推任务。如果没有调用 Stop 接口停止任务，所有参与混流转推的主播离开房间超过MaxIdleTime 设置的时间后，任务也会自动停止。
    
    Parameters:
    
    req - StopPublishLiveStreamRequest
    
    Returns:
    
    StopPublishLiveStreamResponse
    
    Throws:
    
    TencentCloudSDKException

Class TrroClient

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

TrroClient

TrroClient

Method Detail

BatchDeleteDevices

BatchDeletePolicy

BoundLicenses

CreateCloudRecording

CreateDevice

CreateProject

DeleteCloudRecording

DeleteProject

DescribeDeviceInfo

DescribeDeviceList

DescribeDeviceSessionDetails

DescribeDeviceSessionList

DescribePolicy

DescribeProjectInfo

DescribeProjectList

DescribeRecentSessionList

DescribeSessionStatistics

DescribeSessionStatisticsByInterval

GetDeviceLicense

GetDevices

GetLicenseStat

GetLicenses

ModifyCallbackUrl

ModifyDevice

ModifyPolicy

ModifyProject

ModifyProjectSecMode

StartPublishLiveStream

StopPublishLiveStream