com.tencentcloudapi.vod.v20180717.models

Class ModifyMediaInfoRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.vod.v20180717.models.ModifyMediaInfoRequest

public class ModifyMediaInfoRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

skipSign

Constructor Summary

Constructors

Constructor and Description
ModifyMediaInfoRequest()
ModifyMediaInfoRequest(ModifyMediaInfoRequest 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
MediaKeyFrameDescItem[]	getAddKeyFrameDescs() Get Set of video timestamps to be added.
MediaSubtitleInput[]	getAddSubtitles() Get Information of multiple subtitles to be added.
String[]	getAddTags() Get The tags to add.
Long	getClassId() Get Media file category ID.
Long	getClearKeyFrameDescs() Get The value `1` indicates to delete all timestamps in the video.
Long	getClearSubtitles() Get The value `1` indicates to delete all subtitle information of the media file.
Long	getClearTags() Get The value `1` indicates to delete all tags of the media file.
String	getCoverData() Get String generated by [Base64-encoding](https://tools.ietf.org/html/rfc4648) the video cover image file (such as .jpeg or .png file).
Float[]	getDeleteKeyFrameDescs() Get Time offset of the set of video timestamps to be deleted in seconds.
String[]	getDeleteSubtitleIds() Get Unique IDs of the subtitles to be deleted.
String[]	getDeleteTags() Get Set of tags to be deleted.
String	getDescription() Get Media file description, which can contain up to 128 characters.
String	getExpireTime() Get Media file expiration time in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
String	getFileId() Get Unique media file ID.
String	getName() Get Media filename, which can contain up to 64 characters.
Long	getSubAppId() Get The VOD [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) ID.
void	setAddKeyFrameDescs(MediaKeyFrameDescItem[] AddKeyFrameDescs) Set Set of video timestamps to be added.
void	setAddSubtitles(MediaSubtitleInput[] AddSubtitles) Set Information of multiple subtitles to be added.
void	setAddTags(String[] AddTags) Set The tags to add.
void	setClassId(Long ClassId) Set Media file category ID.
void	setClearKeyFrameDescs(Long ClearKeyFrameDescs) Set The value `1` indicates to delete all timestamps in the video.
void	setClearSubtitles(Long ClearSubtitles) Set The value `1` indicates to delete all subtitle information of the media file.
void	setClearTags(Long ClearTags) Set The value `1` indicates to delete all tags of the media file.
void	setCoverData(String CoverData) Set String generated by [Base64-encoding](https://tools.ietf.org/html/rfc4648) the video cover image file (such as .jpeg or .png file).
void	setDeleteKeyFrameDescs(Float[] DeleteKeyFrameDescs) Set Time offset of the set of video timestamps to be deleted in seconds.
void	setDeleteSubtitleIds(String[] DeleteSubtitleIds) Set Unique IDs of the subtitles to be deleted.
void	setDeleteTags(String[] DeleteTags) Set Set of tags to be deleted.
void	setDescription(String Description) Set Media file description, which can contain up to 128 characters.
void	setExpireTime(String ExpireTime) Set Media file expiration time in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I).
void	setFileId(String FileId) Set Unique media file ID.
void	setName(String Name) Set Media filename, which can contain up to 64 characters.
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, 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

ModifyMediaInfoRequest

public ModifyMediaInfoRequest()

ModifyMediaInfoRequest

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

getFileId

public String getFileId()

Get Unique media file ID.

Returns:

FileId Unique media file ID.

setFileId

public void setFileId(String FileId)

Set Unique media file ID.

Parameters:

FileId - Unique media file ID.

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.

getName

public String getName()

Get Media filename, which can contain up to 64 characters.

Returns:

Name Media filename, which can contain up to 64 characters.

setName

public void setName(String Name)

Set Media filename, which can contain up to 64 characters.

Parameters:

Name - Media filename, which can contain up to 64 characters.

getDescription

public String getDescription()

Get Media file description, which can contain up to 128 characters.

Returns:

Description Media file description, which can contain up to 128 characters.

setDescription

public void setDescription(String Description)

Set Media file description, which can contain up to 128 characters.

Parameters:

Description - Media file description, which can contain up to 128 characters.

getClassId

public Long getClassId()

Get Media file category ID.

Returns:

ClassId Media file category ID.

setClassId

public void setClassId(Long ClassId)

Set Media file category ID.

Parameters:

ClassId - Media file category ID.

getExpireTime

public String getExpireTime()

Get Media file expiration time in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I). The value `9999-12-31T23:59:59Z` indicates that the media file never expires. After the expiration, the media file and its related resources (such as transcoding results and image sprites) will be permanently deleted.

Returns:

ExpireTime Media file expiration time in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I). The value `9999-12-31T23:59:59Z` indicates that the media file never expires. After the expiration, the media file and its related resources (such as transcoding results and image sprites) will be permanently deleted.

setExpireTime

public void setExpireTime(String ExpireTime)

