TiwClient (tencentcloud-sdk-java 3.1.330 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.tiw.v20190919.TiwClient

public class TiwClient
extends AbstractClient

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateSnapshotTaskResponse`	`CreateSnapshotTask(CreateSnapshotTaskRequest req)` 创建白板板书生成任务, 在任务结束后，如果提供了回调地址，将通过回调地址通知板书生成结果
`CreateTranscodeResponse`	`CreateTranscode(CreateTranscodeRequest req)` 创建一个文档转码任务
`CreateVideoGenerationTaskResponse`	`CreateVideoGenerationTask(CreateVideoGenerationTaskRequest req)` 创建视频生成任务
`DescribeOnlineRecordResponse`	`DescribeOnlineRecord(DescribeOnlineRecordRequest req)` 查询录制任务状态与结果
`DescribeOnlineRecordCallbackResponse`	`DescribeOnlineRecordCallback(DescribeOnlineRecordCallbackRequest req)` 查询实时录制回调地址
`DescribeQualityMetricsResponse`	`DescribeQualityMetrics(DescribeQualityMetricsRequest req)` 查询互动白板质量数据
`DescribeSnapshotTaskResponse`	`DescribeSnapshotTask(DescribeSnapshotTaskRequest req)` 获取指定白板板书生成任务信息
`DescribeTranscodeResponse`	`DescribeTranscode(DescribeTranscodeRequest req)` 查询文档转码任务的执行进度与转码结果
`DescribeTranscodeCallbackResponse`	`DescribeTranscodeCallback(DescribeTranscodeCallbackRequest req)` 查询文档转码回调地址
`DescribeVideoGenerationTaskResponse`	`DescribeVideoGenerationTask(DescribeVideoGenerationTaskRequest req)` 查询录制视频生成任务状态与结果
`DescribeVideoGenerationTaskCallbackResponse`	`DescribeVideoGenerationTaskCallback(DescribeVideoGenerationTaskCallbackRequest req)` 查询录制视频生成回调地址
`DescribeWhiteboardPushResponse`	`DescribeWhiteboardPush(DescribeWhiteboardPushRequest req)` 查询推流任务状态与结果
`DescribeWhiteboardPushCallbackResponse`	`DescribeWhiteboardPushCallback(DescribeWhiteboardPushCallbackRequest req)` 查询白板推流回调地址
`PauseOnlineRecordResponse`	`PauseOnlineRecord(PauseOnlineRecordRequest req)` 暂停实时录制
`ResumeOnlineRecordResponse`	`ResumeOnlineRecord(ResumeOnlineRecordRequest req)` 恢复实时录制
`SetOnlineRecordCallbackResponse`	`SetOnlineRecordCallback(SetOnlineRecordCallbackRequest req)` 设置实时录制回调地址，回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40258
`SetOnlineRecordCallbackKeyResponse`	`SetOnlineRecordCallbackKey(SetOnlineRecordCallbackKeyRequest req)` 设置实时录制回调鉴权密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257
`SetTranscodeCallbackResponse`	`SetTranscodeCallback(SetTranscodeCallbackRequest req)` 设置文档转码回调地址，回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40260
`SetTranscodeCallbackKeyResponse`	`SetTranscodeCallbackKey(SetTranscodeCallbackKeyRequest req)` 设置文档转码回调鉴权密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257
`SetVideoGenerationTaskCallbackResponse`	`SetVideoGenerationTaskCallback(SetVideoGenerationTaskCallbackRequest req)` 设置录制视频生成回调地址
`SetVideoGenerationTaskCallbackKeyResponse`	`SetVideoGenerationTaskCallbackKey(SetVideoGenerationTaskCallbackKeyRequest req)` 设置视频生成回调鉴权密钥
`SetWhiteboardPushCallbackResponse`	`SetWhiteboardPushCallback(SetWhiteboardPushCallbackRequest req)` 设置白板推流回调地址，回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40257
`SetWhiteboardPushCallbackKeyResponse`	`SetWhiteboardPushCallbackKey(SetWhiteboardPushCallbackKeyRequest req)` 设置白板推流回调鉴权密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257
`StartOnlineRecordResponse`	`StartOnlineRecord(StartOnlineRecordRequest req)` 发起一个实时录制任务
`StartWhiteboardPushResponse`	`StartWhiteboardPush(StartWhiteboardPushRequest req)` 发起一个白板推流任务
`StopOnlineRecordResponse`	`StopOnlineRecord(StopOnlineRecordRequest req)` 停止实时录制
`StopWhiteboardPushResponse`	`StopWhiteboardPush(StopWhiteboardPushRequest req)` 停止白板推流任务

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, retry, setClientProfile, setCredential, setRegion

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

Constructor Detail

TiwClient

public TiwClient(Credential credential,
                 String region)

TiwClient

public TiwClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

CreateSnapshotTask
```
public CreateSnapshotTaskResponse CreateSnapshotTask(CreateSnapshotTaskRequest req)
                                              throws TencentCloudSDKException
```
创建白板板书生成任务, 在任务结束后，如果提供了回调地址，将通过回调地址通知板书生成结果

Parameters:

req - CreateSnapshotTaskRequest

Returns:

CreateSnapshotTaskResponse

Throws:

TencentCloudSDKException

CreateTranscode

public CreateTranscodeResponse CreateTranscode(CreateTranscodeRequest req)
                                        throws TencentCloudSDKException

创建一个文档转码任务

Parameters:: req - CreateTranscodeRequest
Returns:: CreateTranscodeResponse
Throws:: TencentCloudSDKException

CreateVideoGenerationTask

public CreateVideoGenerationTaskResponse CreateVideoGenerationTask(CreateVideoGenerationTaskRequest req)
                                                            throws TencentCloudSDKException

创建视频生成任务

Parameters:: req - CreateVideoGenerationTaskRequest
Returns:: CreateVideoGenerationTaskResponse
Throws:: TencentCloudSDKException

DescribeOnlineRecord

public DescribeOnlineRecordResponse DescribeOnlineRecord(DescribeOnlineRecordRequest req)
                                                  throws TencentCloudSDKException

查询录制任务状态与结果

Parameters:: req - DescribeOnlineRecordRequest
Returns:: DescribeOnlineRecordResponse
Throws:: TencentCloudSDKException

DescribeOnlineRecordCallback

public DescribeOnlineRecordCallbackResponse DescribeOnlineRecordCallback(DescribeOnlineRecordCallbackRequest req)
                                                                  throws TencentCloudSDKException

查询实时录制回调地址

Parameters:: req - DescribeOnlineRecordCallbackRequest
Returns:: DescribeOnlineRecordCallbackResponse
Throws:: TencentCloudSDKException

DescribeQualityMetrics

public DescribeQualityMetricsResponse DescribeQualityMetrics(DescribeQualityMetricsRequest req)
                                                      throws TencentCloudSDKException

查询互动白板质量数据

Parameters:: req - DescribeQualityMetricsRequest
Returns:: DescribeQualityMetricsResponse
Throws:: TencentCloudSDKException

DescribeSnapshotTask

public DescribeSnapshotTaskResponse DescribeSnapshotTask(DescribeSnapshotTaskRequest req)
                                                  throws TencentCloudSDKException

获取指定白板板书生成任务信息

Parameters:: req - DescribeSnapshotTaskRequest
Returns:: DescribeSnapshotTaskResponse
Throws:: TencentCloudSDKException

DescribeTranscode
```
public DescribeTranscodeResponse DescribeTranscode(DescribeTranscodeRequest req)
                                            throws TencentCloudSDKException
```
查询文档转码任务的执行进度与转码结果

Parameters:

req - DescribeTranscodeRequest

Returns:

DescribeTranscodeResponse

Throws:

TencentCloudSDKException

DescribeTranscodeCallback

public DescribeTranscodeCallbackResponse DescribeTranscodeCallback(DescribeTranscodeCallbackRequest req)
                                                            throws TencentCloudSDKException

查询文档转码回调地址

Parameters:: req - DescribeTranscodeCallbackRequest
Returns:: DescribeTranscodeCallbackResponse
Throws:: TencentCloudSDKException

DescribeVideoGenerationTask

public DescribeVideoGenerationTaskResponse DescribeVideoGenerationTask(DescribeVideoGenerationTaskRequest req)
                                                                throws TencentCloudSDKException

查询录制视频生成任务状态与结果

Parameters:: req - DescribeVideoGenerationTaskRequest
Returns:: DescribeVideoGenerationTaskResponse
Throws:: TencentCloudSDKException

DescribeVideoGenerationTaskCallback

public DescribeVideoGenerationTaskCallbackResponse DescribeVideoGenerationTaskCallback(DescribeVideoGenerationTaskCallbackRequest req)
                                                                                throws TencentCloudSDKException

查询录制视频生成回调地址

Parameters:: req - DescribeVideoGenerationTaskCallbackRequest
Returns:: DescribeVideoGenerationTaskCallbackResponse
Throws:: TencentCloudSDKException

DescribeWhiteboardPush

public DescribeWhiteboardPushResponse DescribeWhiteboardPush(DescribeWhiteboardPushRequest req)
                                                      throws TencentCloudSDKException

查询推流任务状态与结果

Parameters:: req - DescribeWhiteboardPushRequest
Returns:: DescribeWhiteboardPushResponse
Throws:: TencentCloudSDKException

DescribeWhiteboardPushCallback

public DescribeWhiteboardPushCallbackResponse DescribeWhiteboardPushCallback(DescribeWhiteboardPushCallbackRequest req)
                                                                      throws TencentCloudSDKException

查询白板推流回调地址

Parameters:: req - DescribeWhiteboardPushCallbackRequest
Returns:: DescribeWhiteboardPushCallbackResponse
Throws:: TencentCloudSDKException

PauseOnlineRecord

public PauseOnlineRecordResponse PauseOnlineRecord(PauseOnlineRecordRequest req)
                                            throws TencentCloudSDKException

暂停实时录制

Parameters:: req - PauseOnlineRecordRequest
Returns:: PauseOnlineRecordResponse
Throws:: TencentCloudSDKException

ResumeOnlineRecord

public ResumeOnlineRecordResponse ResumeOnlineRecord(ResumeOnlineRecordRequest req)
                                              throws TencentCloudSDKException

恢复实时录制

Parameters:: req - ResumeOnlineRecordRequest
Returns:: ResumeOnlineRecordResponse
Throws:: TencentCloudSDKException

SetOnlineRecordCallback
```
public SetOnlineRecordCallbackResponse SetOnlineRecordCallback(SetOnlineRecordCallbackRequest req)
                                                        throws TencentCloudSDKException
```
设置实时录制回调地址，回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40258

Parameters:

req - SetOnlineRecordCallbackRequest

Returns:

SetOnlineRecordCallbackResponse

Throws:

TencentCloudSDKException

SetOnlineRecordCallbackKey
```
public SetOnlineRecordCallbackKeyResponse SetOnlineRecordCallbackKey(SetOnlineRecordCallbackKeyRequest req)
                                                              throws TencentCloudSDKException
```
设置实时录制回调鉴权密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257

Parameters:

req - SetOnlineRecordCallbackKeyRequest

Returns:

SetOnlineRecordCallbackKeyResponse

Throws:

TencentCloudSDKException

SetTranscodeCallback
```
public SetTranscodeCallbackResponse SetTranscodeCallback(SetTranscodeCallbackRequest req)
                                                  throws TencentCloudSDKException
```
设置文档转码回调地址，回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40260

Parameters:

req - SetTranscodeCallbackRequest

Returns:

SetTranscodeCallbackResponse

Throws:

TencentCloudSDKException

SetTranscodeCallbackKey
```
public SetTranscodeCallbackKeyResponse SetTranscodeCallbackKey(SetTranscodeCallbackKeyRequest req)
                                                        throws TencentCloudSDKException
```
设置文档转码回调鉴权密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257

Parameters:

req - SetTranscodeCallbackKeyRequest

Returns:

SetTranscodeCallbackKeyResponse

Throws:

TencentCloudSDKException

SetVideoGenerationTaskCallback

public SetVideoGenerationTaskCallbackResponse SetVideoGenerationTaskCallback(SetVideoGenerationTaskCallbackRequest req)
                                                                      throws TencentCloudSDKException

设置录制视频生成回调地址

Parameters:: req - SetVideoGenerationTaskCallbackRequest
Returns:: SetVideoGenerationTaskCallbackResponse
Throws:: TencentCloudSDKException

SetVideoGenerationTaskCallbackKey

public SetVideoGenerationTaskCallbackKeyResponse SetVideoGenerationTaskCallbackKey(SetVideoGenerationTaskCallbackKeyRequest req)
                                                                            throws TencentCloudSDKException

设置视频生成回调鉴权密钥

Parameters:: req - SetVideoGenerationTaskCallbackKeyRequest
Returns:: SetVideoGenerationTaskCallbackKeyResponse
Throws:: TencentCloudSDKException

SetWhiteboardPushCallback
```
public SetWhiteboardPushCallbackResponse SetWhiteboardPushCallback(SetWhiteboardPushCallbackRequest req)
                                                            throws TencentCloudSDKException
```
设置白板推流回调地址，回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40257

Parameters:

req - SetWhiteboardPushCallbackRequest

Returns:

SetWhiteboardPushCallbackResponse

Throws:

TencentCloudSDKException

SetWhiteboardPushCallbackKey
```
public SetWhiteboardPushCallbackKeyResponse SetWhiteboardPushCallbackKey(SetWhiteboardPushCallbackKeyRequest req)
                                                                  throws TencentCloudSDKException
```
设置白板推流回调鉴权密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257

Parameters:

req - SetWhiteboardPushCallbackKeyRequest

Returns:

SetWhiteboardPushCallbackKeyResponse

Throws:

TencentCloudSDKException

StartOnlineRecord

public StartOnlineRecordResponse StartOnlineRecord(StartOnlineRecordRequest req)
                                            throws TencentCloudSDKException

发起一个实时录制任务

Parameters:: req - StartOnlineRecordRequest
Returns:: StartOnlineRecordResponse
Throws:: TencentCloudSDKException

StartWhiteboardPush

public StartWhiteboardPushResponse StartWhiteboardPush(StartWhiteboardPushRequest req)
                                                throws TencentCloudSDKException

发起一个白板推流任务

Parameters:: req - StartWhiteboardPushRequest
Returns:: StartWhiteboardPushResponse
Throws:: TencentCloudSDKException

StopOnlineRecord

public StopOnlineRecordResponse StopOnlineRecord(StopOnlineRecordRequest req)
                                          throws TencentCloudSDKException

停止实时录制

Parameters:: req - StopOnlineRecordRequest
Returns:: StopOnlineRecordResponse
Throws:: TencentCloudSDKException

StopWhiteboardPush

public StopWhiteboardPushResponse StopWhiteboardPush(StopWhiteboardPushRequest req)
                                              throws TencentCloudSDKException

停止白板推流任务

Parameters:: req - StopWhiteboardPushRequest
Returns:: StopWhiteboardPushResponse
Throws:: TencentCloudSDKException

Class TiwClient

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

TiwClient

TiwClient

Method Detail

CreateSnapshotTask

CreateTranscode

CreateVideoGenerationTask

DescribeOnlineRecord

DescribeOnlineRecordCallback

DescribeQualityMetrics

DescribeSnapshotTask

DescribeTranscode

DescribeTranscodeCallback

DescribeVideoGenerationTask

DescribeVideoGenerationTaskCallback

DescribeWhiteboardPush

DescribeWhiteboardPushCallback

PauseOnlineRecord

ResumeOnlineRecord

SetOnlineRecordCallback

SetOnlineRecordCallbackKey

SetTranscodeCallback

SetTranscodeCallbackKey

SetVideoGenerationTaskCallback

SetVideoGenerationTaskCallbackKey

SetWhiteboardPushCallback

SetWhiteboardPushCallbackKey

StartOnlineRecord

StartWhiteboardPush

StopOnlineRecord

StopWhiteboardPush