com.tencentcloudapi.tiw.v20190919.models

Class DescribeWhiteboardPushResponse

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tiw.v20190919.models.DescribeWhiteboardPushResponse

public class DescribeWhiteboardPushResponse
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeWhiteboardPushResponse()
DescribeWhiteboardPushResponse(DescribeWhiteboardPushResponse source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getBackup() Get 备份推流任务结果信息 注意：此字段可能返回 null，表示取不到有效值。
Long	getExceptionCnt() Get 推流过程中出现异常的次数
String	getFinishReason() Get 推流结束原因， - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流 - USER_CALL: 主动调用了停止推流接口 - EXCEPTION: 推流异常结束
String	getGroupId() Get 白板的群组 Id
Long	getIMSyncTime() Get 白板推流首帧对应的IM时间戳，可用于录制回放时IM聊天消息与白板推流视频进行同步对时。
Long	getPushStartTime() Get 实际开始推流时间，Unix 时间戳，单位秒
Long	getPushStopTime() Get 实际停止推流时间，Unix 时间戳，单位秒
String	getPushUserId() Get 推流用户Id
String	getRequestId() Get 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
Long	getRoomId() Get 房间号
String	getStatus() Get 推流任务状态 - PREPARED: 表示推流正在准备中（进房/启动推流服务等操作） - PUSHING: 表示推流已开始 - STOPPED: 表示推流已停止
String	getTaskId() Get 需要查询结果的白板推流任务Id
void	setBackup(String Backup) Set 备份推流任务结果信息 注意：此字段可能返回 null，表示取不到有效值。
void	setExceptionCnt(Long ExceptionCnt) Set 推流过程中出现异常的次数
void	setFinishReason(String FinishReason) Set 推流结束原因， - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流 - USER_CALL: 主动调用了停止推流接口 - EXCEPTION: 推流异常结束
void	setGroupId(String GroupId) Set 白板的群组 Id
void	setIMSyncTime(Long IMSyncTime) Set 白板推流首帧对应的IM时间戳，可用于录制回放时IM聊天消息与白板推流视频进行同步对时。
void	setPushStartTime(Long PushStartTime) Set 实际开始推流时间，Unix 时间戳，单位秒
void	setPushStopTime(Long PushStopTime) Set 实际停止推流时间，Unix 时间戳，单位秒
void	setPushUserId(String PushUserId) Set 推流用户Id
void	setRequestId(String RequestId) Set 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
void	setRoomId(Long RoomId) Set 房间号
void	setStatus(String Status) Set 推流任务状态 - PREPARED: 表示推流正在准备中（进房/启动推流服务等操作） - PUSHING: 表示推流已开始 - STOPPED: 表示推流已停止
void	setTaskId(String TaskId) Set 需要查询结果的白板推流任务Id
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DescribeWhiteboardPushResponse

public DescribeWhiteboardPushResponse()

DescribeWhiteboardPushResponse

public DescribeWhiteboardPushResponse(DescribeWhiteboardPushResponse source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getFinishReason

public String getFinishReason()

Get 推流结束原因， - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流 - USER_CALL: 主动调用了停止推流接口 - EXCEPTION: 推流异常结束

Returns:

FinishReason 推流结束原因， - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流 - USER_CALL: 主动调用了停止推流接口 - EXCEPTION: 推流异常结束

setFinishReason

public void setFinishReason(String FinishReason)

Set 推流结束原因， - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流 - USER_CALL: 主动调用了停止推流接口 - EXCEPTION: 推流异常结束

Parameters:

FinishReason - 推流结束原因， - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流 - USER_CALL: 主动调用了停止推流接口 - EXCEPTION: 推流异常结束

getTaskId

public String getTaskId()

Get 需要查询结果的白板推流任务Id

Returns:

TaskId 需要查询结果的白板推流任务Id

setTaskId

public void setTaskId(String TaskId)

Set 需要查询结果的白板推流任务Id

Parameters:

TaskId - 需要查询结果的白板推流任务Id

getStatus

public String getStatus()

Get 推流任务状态 - PREPARED: 表示推流正在准备中（进房/启动推流服务等操作） - PUSHING: 表示推流已开始 - STOPPED: 表示推流已停止

Returns:

Status 推流任务状态 - PREPARED: 表示推流正在准备中（进房/启动推流服务等操作） - PUSHING: 表示推流已开始 - STOPPED: 表示推流已停止

setStatus

public void setStatus(String Status)

Set 推流任务状态 - PREPARED: 表示推流正在准备中（进房/启动推流服务等操作） - PUSHING: 表示推流已开始 - STOPPED: 表示推流已停止

Parameters:

Status - 推流任务状态 - PREPARED: 表示推流正在准备中（进房/启动推流服务等操作） - PUSHING: 表示推流已开始 - STOPPED: 表示推流已停止

getRoomId

public Long getRoomId()

Get 房间号

Returns:

RoomId 房间号

setRoomId

public void setRoomId(Long RoomId)

Set 房间号

Parameters:

RoomId - 房间号

getGroupId

public String getGroupId()

Get 白板的群组 Id

Returns:

GroupId 白板的群组 Id

setGroupId

public void setGroupId(String GroupId)

Set 白板的群组 Id

Parameters:

GroupId - 白板的群组 Id

getPushUserId

public String getPushUserId()

Get 推流用户Id

Returns:

PushUserId 推流用户Id

setPushUserId

public void setPushUserId(String PushUserId)

Set 推流用户Id

Parameters:

PushUserId - 推流用户Id

getPushStartTime

public Long getPushStartTime()

Get 实际开始推流时间，Unix 时间戳，单位秒

Returns:

PushStartTime 实际开始推流时间，Unix 时间戳，单位秒

setPushStartTime

public void setPushStartTime(Long PushStartTime)

Set 实际开始推流时间，Unix 时间戳，单位秒

Parameters:

PushStartTime - 实际开始推流时间，Unix 时间戳，单位秒

getPushStopTime

public Long getPushStopTime()

Get 实际停止推流时间，Unix 时间戳，单位秒

Returns:

PushStopTime 实际停止推流时间，Unix 时间戳，单位秒

setPushStopTime

public void setPushStopTime(Long PushStopTime)

Set 实际停止推流时间，Unix 时间戳，单位秒

Parameters:

PushStopTime - 实际停止推流时间，Unix 时间戳，单位秒

getExceptionCnt

public Long getExceptionCnt()

Get 推流过程中出现异常的次数

Returns:

ExceptionCnt 推流过程中出现异常的次数

setExceptionCnt

public void setExceptionCnt(Long ExceptionCnt)

Set 推流过程中出现异常的次数

Parameters:

ExceptionCnt - 推流过程中出现异常的次数

getIMSyncTime

public Long getIMSyncTime()

Get 白板推流首帧对应的IM时间戳，可用于录制回放时IM聊天消息与白板推流视频进行同步对时。

Returns:

IMSyncTime 白板推流首帧对应的IM时间戳，可用于录制回放时IM聊天消息与白板推流视频进行同步对时。

setIMSyncTime

public void setIMSyncTime(Long IMSyncTime)

Set 白板推流首帧对应的IM时间戳，可用于录制回放时IM聊天消息与白板推流视频进行同步对时。

Parameters:

IMSyncTime - 白板推流首帧对应的IM时间戳，可用于录制回放时IM聊天消息与白板推流视频进行同步对时。

getBackup

public String getBackup()

Get 备份推流任务结果信息 注意：此字段可能返回 null，表示取不到有效值。

Returns:

Backup 备份推流任务结果信息 注意：此字段可能返回 null，表示取不到有效值。

setBackup

public void setBackup(String Backup)

Set 备份推流任务结果信息 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

Backup - 备份推流任务结果信息 注意：此字段可能返回 null，表示取不到有效值。

getRequestId

public String getRequestId()

Get 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

Returns:

RequestId 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

setRequestId

public void setRequestId(String RequestId)

Set 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

Parameters:

RequestId - 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.