Set Media file expiration time in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I). The value `9999-12-31T23:59:59Z` indicates that the media file never expires. After the expiration, the media file and its related resources (such as transcoding results and image sprites) will be permanently deleted.

Parameters:

ExpireTime - Media file expiration time in [ISO date format](https://intl.cloud.tencent.com/document/product/266/11732?from_cn_redirect=1#I). The value `9999-12-31T23:59:59Z` indicates that the media file never expires. After the expiration, the media file and its related resources (such as transcoding results and image sprites) will be permanently deleted.

getCoverData

public String getCoverData()

Get String generated by [Base64-encoding](https://tools.ietf.org/html/rfc4648) the video cover image file (such as .jpeg or .png file). Only .gif, .jpeg, and .png image formats are supported.

Returns:

CoverData String generated by [Base64-encoding](https://tools.ietf.org/html/rfc4648) the video cover image file (such as .jpeg or .png file). Only .gif, .jpeg, and .png image formats are supported.

setCoverData

public void setCoverData(String CoverData)

Set String generated by [Base64-encoding](https://tools.ietf.org/html/rfc4648) the video cover image file (such as .jpeg or .png file). Only .gif, .jpeg, and .png image formats are supported.

Parameters:

CoverData - String generated by [Base64-encoding](https://tools.ietf.org/html/rfc4648) the video cover image file (such as .jpeg or .png file). Only .gif, .jpeg, and .png image formats are supported.

getAddKeyFrameDescs

public MediaKeyFrameDescItem[] getAddKeyFrameDescs()

Get Set of video timestamps to be added. If a timestamp already exists at an offset time point, it will be overwritten. Up to 100 timestamps can be added to one media file. In the same request, the time offset parameters of `AddKeyFrameDescs` must be different from those of `DeleteKeyFrameDescs`.

Returns:

AddKeyFrameDescs Set of video timestamps to be added. If a timestamp already exists at an offset time point, it will be overwritten. Up to 100 timestamps can be added to one media file. In the same request, the time offset parameters of `AddKeyFrameDescs` must be different from those of `DeleteKeyFrameDescs`.

setAddKeyFrameDescs

public void setAddKeyFrameDescs(MediaKeyFrameDescItem[] AddKeyFrameDescs)

Set Set of video timestamps to be added. If a timestamp already exists at an offset time point, it will be overwritten. Up to 100 timestamps can be added to one media file. In the same request, the time offset parameters of `AddKeyFrameDescs` must be different from those of `DeleteKeyFrameDescs`.

Parameters:

AddKeyFrameDescs - Set of video timestamps to be added. If a timestamp already exists at an offset time point, it will be overwritten. Up to 100 timestamps can be added to one media file. In the same request, the time offset parameters of `AddKeyFrameDescs` must be different from those of `DeleteKeyFrameDescs`.

getDeleteKeyFrameDescs

public Float[] getDeleteKeyFrameDescs()

Get Time offset of the set of video timestamps to be deleted in seconds. In the same request, the time offset parameters of `AddKeyFrameDescs` must be different from those of `DeleteKeyFrameDescs`.

Returns:

DeleteKeyFrameDescs Time offset of the set of video timestamps to be deleted in seconds. In the same request, the time offset parameters of `AddKeyFrameDescs` must be different from those of `DeleteKeyFrameDescs`.

setDeleteKeyFrameDescs

public void setDeleteKeyFrameDescs(Float[] DeleteKeyFrameDescs)

Set Time offset of the set of video timestamps to be deleted in seconds. In the same request, the time offset parameters of `AddKeyFrameDescs` must be different from those of `DeleteKeyFrameDescs`.

Parameters:

DeleteKeyFrameDescs - Time offset of the set of video timestamps to be deleted in seconds. In the same request, the time offset parameters of `AddKeyFrameDescs` must be different from those of `DeleteKeyFrameDescs`.

getClearKeyFrameDescs

public Long getClearKeyFrameDescs()

Get The value `1` indicates to delete all timestamps in the video. Other values are meaningless. In the same request, `ClearKeyFrameDescs` and `AddKeyFrameDescs` cannot be present at the same time.

Returns:

ClearKeyFrameDescs The value `1` indicates to delete all timestamps in the video. Other values are meaningless. In the same request, `ClearKeyFrameDescs` and `AddKeyFrameDescs` cannot be present at the same time.

setClearKeyFrameDescs

public void setClearKeyFrameDescs(Long ClearKeyFrameDescs)

Set The value `1` indicates to delete all timestamps in the video. Other values are meaningless. In the same request, `ClearKeyFrameDescs` and `AddKeyFrameDescs` cannot be present at the same time.

Parameters:

ClearKeyFrameDescs - The value `1` indicates to delete all timestamps in the video. Other values are meaningless. In the same request, `ClearKeyFrameDescs` and `AddKeyFrameDescs` cannot be present at the same time.

getAddTags

public String[] getAddTags()

Get The tags to add. Each file can have up to 16 tags. A tag can contain at most 32 characters. You cannot include the same tag in `AddTags` and `DeleteTags` at the same time.

Returns:

AddTags The tags to add. Each file can have up to 16 tags. A tag can contain at most 32 characters. You cannot include the same tag in `AddTags` and `DeleteTags` at the same time.

setAddTags

public void setAddTags(String[] AddTags)

Set The tags to add. Each file can have up to 16 tags. A tag can contain at most 32 characters. You cannot include the same tag in `AddTags` and `DeleteTags` at the same time.

Parameters:

AddTags - The tags to add. Each file can have up to 16 tags. A tag can contain at most 32 characters. You cannot include the same tag in `AddTags` and `DeleteTags` at the same time.

getDeleteTags

public String[] getDeleteTags()

Get Set of tags to be deleted. In the same request, the parameters of `AddTags` must be different from those of `DeleteTags`.

Returns:

DeleteTags Set of tags to be deleted. In the same request, the parameters of `AddTags` must be different from those of `DeleteTags`.

setDeleteTags

public void setDeleteTags(String[] DeleteTags)

Set Set of tags to be deleted. In the same request, the parameters of `AddTags` must be different from those of `DeleteTags`.

Parameters:

DeleteTags - Set of tags to be deleted. In the same request, the parameters of `AddTags` must be different from those of `DeleteTags`.

getClearTags

public Long getClearTags()

Get The value `1` indicates to delete all tags of the media file. Other values are meaningless. In the same request, `ClearTags` and `AddTags` cannot be present at the same time.

Returns:

ClearTags The value `1` indicates to delete all tags of the media file. Other values are meaningless. In the same request, `ClearTags` and `AddTags` cannot be present at the same time.

setClearTags

public void setClearTags(Long ClearTags)

Set The value `1` indicates to delete all tags of the media file. Other values are meaningless. In the same request, `ClearTags` and `AddTags` cannot be present at the same time.

Parameters:

ClearTags - The value `1` indicates to delete all tags of the media file. Other values are meaningless. In the same request, `ClearTags` and `AddTags` cannot be present at the same time.

getAddSubtitles

public MediaSubtitleInput[] getAddSubtitles()

Get Information of multiple subtitles to be added. A single media file can have up to 16 subtitles. In the same request, the subtitle IDs specified in `AddSubtitles` must be different from those in `DeleteSubtitleIds`.

Returns:

AddSubtitles Information of multiple subtitles to be added. A single media file can have up to 16 subtitles. In the same request, the subtitle IDs specified in `AddSubtitles` must be different from those in `DeleteSubtitleIds`.

setAddSubtitles

public void setAddSubtitles(MediaSubtitleInput[] AddSubtitles)

Set Information of multiple subtitles to be added. A single media file can have up to 16 subtitles. In the same request, the subtitle IDs specified in `AddSubtitles` must be different from those in `DeleteSubtitleIds`.

Parameters:

AddSubtitles - Information of multiple subtitles to be added. A single media file can have up to 16 subtitles. In the same request, the subtitle IDs specified in `AddSubtitles` must be different from those in `DeleteSubtitleIds`.

getDeleteSubtitleIds

public String[] getDeleteSubtitleIds()

Get Unique IDs of the subtitles to be deleted. In the same request, the subtitle IDs specified in `AddSubtitles` must be different from those in `DeleteSubtitleIds`.

Returns:

DeleteSubtitleIds Unique IDs of the subtitles to be deleted. In the same request, the subtitle IDs specified in `AddSubtitles` must be different from those in `DeleteSubtitleIds`.

setDeleteSubtitleIds

public void setDeleteSubtitleIds(String[] DeleteSubtitleIds)

Set Unique IDs of the subtitles to be deleted. In the same request, the subtitle IDs specified in `AddSubtitles` must be different from those in `DeleteSubtitleIds`.

Parameters:

DeleteSubtitleIds - Unique IDs of the subtitles to be deleted. In the same request, the subtitle IDs specified in `AddSubtitles` must be different from those in `DeleteSubtitleIds`.

getClearSubtitles

public Long getClearSubtitles()

Get The value `1` indicates to delete all subtitle information of the media file. Other values are meaningless. `ClearSubtitles` and `AddSubtitles` cannot co-exist in the same request.

Returns:

ClearSubtitles The value `1` indicates to delete all subtitle information of the media file. Other values are meaningless. `ClearSubtitles` and `AddSubtitles` cannot co-exist in the same request.

setClearSubtitles

public void setClearSubtitles(Long ClearSubtitles)

Set The value `1` indicates to delete all subtitle information of the media file. Other values are meaningless. `ClearSubtitles` and `AddSubtitles` cannot co-exist in the same request.

Parameters:

ClearSubtitles - The value `1` indicates to delete all subtitle information of the media file. Other values are meaningless. `ClearSubtitles` and `AddSubtitles` cannot co-exist in the same request.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel