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

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 Result information of the backup push task.
Long	getExceptionCnt() Get Number of exceptions during push.
String	getFinishReason() Get Reason for push stop.
String	getGroupId() Get Group ID of the whiteboard.
Long	getIMSyncTime() Get IM timestamp corresponding to the first frame of the whiteboard push video.
Long	getPushStartTime() Get Actual push start time, which is a Unix timestamp in seconds.
Long	getPushStopTime() Get Actual push stop time, which is a Unix timestamp in seconds.
String	getPushUserId() Get User ID of the push task.
String	getRequestId() Get The unique request ID, which is returned for each request.
Long	getRoomId() Get Room ID.
String	getStatus() Get Status of the push task.
String	getTaskId() Get ID of the whiteboard push task.
void	setBackup(String Backup) Set Result information of the backup push task.
void	setExceptionCnt(Long ExceptionCnt) Set Number of exceptions during push.
void	setFinishReason(String FinishReason) Set Reason for push stop.
void	setGroupId(String GroupId) Set Group ID of the whiteboard.
void	setIMSyncTime(Long IMSyncTime) Set IM timestamp corresponding to the first frame of the whiteboard push video.
void	setPushStartTime(Long PushStartTime) Set Actual push start time, which is a Unix timestamp in seconds.
void	setPushStopTime(Long PushStopTime) Set Actual push stop time, which is a Unix timestamp in seconds.
void	setPushUserId(String PushUserId) Set User ID of the push task.
void	setRequestId(String RequestId) Set The unique request ID, which is returned for each request.
void	setRoomId(Long RoomId) Set Room ID.
void	setStatus(String Status) Set Status of the push task.
void	setTaskId(String TaskId) Set ID of the whiteboard push task.
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, getMultipartRequestParams, getSkipSign, set, 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 Reason for push stop. - AUTO: Pushing automatically stops because no upstream audio/video or whiteboard operation occurs in the room for a long time. - USER_CALL: The API for stopping pushing is called. - EXCEPTION: An exception occurred.

Returns:

FinishReason Reason for push stop. - AUTO: Pushing automatically stops because no upstream audio/video or whiteboard operation occurs in the room for a long time. - USER_CALL: The API for stopping pushing is called. - EXCEPTION: An exception occurred.

setFinishReason

public void setFinishReason(String FinishReason)

Set Reason for push stop. - AUTO: Pushing automatically stops because no upstream audio/video or whiteboard operation occurs in the room for a long time. - USER_CALL: The API for stopping pushing is called. - EXCEPTION: An exception occurred.

Parameters:

FinishReason - Reason for push stop. - AUTO: Pushing automatically stops because no upstream audio/video or whiteboard operation occurs in the room for a long time. - USER_CALL: The API for stopping pushing is called. - EXCEPTION: An exception occurred.

getTaskId

public String getTaskId()

Get ID of the whiteboard push task.

Returns:

TaskId ID of the whiteboard push task.

setTaskId

public void setTaskId(String TaskId)

Set ID of the whiteboard push task.

Parameters:

TaskId - ID of the whiteboard push task.

getStatus

public String getStatus()

Get Status of the push task. - PREPARED: Push in preparation (including entering the room and starting the push service). - PUSHING: Pushing in progress. - STOPPED: Pushing stopped.

Returns:

Status Status of the push task. - PREPARED: Push in preparation (including entering the room and starting the push service). - PUSHING: Pushing in progress. - STOPPED: Pushing stopped.

setStatus

public void setStatus(String Status)

Set Status of the push task. - PREPARED: Push in preparation (including entering the room and starting the push service). - PUSHING: Pushing in progress. - STOPPED: Pushing stopped.

Parameters:

Status - Status of the push task. - PREPARED: Push in preparation (including entering the room and starting the push service). - PUSHING: Pushing in progress. - STOPPED: Pushing stopped.

getRoomId

public Long getRoomId()

Get Room ID.

Returns:

RoomId Room ID.

setRoomId

public void setRoomId(Long RoomId)

Set Room ID.

Parameters:

RoomId - Room ID.

getGroupId

public String getGroupId()

Get Group ID of the whiteboard.

Returns:

GroupId Group ID of the whiteboard.

setGroupId

public void setGroupId(String GroupId)

Set Group ID of the whiteboard.

Parameters:

GroupId - Group ID of the whiteboard.

getPushUserId

public String getPushUserId()

Get User ID of the push task.

Returns:

PushUserId User ID of the push task.

setPushUserId

public void setPushUserId(String PushUserId)

Set User ID of the push task.

Parameters:

PushUserId - User ID of the push task.

getPushStartTime

public Long getPushStartTime()

Get Actual push start time, which is a Unix timestamp in seconds.

Returns:

PushStartTime Actual push start time, which is a Unix timestamp in seconds.

setPushStartTime

public void setPushStartTime(Long PushStartTime)

Set Actual push start time, which is a Unix timestamp in seconds.

Parameters:

PushStartTime - Actual push start time, which is a Unix timestamp in seconds.

getPushStopTime

public Long getPushStopTime()

Get Actual push stop time, which is a Unix timestamp in seconds.

Returns:

PushStopTime Actual push stop time, which is a Unix timestamp in seconds.

setPushStopTime

public void setPushStopTime(Long PushStopTime)

Set Actual push stop time, which is a Unix timestamp in seconds.

Parameters:

PushStopTime - Actual push stop time, which is a Unix timestamp in seconds.

getExceptionCnt

public Long getExceptionCnt()

Get Number of exceptions during push.

Returns:

ExceptionCnt Number of exceptions during push.

setExceptionCnt

public void setExceptionCnt(Long ExceptionCnt)

Set Number of exceptions during push.

Parameters:

ExceptionCnt - Number of exceptions during push.

getIMSyncTime

public Long getIMSyncTime()

Get IM timestamp corresponding to the first frame of the whiteboard push video. The timestamp is used for time synchronization between IM messages and the whiteboard push video during playback.

Returns:

IMSyncTime IM timestamp corresponding to the first frame of the whiteboard push video. The timestamp is used for time synchronization between IM messages and the whiteboard push video during playback.

setIMSyncTime

public void setIMSyncTime(Long IMSyncTime)

Set IM timestamp corresponding to the first frame of the whiteboard push video. The timestamp is used for time synchronization between IM messages and the whiteboard push video during playback.

Parameters:

IMSyncTime - IM timestamp corresponding to the first frame of the whiteboard push video. The timestamp is used for time synchronization between IM messages and the whiteboard push video during playback.

getBackup

public String getBackup()

Get Result information of the backup push task. Note: This parameter may return null, indicating that no valid values can be obtained.

Returns:

Backup Result information of the backup push task. Note: This parameter may return null, indicating that no valid values can be obtained.

setBackup

public void setBackup(String Backup)

Set Result information of the backup push task. Note: This parameter may return null, indicating that no valid values can be obtained.

Parameters:

Backup - Result information of the backup push task. Note: This parameter may return null, indicating that no valid values can be obtained.

getRequestId

public String getRequestId()

Get The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Returns:

RequestId The unique request ID, which is returned for each request. RequestId is required for locating a problem.

setRequestId

public void setRequestId(String RequestId)

Set The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Parameters:

RequestId - The unique request ID, which is returned for each request. RequestId is required for locating a problem.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel