com.tencentcloudapi.vod.v20180717.models.LiveRealTimeClipRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-intl-en Show documentation
Show all versions of tencentcloud-sdk-java-intl-en Show documentation
Tencent Cloud API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.vod.v20180717.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class LiveRealTimeClipRequest extends AbstractModel {
/**
* The live stream code.
*/
@SerializedName("StreamId")
@Expose
private String StreamId;
/**
* Start time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
*/
@SerializedName("StartTime")
@Expose
private String StartTime;
/**
* End time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
*/
@SerializedName("EndTime")
@Expose
private String EndTime;
/**
* The VOD [application](https://www.tencentcloud.com/document/product/266/33987) ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
*/
@SerializedName("SubAppId")
@Expose
private Long SubAppId;
/**
* Whether to clip persistently. 0: no, 1: yes. Default: no.
*/
@SerializedName("IsPersistence")
@Expose
private Long IsPersistence;
/**
* 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.
*/
@SerializedName("ExpireTime")
@Expose
private String ExpireTime;
/**
* 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.
*/
@SerializedName("Procedure")
@Expose
private String Procedure;
/**
* 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`.
*/
@SerializedName("ClassId")
@Expose
private Long ClassId;
/**
* The source context, which is used to pass through user request information. The [NewFileUpload](https://intl.cloud.tencent.com/document/product/266/7830?from_cn_redirect=1) callback will return the value of this parameter. It can contain up to 250 characters and is valid only if `IsPersistence` is `1`.
*/
@SerializedName("SourceContext")
@Expose
private String SourceContext;
/**
* The session context, which is used to pass through user request information. If the `Procedure` parameter is specified, the [ProcedureStateChanged](https://intl.cloud.tencent.com/document/product/266/9636?from_cn_redirect=1) callback will return the value of this parameter. It can contain up to 1,000 characters and is valid only if `IsPersistence` is `1`.
*/
@SerializedName("SessionContext")
@Expose
private String SessionContext;
/**
* Whether the metadata of clipped video needs to be returned. 0: no, 1: yes. Default value: no.
*/
@SerializedName("MetaDataRequired")
@Expose
private Long MetaDataRequired;
/**
* Domain name used for live clipping. Time shifting must be enabled in LVB.
*/
@SerializedName("Host")
@Expose
private String Host;
/**
* The information of the live stream to clip.
The video clip is cut from the original stream by default.
If `Type` of `StreamInfo` is set to `Transcoding`, the video clip will be cut from the output stream of the transcoding template specified by `TemplateId`.
*/
@SerializedName("StreamInfo")
@Expose
private LiveRealTimeClipStreamInfo StreamInfo;
/**
* Reserved field. Do not enter a value for it.
*/
@SerializedName("ExtInfo")
@Expose
private String ExtInfo;
/**
* Get The live stream code.
* @return StreamId The live stream code.
*/
public String getStreamId() {
return this.StreamId;
}
/**
* Set The live stream code.
* @param StreamId The live stream code.
*/
public void setStreamId(String StreamId) {
this.StreamId = StreamId;
}
/**
* Get Start time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
* @return StartTime Start time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
*/
public String getStartTime() {
return this.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).
* @param StartTime Start time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
*/
public void setStartTime(String StartTime) {
this.StartTime = StartTime;
}
/**
* Get End time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
* @return EndTime End time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
*/
public String getEndTime() {
return this.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).
* @param EndTime End time of stream clipping in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
*/
public void setEndTime(String EndTime) {
this.EndTime = EndTime;
}
/**
* Get The VOD [application](https://www.tencentcloud.com/document/product/266/33987) ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
* @return SubAppId The VOD [application](https://www.tencentcloud.com/document/product/266/33987) ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
*/
public Long getSubAppId() {
return this.SubAppId;
}
/**
* Set The VOD [application](https://www.tencentcloud.com/document/product/266/33987) ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
* @param SubAppId The VOD [application](https://www.tencentcloud.com/document/product/266/33987) ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
*/
public void setSubAppId(Long SubAppId) {
this.SubAppId = SubAppId;
}
/**
* Get Whether to clip persistently. 0: no, 1: yes. Default: no.
* @return IsPersistence Whether to clip persistently. 0: no, 1: yes. Default: no.
*/
public Long getIsPersistence() {
return this.IsPersistence;
}
/**
* Set Whether to clip persistently. 0: no, 1: yes. Default: no.
* @param IsPersistence Whether to clip persistently. 0: no, 1: yes. Default: no.
*/
public void setIsPersistence(Long IsPersistence) {
this.IsPersistence = IsPersistence;
}
/**
* 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.
* @return 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.
*/
public String getExpireTime() {
return this.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.
* @param 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.
*/
public void setExpireTime(String ExpireTime) {
this.ExpireTime = ExpireTime;
}
/**
* 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.
* @return 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.
*/
public String getProcedure() {
return this.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.
* @param 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.
*/
public void setProcedure(String Procedure) {
this.Procedure = Procedure;
}
/**
* 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`.
* @return 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`.
*/
public Long getClassId() {
return this.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`.
* @param 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`.
*/
public void setClassId(Long ClassId) {
this.ClassId = ClassId;
}
/**
* Get The source context, which is used to pass through user request information. The [NewFileUpload](https://intl.cloud.tencent.com/document/product/266/7830?from_cn_redirect=1) callback will return the value of this parameter. It can contain up to 250 characters and is valid only if `IsPersistence` is `1`.
* @return SourceContext The source context, which is used to pass through user request information. The [NewFileUpload](https://intl.cloud.tencent.com/document/product/266/7830?from_cn_redirect=1) callback will return the value of this parameter. It can contain up to 250 characters and is valid only if `IsPersistence` is `1`.
*/
public String getSourceContext() {
return this.SourceContext;
}
/**
* Set The source context, which is used to pass through user request information. The [NewFileUpload](https://intl.cloud.tencent.com/document/product/266/7830?from_cn_redirect=1) callback will return the value of this parameter. It can contain up to 250 characters and is valid only if `IsPersistence` is `1`.
* @param SourceContext The source context, which is used to pass through user request information. The [NewFileUpload](https://intl.cloud.tencent.com/document/product/266/7830?from_cn_redirect=1) callback will return the value of this parameter. It can contain up to 250 characters and is valid only if `IsPersistence` is `1`.
*/
public void setSourceContext(String SourceContext) {
this.SourceContext = SourceContext;
}
/**
* Get The session context, which is used to pass through user request information. If the `Procedure` parameter is specified, the [ProcedureStateChanged](https://intl.cloud.tencent.com/document/product/266/9636?from_cn_redirect=1) callback will return the value of this parameter. It can contain up to 1,000 characters and is valid only if `IsPersistence` is `1`.
* @return SessionContext The session context, which is used to pass through user request information. If the `Procedure` parameter is specified, the [ProcedureStateChanged](https://intl.cloud.tencent.com/document/product/266/9636?from_cn_redirect=1) callback will return the value of this parameter. It can contain up to 1,000 characters and is valid only if `IsPersistence` is `1`.
*/
public String getSessionContext() {
return this.SessionContext;
}
/**
* Set The session context, which is used to pass through user request information. If the `Procedure` parameter is specified, the [ProcedureStateChanged](https://intl.cloud.tencent.com/document/product/266/9636?from_cn_redirect=1) callback will return the value of this parameter. It can contain up to 1,000 characters and is valid only if `IsPersistence` is `1`.
* @param SessionContext The session context, which is used to pass through user request information. If the `Procedure` parameter is specified, the [ProcedureStateChanged](https://intl.cloud.tencent.com/document/product/266/9636?from_cn_redirect=1) callback will return the value of this parameter. It can contain up to 1,000 characters and is valid only if `IsPersistence` is `1`.
*/
public void setSessionContext(String SessionContext) {
this.SessionContext = SessionContext;
}
/**
* Get Whether the metadata of clipped video needs to be returned. 0: no, 1: yes. Default value: no.
* @return MetaDataRequired Whether the metadata of clipped video needs to be returned. 0: no, 1: yes. Default value: no.
*/
public Long getMetaDataRequired() {
return this.MetaDataRequired;
}
/**
* Set Whether the metadata of clipped video needs to be returned. 0: no, 1: yes. Default value: no.
* @param MetaDataRequired Whether the metadata of clipped video needs to be returned. 0: no, 1: yes. Default value: no.
*/
public void setMetaDataRequired(Long MetaDataRequired) {
this.MetaDataRequired = MetaDataRequired;
}
/**
* Get Domain name used for live clipping. Time shifting must be enabled in LVB.
* @return Host Domain name used for live clipping. Time shifting must be enabled in LVB.
*/
public String getHost() {
return this.Host;
}
/**
* Set Domain name used for live clipping. Time shifting must be enabled in LVB.
* @param Host Domain name used for live clipping. Time shifting must be enabled in LVB.
*/
public void setHost(String Host) {
this.Host = Host;
}
/**
* Get The information of the live stream to clip.
The video clip is cut from the original stream by default.
If `Type` of `StreamInfo` is set to `Transcoding`, the video clip will be cut from the output stream of the transcoding template specified by `TemplateId`.
* @return StreamInfo The information of the live stream to clip.
The video clip is cut from the original stream by default.
If `Type` of `StreamInfo` is set to `Transcoding`, the video clip will be cut from the output stream of the transcoding template specified by `TemplateId`.
*/
public LiveRealTimeClipStreamInfo getStreamInfo() {
return this.StreamInfo;
}
/**
* Set The information of the live stream to clip.
The video clip is cut from the original stream by default.
If `Type` of `StreamInfo` is set to `Transcoding`, the video clip will be cut from the output stream of the transcoding template specified by `TemplateId`.
* @param StreamInfo The information of the live stream to clip.
The video clip is cut from the original stream by default.
If `Type` of `StreamInfo` is set to `Transcoding`, the video clip will be cut from the output stream of the transcoding template specified by `TemplateId`.
*/
public void setStreamInfo(LiveRealTimeClipStreamInfo StreamInfo) {
this.StreamInfo = StreamInfo;
}
/**
* Get Reserved field. Do not enter a value for it.
* @return ExtInfo Reserved field. Do not enter a value for it.
*/
public String getExtInfo() {
return this.ExtInfo;
}
/**
* Set Reserved field. Do not enter a value for it.
* @param ExtInfo Reserved field. Do not enter a value for it.
*/
public void setExtInfo(String ExtInfo) {
this.ExtInfo = ExtInfo;
}
public LiveRealTimeClipRequest() {
}
/**
* 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.
*/
public LiveRealTimeClipRequest(LiveRealTimeClipRequest source) {
if (source.StreamId != null) {
this.StreamId = new String(source.StreamId);
}
if (source.StartTime != null) {
this.StartTime = new String(source.StartTime);
}
if (source.EndTime != null) {
this.EndTime = new String(source.EndTime);
}
if (source.SubAppId != null) {
this.SubAppId = new Long(source.SubAppId);
}
if (source.IsPersistence != null) {
this.IsPersistence = new Long(source.IsPersistence);
}
if (source.ExpireTime != null) {
this.ExpireTime = new String(source.ExpireTime);
}
if (source.Procedure != null) {
this.Procedure = new String(source.Procedure);
}
if (source.ClassId != null) {
this.ClassId = new Long(source.ClassId);
}
if (source.SourceContext != null) {
this.SourceContext = new String(source.SourceContext);
}
if (source.SessionContext != null) {
this.SessionContext = new String(source.SessionContext);
}
if (source.MetaDataRequired != null) {
this.MetaDataRequired = new Long(source.MetaDataRequired);
}
if (source.Host != null) {
this.Host = new String(source.Host);
}
if (source.StreamInfo != null) {
this.StreamInfo = new LiveRealTimeClipStreamInfo(source.StreamInfo);
}
if (source.ExtInfo != null) {
this.ExtInfo = new String(source.ExtInfo);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "StreamId", this.StreamId);
this.setParamSimple(map, prefix + "StartTime", this.StartTime);
this.setParamSimple(map, prefix + "EndTime", this.EndTime);
this.setParamSimple(map, prefix + "SubAppId", this.SubAppId);
this.setParamSimple(map, prefix + "IsPersistence", this.IsPersistence);
this.setParamSimple(map, prefix + "ExpireTime", this.ExpireTime);
this.setParamSimple(map, prefix + "Procedure", this.Procedure);
this.setParamSimple(map, prefix + "ClassId", this.ClassId);
this.setParamSimple(map, prefix + "SourceContext", this.SourceContext);
this.setParamSimple(map, prefix + "SessionContext", this.SessionContext);
this.setParamSimple(map, prefix + "MetaDataRequired", this.MetaDataRequired);
this.setParamSimple(map, prefix + "Host", this.Host);
this.setParamObj(map, prefix + "StreamInfo.", this.StreamInfo);
this.setParamSimple(map, prefix + "ExtInfo", this.ExtInfo);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy