LiveClient (tencentcloud-sdk-java 3.0.37 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.live.v20180801.LiveClient

public class LiveClient
extends AbstractClient

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

Constructor Summary

Constructors
Constructor and Description
`LiveClient(Credential credential, String region)` 构造client
`LiveClient(Credential credential, String region, ClientProfile profile)` 构造client

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddDelayLiveStreamResponse`	`AddDelayLiveStream(AddDelayLiveStreamRequest req)` 对流设置延播
`AddLiveWatermarkResponse`	`AddLiveWatermark(AddLiveWatermarkRequest req)` 添加水印
`CreateLiveRecordResponse`	`CreateLiveRecord(CreateLiveRecordRequest req)` - 使用前提 1.
`CreatePullStreamConfigResponse`	`CreatePullStreamConfig(CreatePullStreamConfigRequest req)` 添加拉流配置，目前限制添加10条任务。
`DeleteLiveRecordResponse`	`DeleteLiveRecord(DeleteLiveRecordRequest req)` 用于删除录制任务
`DeleteLiveWatermarkResponse`	`DeleteLiveWatermark(DeleteLiveWatermarkRequest req)` 删除水印
`DescribeLivePlayAuthKeyResponse`	`DescribeLivePlayAuthKey(DescribeLivePlayAuthKeyRequest req)` 查询播放鉴权key
`DescribeLivePushAuthKeyResponse`	`DescribeLivePushAuthKey(DescribeLivePushAuthKeyRequest req)` 查询直播推流鉴权key
`DescribeLiveStreamOnlineInfoResponse`	`DescribeLiveStreamOnlineInfo(DescribeLiveStreamOnlineInfoRequest req)` 查询在线推流信息列表
`DescribeLiveStreamOnlineListResponse`	`DescribeLiveStreamOnlineList(DescribeLiveStreamOnlineListRequest req)` 返回正在直播中的流列表
`DescribeLiveStreamPublishedListResponse`	`DescribeLiveStreamPublishedList(DescribeLiveStreamPublishedListRequest req)` 返回已经推过流的流列表
`DescribeLiveStreamStateResponse`	`DescribeLiveStreamState(DescribeLiveStreamStateRequest req)` 返回直播中、无推流或者禁播等状态
`DescribeLiveWatermarksResponse`	`DescribeLiveWatermarks(DescribeLiveWatermarksRequest req)` 查询水印列表
`DescribePullStreamConfigsResponse`	`DescribePullStreamConfigs(DescribePullStreamConfigsRequest req)` 查询拉流配置
`DropLiveStreamResponse`	`DropLiveStream(DropLiveStreamRequest req)` 断开推流连接，但可以重新推流
`ForbidLiveStreamResponse`	`ForbidLiveStream(ForbidLiveStreamRequest req)` 禁止某条流的推送，可以预设某个时刻将流恢复。
`ModifyLivePlayAuthKeyResponse`	`ModifyLivePlayAuthKey(ModifyLivePlayAuthKeyRequest req)` 修改播放鉴权key
`ModifyLivePushAuthKeyResponse`	`ModifyLivePushAuthKey(ModifyLivePushAuthKeyRequest req)` 修改直播推流鉴权key
`ModifyPullStreamConfigResponse`	`ModifyPullStreamConfig(ModifyPullStreamConfigRequest req)` 更新拉流配置
`ModifyPullStreamStatusResponse`	`ModifyPullStreamStatus(ModifyPullStreamStatusRequest req)` 修改直播拉流配置状态
`ResumeDelayLiveStreamResponse`	`ResumeDelayLiveStream(ResumeDelayLiveStreamRequest req)` 恢复延迟播放设置
`ResumeLiveStreamResponse`	`ResumeLiveStream(ResumeLiveStreamRequest req)` 恢复某条流的推送。
`SetLiveWatermarkStatusResponse`	`SetLiveWatermarkStatus(SetLiveWatermarkStatusRequest req)` 设置水印是否启用
`StopLiveRecordResponse`	`StopLiveRecord(StopLiveRecordRequest req)` 说明：录制后的文件存放于点播平台。用户如需使用录制功能，需首先自行开通点播账号并确保账号可用。录制文件存放后，相关费用（含存储以及下行播放流量）按照点播平台计费方式收取，请参考对应文档。
`UpdateLiveWatermarkResponse`	`UpdateLiveWatermark(UpdateLiveWatermarkRequest req)` 更新水印

Methods inherited from class com.tencentcloudapi.common.AbstractClient
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
  - LiveClient
```
public LiveClient(Credential credential,
                  String region)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
  - LiveClient
```
public LiveClient(Credential credential,
                  String region,
                  ClientProfile profile)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
    
    profile - 配置实例
- Method Detail
  - AddDelayLiveStream
```
public AddDelayLiveStreamResponse AddDelayLiveStream(AddDelayLiveStreamRequest req)
                                              throws TencentCloudSDKException
```
    对流设置延播
    
    Parameters:
    
    req - AddDelayLiveStreamRequest
    
    Returns:
    
    AddDelayLiveStreamResponse
    
    Throws:
    
    TencentCloudSDKException
  - AddLiveWatermark
```
public AddLiveWatermarkResponse AddLiveWatermark(AddLiveWatermarkRequest req)
                                          throws TencentCloudSDKException
```
    添加水印
    
    Parameters:
    
    req - AddLiveWatermarkRequest
    
    Returns:
    
    AddLiveWatermarkResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateLiveRecord
```
public CreateLiveRecordResponse CreateLiveRecord(CreateLiveRecordRequest req)
                                          throws TencentCloudSDKException
```
    - 使用前提 1. 录制文件存放于点播平台，所以用户如需使用录制功能，需首先自行开通点播服务。 2. 录制文件存放后相关费用（含存储以及下行播放流量）按照点播平台计费方式收取，具体请参考 [对应文档](https://cloud.tencent.com/document/product/266/2838)。 - 模式说明该接口支持两种录制模式： 1. 定时录制模式。需要传入开始时间与结束时间，录制任务根据时间自动开始与结束。 2. 实时视频录制模式。忽略传入的开始时间，在录制任务创建后立即开始录制，录制时长支持最大为30分钟，如果传入的结束时间与当前时间差大于30分钟，则按30分钟计算，实时视频录制主要用于录制精彩视频场景，时长建议控制在5分钟以内。 - 注意事项 1. 调用接口超时设置应大于3秒，小于3秒重试以及频繁调用都有可能产生重复录制任务。
    
    Parameters:
    
    req - CreateLiveRecordRequest
    
    Returns:
    
    CreateLiveRecordResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreatePullStreamConfig
```
public CreatePullStreamConfigResponse CreatePullStreamConfig(CreatePullStreamConfigRequest req)
                                                      throws TencentCloudSDKException
```
    添加拉流配置，目前限制添加10条任务。
    
    Parameters:
    
    req - CreatePullStreamConfigRequest
    
    Returns:
    
    CreatePullStreamConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteLiveRecord
```
public DeleteLiveRecordResponse DeleteLiveRecord(DeleteLiveRecordRequest req)
                                          throws TencentCloudSDKException
```
    用于删除录制任务
    
    Parameters:
    
    req - DeleteLiveRecordRequest
    
    Returns:
    
    DeleteLiveRecordResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteLiveWatermark
```
public DeleteLiveWatermarkResponse DeleteLiveWatermark(DeleteLiveWatermarkRequest req)
                                                throws TencentCloudSDKException
```
    删除水印
    
    Parameters:
    
    req - DeleteLiveWatermarkRequest
    
    Returns:
    
    DeleteLiveWatermarkResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLivePlayAuthKey
```
public DescribeLivePlayAuthKeyResponse DescribeLivePlayAuthKey(DescribeLivePlayAuthKeyRequest req)
                                                        throws TencentCloudSDKException
```
    查询播放鉴权key
    
    Parameters:
    
    req - DescribeLivePlayAuthKeyRequest
    
    Returns:
    
    DescribeLivePlayAuthKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLivePushAuthKey
```
public DescribeLivePushAuthKeyResponse DescribeLivePushAuthKey(DescribeLivePushAuthKeyRequest req)
                                                        throws TencentCloudSDKException
```
    查询直播推流鉴权key
    
    Parameters:
    
    req - DescribeLivePushAuthKeyRequest
    
    Returns:
    
    DescribeLivePushAuthKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLiveStreamOnlineInfo
```
public DescribeLiveStreamOnlineInfoResponse DescribeLiveStreamOnlineInfo(DescribeLiveStreamOnlineInfoRequest req)
                                                                  throws TencentCloudSDKException
```
    查询在线推流信息列表
    
    Parameters:
    
    req - DescribeLiveStreamOnlineInfoRequest
    
    Returns:
    
    DescribeLiveStreamOnlineInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLiveStreamOnlineList
```
public DescribeLiveStreamOnlineListResponse DescribeLiveStreamOnlineList(DescribeLiveStreamOnlineListRequest req)
                                                                  throws TencentCloudSDKException
```
    返回正在直播中的流列表
    
    Parameters:
    
    req - DescribeLiveStreamOnlineListRequest
    
    Returns:
    
    DescribeLiveStreamOnlineListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLiveStreamPublishedList
```
public DescribeLiveStreamPublishedListResponse DescribeLiveStreamPublishedList(DescribeLiveStreamPublishedListRequest req)
                                                                        throws TencentCloudSDKException
```
    返回已经推过流的流列表
    
    Parameters:
    
    req - DescribeLiveStreamPublishedListRequest
    
    Returns:
    
    DescribeLiveStreamPublishedListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLiveStreamState
```
public DescribeLiveStreamStateResponse DescribeLiveStreamState(DescribeLiveStreamStateRequest req)
                                                        throws TencentCloudSDKException
```
    返回直播中、无推流或者禁播等状态
    
    Parameters:
    
    req - DescribeLiveStreamStateRequest
    
    Returns:
    
    DescribeLiveStreamStateResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLiveWatermarks
```
public DescribeLiveWatermarksResponse DescribeLiveWatermarks(DescribeLiveWatermarksRequest req)
                                                      throws TencentCloudSDKException
```
    查询水印列表
    
    Parameters:
    
    req - DescribeLiveWatermarksRequest
    
    Returns:
    
    DescribeLiveWatermarksResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePullStreamConfigs
```
public DescribePullStreamConfigsResponse DescribePullStreamConfigs(DescribePullStreamConfigsRequest req)
                                                            throws TencentCloudSDKException
```
    查询拉流配置
    
    Parameters:
    
    req - DescribePullStreamConfigsRequest
    
    Returns:
    
    DescribePullStreamConfigsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DropLiveStream
```
public DropLiveStreamResponse DropLiveStream(DropLiveStreamRequest req)
                                      throws TencentCloudSDKException
```
    断开推流连接，但可以重新推流
    
    Parameters:
    
    req - DropLiveStreamRequest
    
    Returns:
    
    DropLiveStreamResponse
    
    Throws:
    
    TencentCloudSDKException
  - ForbidLiveStream
```
public ForbidLiveStreamResponse ForbidLiveStream(ForbidLiveStreamRequest req)
                                          throws TencentCloudSDKException
```
    禁止某条流的推送，可以预设某个时刻将流恢复。
    
    Parameters:
    
    req - ForbidLiveStreamRequest
    
    Returns:
    
    ForbidLiveStreamResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyLivePlayAuthKey
```
public ModifyLivePlayAuthKeyResponse ModifyLivePlayAuthKey(ModifyLivePlayAuthKeyRequest req)
                                                    throws TencentCloudSDKException
```
    修改播放鉴权key
    
    Parameters:
    
    req - ModifyLivePlayAuthKeyRequest
    
    Returns:
    
    ModifyLivePlayAuthKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyLivePushAuthKey
```
public ModifyLivePushAuthKeyResponse ModifyLivePushAuthKey(ModifyLivePushAuthKeyRequest req)
                                                    throws TencentCloudSDKException
```
    修改直播推流鉴权key
    
    Parameters:
    
    req - ModifyLivePushAuthKeyRequest
    
    Returns:
    
    ModifyLivePushAuthKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPullStreamConfig
```
public ModifyPullStreamConfigResponse ModifyPullStreamConfig(ModifyPullStreamConfigRequest req)
                                                      throws TencentCloudSDKException
```
    更新拉流配置
    
    Parameters:
    
    req - ModifyPullStreamConfigRequest
    
    Returns:
    
    ModifyPullStreamConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPullStreamStatus
```
public ModifyPullStreamStatusResponse ModifyPullStreamStatus(ModifyPullStreamStatusRequest req)
                                                      throws TencentCloudSDKException
```
    修改直播拉流配置状态
    
    Parameters:
    
    req - ModifyPullStreamStatusRequest
    
    Returns:
    
    ModifyPullStreamStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResumeDelayLiveStream
```
public ResumeDelayLiveStreamResponse ResumeDelayLiveStream(ResumeDelayLiveStreamRequest req)
                                                    throws TencentCloudSDKException
```
    恢复延迟播放设置
    
    Parameters:
    
    req - ResumeDelayLiveStreamRequest
    
    Returns:
    
    ResumeDelayLiveStreamResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResumeLiveStream
```
public ResumeLiveStreamResponse ResumeLiveStream(ResumeLiveStreamRequest req)
                                          throws TencentCloudSDKException
```
    恢复某条流的推送。
    
    Parameters:
    
    req - ResumeLiveStreamRequest
    
    Returns:
    
    ResumeLiveStreamResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetLiveWatermarkStatus
```
public SetLiveWatermarkStatusResponse SetLiveWatermarkStatus(SetLiveWatermarkStatusRequest req)
                                                      throws TencentCloudSDKException
```
    设置水印是否启用
    
    Parameters:
    
    req - SetLiveWatermarkStatusRequest
    
    Returns:
    
    SetLiveWatermarkStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopLiveRecord
```
public StopLiveRecordResponse StopLiveRecord(StopLiveRecordRequest req)
                                      throws TencentCloudSDKException
```
    说明：录制后的文件存放于点播平台。用户如需使用录制功能，需首先自行开通点播账号并确保账号可用。录制文件存放后，相关费用（含存储以及下行播放流量）按照点播平台计费方式收取，请参考对应文档。
    
    Parameters:
    
    req - StopLiveRecordRequest
    
    Returns:
    
    StopLiveRecordResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateLiveWatermark
```
public UpdateLiveWatermarkResponse UpdateLiveWatermark(UpdateLiveWatermarkRequest req)
                                                throws TencentCloudSDKException
```
    更新水印
    
    Parameters:
    
    req - UpdateLiveWatermarkRequest
    
    Returns:
    
    UpdateLiveWatermarkResponse
    
    Throws:
    
    TencentCloudSDKException

Class LiveClient

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

LiveClient

LiveClient

Method Detail

AddDelayLiveStream

AddLiveWatermark

CreateLiveRecord

CreatePullStreamConfig

DeleteLiveRecord

DeleteLiveWatermark

DescribeLivePlayAuthKey

DescribeLivePushAuthKey

DescribeLiveStreamOnlineInfo

DescribeLiveStreamOnlineList

DescribeLiveStreamPublishedList

DescribeLiveStreamState

DescribeLiveWatermarks

DescribePullStreamConfigs

DropLiveStream

ForbidLiveStream

ModifyLivePlayAuthKey

ModifyLivePushAuthKey

ModifyPullStreamConfig

ModifyPullStreamStatus

ResumeDelayLiveStream

ResumeLiveStream

SetLiveWatermarkStatus

StopLiveRecord

UpdateLiveWatermark