com.tencentcloudapi.vod.v20180717.models

Class LiveRealTimeClipRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.vod.v20180717.models.LiveRealTimeClipRequest

public class LiveRealTimeClipRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
LiveRealTimeClipRequest()
LiveRealTimeClipRequest(LiveRealTimeClipRequest 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
Long	getClassId() Get The ID of the media file’s category.
String	getEndTime() Get End time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
String	getExpireTime() Get Storage expiration time of video generated by persistent clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
String	getExtInfo() Get Reserved field.
String	getHost() Get Domain name used for live clipping.
Long	getIsPersistence() Get Whether to clip persistently.
Long	getMetaDataRequired() Get Whether the metadata of clipped video needs to be returned.
String	getProcedure() Get VOD task flow processing for video generated by persistent clipping.
String	getSessionContext() Get The session context, which is used to pass through user request information.
String	getSourceContext() Get The source context, which is used to pass through user request information.
String	getStartTime() Get Start time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
String	getStreamId() Get The live stream code.
LiveRealTimeClipStreamInfo	getStreamInfo() Get The information of the live stream to clip.
Long	getSubAppId() Get The VOD [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) ID.
void	setClassId(Long ClassId) Set The ID of the media file’s category.
void	setEndTime(String EndTime) Set End time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
void	setExpireTime(String ExpireTime) Set Storage expiration time of video generated by persistent clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
void	setExtInfo(String ExtInfo) Set Reserved field.
void	setHost(String Host) Set Domain name used for live clipping.
void	setIsPersistence(Long IsPersistence) Set Whether to clip persistently.
void	setMetaDataRequired(Long MetaDataRequired) Set Whether the metadata of clipped video needs to be returned.
void	setProcedure(String Procedure) Set VOD task flow processing for video generated by persistent clipping.
void	setSessionContext(String SessionContext) Set The session context, which is used to pass through user request information.
void	setSourceContext(String SourceContext) Set The source context, which is used to pass through user request information.
void	setStartTime(String StartTime) Set Start time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
void	setStreamId(String StreamId) Set The live stream code.
void	setStreamInfo(LiveRealTimeClipStreamInfo StreamInfo) Set The information of the live stream to clip.
void	setSubAppId(Long SubAppId) Set The VOD [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) 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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

LiveRealTimeClipRequest

public LiveRealTimeClipRequest()

LiveRealTimeClipRequest

public LiveRealTimeClipRequest(LiveRealTimeClipRequest 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

getStreamId

public String getStreamId()

Get The live stream code.

Returns:

StreamId The live stream code.

setStreamId

public void setStreamId(String StreamId)

Set The live stream code.

Parameters:

StreamId - The live stream code.

getStartTime

public String getStartTime()

Get Start time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).

Returns:

StartTime Start time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).

setStartTime

public void setStartTime(String StartTime)

Set Start time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).

Parameters:

StartTime - Start time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).

getEndTime

public String getEndTime()

Get End time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).

Returns:

EndTime End time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).

setEndTime

public void setEndTime(String EndTime)

Set End time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).

Parameters:

EndTime - End time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).

getSubAppId

public Long getSubAppId()

Get The VOD [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.

Returns:

SubAppId The VOD [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.

setSubAppId

public void setSubAppId(Long SubAppId)

Set The VOD [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.

Parameters:

SubAppId - The VOD [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.

getIsPersistence

public Long getIsPersistence()

Get Whether to clip persistently. 0: no, 1: yes. Default: no.

Returns:

IsPersistence Whether to clip persistently. 0: no, 1: yes. Default: no.

setIsPersistence

public void setIsPersistence(Long IsPersistence)

Set Whether to clip persistently. 0: no, 1: yes. Default: no.

Parameters:

IsPersistence - Whether to clip persistently. 0: no, 1: yes. Default: no.

getExpireTime

public String getExpireTime()

Get Storage expiration time of video generated by persistent clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I). `9999-12-31T23:59:59Z` means `never expire`. After the expiration, the media file and its related resources (such as transcoding results and image sprites) will be permanently deleted. This parameter will be valid only when `IsPersistence` is 1. By default, the video will never expire.

Returns:

ExpireTime Storage expiration time of video generated by persistent clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I). `9999-12-31T23:59:59Z` means `never expire`. After the expiration, the media file and its related resources (such as transcoding results and image sprites) will be permanently deleted. This parameter will be valid only when `IsPersistence` is 1. By default, the video will never expire.

setExpireTime

public void setExpireTime(String ExpireTime)

Set Storage expiration time of video generated by persistent clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I). `9999-12-31T23:59:59Z` means `never expire`. After the expiration, the media file and its related resources (such as transcoding results and image sprites) will be permanently deleted. This parameter will be valid only when `IsPersistence` is 1. By default, the video will never expire.

Parameters:

ExpireTime - Storage expiration time of video generated by persistent clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I). `9999-12-31T23:59:59Z` means `never expire`. After the expiration, the media file and its related resources (such as transcoding results and image sprites) will be permanently deleted. This parameter will be valid only when `IsPersistence` is 1. By default, the video will never expire.

getProcedure

public String getProcedure()

Get VOD task flow processing for video generated by persistent clipping. For more information, please see [Specifying Task Flow After Upload](https://intl.cloud.tencent.com/document/product/266/9759?from_cn_redirect=1). This parameter will be valid only when `IsPersistence` is 1.

Returns:

Procedure VOD task flow processing for video generated by persistent clipping. For more information, please see [Specifying Task Flow After Upload](https://intl.cloud.tencent.com/document/product/266/9759?from_cn_redirect=1). This parameter will be valid only when `IsPersistence` is 1.

setProcedure

public void setProcedure(String Procedure)

Set VOD task flow processing for video generated by persistent clipping. For more information, please see [Specifying Task Flow After Upload](https://intl.cloud.tencent.com/document/product/266/9759?from_cn_redirect=1). This parameter will be valid only when `IsPersistence` is 1.

Parameters:

Procedure - VOD task flow processing for video generated by persistent clipping. For more information, please see [Specifying Task Flow After Upload](https://intl.cloud.tencent.com/document/product/266/9759?from_cn_redirect=1). This parameter will be valid only when `IsPersistence` is 1.

getClassId

public Long getClassId()

Get The ID of the media file’s category. You can use the [CreateClass](https://intl.cloud.tencent.com/document/product/266/7812?from_cn_redirect=1) API to create a category and get the category ID.

The default value is `0`, which means the “Other” category. This parameter is valid only if `IsPersistence` is `1`.

Returns:

ClassId The ID of the media file’s category. You can use the [CreateClass](https://intl.cloud.tencent.com/document/product/266/7812?from_cn_redirect=1) API to create a category and get the category ID.

The default value is `0`, which means the “Other” category.

This parameter is valid only if `IsPersistence` is `1`.

setClassId

public void setClassId(Long ClassId)

Set The ID of the media file’s category. You can use the [CreateClass](https://intl.cloud.tencent.com/document/product/266/7812?from_cn_redirect=1) API to create a category and get the category ID.

The default value is `0`, which means the “Other” category. This parameter is valid only if `IsPersistence` is `1`.