com.tencentcloudapi.tiw.v20190919.models

Class CreateTranscodeRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tiw.v20190919.models.CreateTranscodeRequest

public class CreateTranscodeRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateTranscodeRequest()
CreateTranscodeRequest(CreateTranscodeRequest 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
Boolean	getAutoHandleUnsupportedElement() Get Specifies whether to enable auto handling of unsupported elements.
String	getCompressFileType() Get Compression format of the transcoded file.
String	getExtraData() Get Internal parameter.
Boolean	getIsStaticPPT() Get Whether the PowerPoint file is static.
String	getMinResolution() Get Note: This parameter is disused.
String	getMinScaleResolution() Get Minimum resolution of the transcoded document.
String	getPriority() Get Document transcoding priority.
Long	getSdkAppId() Get SdkAppId of the customer
String	getThumbnailResolution() Get Resolution of the thumbnail generated for the dynamically transcoded PowerPoint file.
String	getUrl() Get URL of the transcoded document after URL encoding.
void	setAutoHandleUnsupportedElement(Boolean AutoHandleUnsupportedElement) Set Specifies whether to enable auto handling of unsupported elements.
void	setCompressFileType(String CompressFileType) Set Compression format of the transcoded file.
void	setExtraData(String ExtraData) Set Internal parameter.
void	setIsStaticPPT(Boolean IsStaticPPT) Set Whether the PowerPoint file is static.
void	setMinResolution(String MinResolution) Set Note: This parameter is disused.
void	setMinScaleResolution(String MinScaleResolution) Set Minimum resolution of the transcoded document.
void	setPriority(String Priority) Set Document transcoding priority.
void	setSdkAppId(Long SdkAppId) Set SdkAppId of the customer
void	setThumbnailResolution(String ThumbnailResolution) Set Resolution of the thumbnail generated for the dynamically transcoded PowerPoint file.
void	setUrl(String Url) Set URL of the transcoded document after URL encoding.
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

CreateTranscodeRequest

public CreateTranscodeRequest()

CreateTranscodeRequest

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

getSdkAppId

public Long getSdkAppId()

Get SdkAppId of the customer

Returns:

SdkAppId SdkAppId of the customer

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set SdkAppId of the customer

Parameters:

SdkAppId - SdkAppId of the customer

getUrl

public String getUrl()

Get URL of the transcoded document after URL encoding. URL encoding converts characters into a format that can be transmitted over the Internet. For example, URL encoding can convert the document URL http://example.com/Test.pdf into http://example.com/%E6%B5%8B%E8%AF%95.pdf. To improve the success rate of URL parsing, use URL encoding.

Returns:

Url URL of the transcoded document after URL encoding. URL encoding converts characters into a format that can be transmitted over the Internet. For example, URL encoding can convert the document URL http://example.com/Test.pdf into http://example.com/%E6%B5%8B%E8%AF%95.pdf. To improve the success rate of URL parsing, use URL encoding.

setUrl

public void setUrl(String Url)

Set URL of the transcoded document after URL encoding. URL encoding converts characters into a format that can be transmitted over the Internet. For example, URL encoding can convert the document URL http://example.com/Test.pdf into http://example.com/%E6%B5%8B%E8%AF%95.pdf. To improve the success rate of URL parsing, use URL encoding.

Parameters:

Url - URL of the transcoded document after URL encoding. URL encoding converts characters into a format that can be transmitted over the Internet. For example, URL encoding can convert the document URL http://example.com/Test.pdf into http://example.com/%E6%B5%8B%E8%AF%95.pdf. To improve the success rate of URL parsing, use URL encoding.

getIsStaticPPT

public Boolean getIsStaticPPT()

Get Whether the PowerPoint file is static. The default value is False. If IsStaticPPT is False, documents with the .ppt or .pptx extension will be dynamically transcoded to HTML5 pages, and documents with other extensions will be statically transcoded to images. If IsStaticPPT is True, documents with any extensions will be statically transcoded to images.

Returns:

IsStaticPPT Whether the PowerPoint file is static. The default value is False. If IsStaticPPT is False, documents with the .ppt or .pptx extension will be dynamically transcoded to HTML5 pages, and documents with other extensions will be statically transcoded to images. If IsStaticPPT is True, documents with any extensions will be statically transcoded to images.

setIsStaticPPT

public void setIsStaticPPT(Boolean IsStaticPPT)

Set Whether the PowerPoint file is static. The default value is False. If IsStaticPPT is False, documents with the .ppt or .pptx extension will be dynamically transcoded to HTML5 pages, and documents with other extensions will be statically transcoded to images. If IsStaticPPT is True, documents with any extensions will be statically transcoded to images.

Parameters:

IsStaticPPT - Whether the PowerPoint file is static. The default value is False. If IsStaticPPT is False, documents with the .ppt or .pptx extension will be dynamically transcoded to HTML5 pages, and documents with other extensions will be statically transcoded to images. If IsStaticPPT is True, documents with any extensions will be statically transcoded to images.

getMinResolution

public String getMinResolution()

Get Note: This parameter is disused. Use the MinScaleResolution parameter to pass in a resolution. For more information, see [CreateTranscode](https://intl.cloud.tencent.com/document/api/1137/40060?from_cn_redirect=1#SDK). Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used. Example: 1280x720. Note that the character between the numbers is the letter x.

Returns:

MinResolution Note: This parameter is disused. Use the MinScaleResolution parameter to pass in a resolution. For more information, see [CreateTranscode](https://intl.cloud.tencent.com/document/api/1137/40060?from_cn_redirect=1#SDK). Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used. Example: 1280x720. Note that the character between the numbers is the letter x.

setMinResolution

public void setMinResolution(String MinResolution)

Set Note: This parameter is disused. Use the MinScaleResolution parameter to pass in a resolution. For more information, see [CreateTranscode](https://intl.cloud.tencent.com/document/api/1137/40060?from_cn_redirect=1#SDK). Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used. Example: 1280x720. Note that the character between the numbers is the letter x.

Parameters:

MinResolution - Note: This parameter is disused. Use the MinScaleResolution parameter to pass in a resolution. For more information, see [CreateTranscode](https://intl.cloud.tencent.com/document/api/1137/40060?from_cn_redirect=1#SDK). Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used. Example: 1280x720. Note that the character between the numbers is the letter x.

getThumbnailResolution

public String getThumbnailResolution()

Get Resolution of the thumbnail generated for the dynamically transcoded PowerPoint file. If no value or null is specified for it or the resolution format is invalid, no thumbnail will be generated. The resolution format is the same as that of MinResolution. For static transcoding, this parameter does not work.

Returns:

ThumbnailResolution Resolution of the thumbnail generated for the dynamically transcoded PowerPoint file. If no value or null is specified for it or the resolution format is invalid, no thumbnail will be generated. The resolution format is the same as that of MinResolution. For static transcoding, this parameter does not work.

setThumbnailResolution

public void setThumbnailResolution(String ThumbnailResolution)

Set Resolution of the thumbnail generated for the dynamically transcoded PowerPoint file. If no value or null is specified for it or the resolution format is invalid, no thumbnail will be generated. The resolution format is the same as that of MinResolution. For static transcoding, this parameter does not work.

Parameters:

ThumbnailResolution - Resolution of the thumbnail generated for the dynamically transcoded PowerPoint file. If no value or null is specified for it or the resolution format is invalid, no thumbnail will be generated. The resolution format is the same as that of MinResolution. For static transcoding, this parameter does not work.

getCompressFileType

public String getCompressFileType()

Get Compression format of the transcoded file. If no value or null is specified for it or the specified format is invalid, no compression file will be generated. Currently, the following compression formats are supported: `zip`: generates a .zip compression package. `tar.gz: generates a .tar.gz compression package.

Returns:

CompressFileType Compression format of the transcoded file. If no value or null is specified for it or the specified format is invalid, no compression file will be generated. Currently, the following compression formats are supported: `zip`: generates a .zip compression package. `tar.gz: generates a .tar.gz compression package.

setCompressFileType

public void setCompressFileType(String CompressFileType)

Set Compression format of the transcoded file. If no value or null is specified for it or the specified format is invalid, no compression file will be generated. Currently, the following compression formats are supported: `zip`: generates a .zip compression package. `tar.gz: generates a .tar.gz compression package.

Parameters:

CompressFileType - Compression format of the transcoded file. If no value or null is specified for it or the specified format is invalid, no compression file will be generated. Currently, the following compression formats are supported: `zip`: generates a .zip compression package. `tar.gz: generates a .tar.gz compression package.

getExtraData

public String getExtraData()

Get Internal parameter.

Returns:

ExtraData Internal parameter.

setExtraData

public void setExtraData(String ExtraData)

Set Internal parameter.

Parameters:

ExtraData - Internal parameter.

getPriority

public String getPriority()

Get Document transcoding priority. This parameter takes effect only for PowerPoint dynamic transcoding. Valid values:
- low: Low transcoding priority. The task can transcode at most 500 MB of data or a 2000-page document, with a download timeout no longer than 10 minutes. Due to resource limits, these tasks may have to queue for a long period of time. Consider this before you use this feature. - null: Normal transcoding priority. The task can transcode at most 200 MB of data or a 500-page document, with a download timeout no longer than 2 minutes.
Note: For static transcoding such as PDF transcoding, each task can transcode at most 200 MB of data regardless of the transcoding priority.

Returns:

Priority Document transcoding priority. This parameter takes effect only for PowerPoint dynamic transcoding. Valid values:
- low: Low transcoding priority. The task can transcode at most 500 MB of data or a 2000-page document, with a download timeout no longer than 10 minutes. Due to resource limits, these tasks may have to queue for a long period of time. Consider this before you use this feature. - null: Normal transcoding priority. The task can transcode at most 200 MB of data or a 500-page document, with a download timeout no longer than 2 minutes.
Note: For static transcoding such as PDF transcoding, each task can transcode at most 200 MB of data regardless of the transcoding priority.

setPriority

public void setPriority(String Priority)

Set Document transcoding priority. This parameter takes effect only for PowerPoint dynamic transcoding. Valid values:
- low: Low transcoding priority. The task can transcode at most 500 MB of data or a 2000-page document, with a download timeout no longer than 10 minutes. Due to resource limits, these tasks may have to queue for a long period of time. Consider this before you use this feature. - null: Normal transcoding priority. The task can transcode at most 200 MB of data or a 500-page document, with a download timeout no longer than 2 minutes.
Note: For static transcoding such as PDF transcoding, each task can transcode at most 200 MB of data regardless of the transcoding priority.

Parameters:

Priority - Document transcoding priority. This parameter takes effect only for PowerPoint dynamic transcoding. Valid values:
- low: Low transcoding priority. The task can transcode at most 500 MB of data or a 2000-page document, with a download timeout no longer than 10 minutes. Due to resource limits, these tasks may have to queue for a long period of time. Consider this before you use this feature. - null: Normal transcoding priority. The task can transcode at most 200 MB of data or a 500-page document, with a download timeout no longer than 2 minutes.
Note: For static transcoding such as PDF transcoding, each task can transcode at most 200 MB of data regardless of the transcoding priority.

getMinScaleResolution

public String getMinScaleResolution()

Get Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used. Higher resolution brings clearer visual effect, but also means larger size of the transcoded image resources and longer loading time of the transcoded file. Set this parameter appropriately based on your actual scenario. Example: 1280x720. Note that the character between the numbers is the letter x.

Returns:

MinScaleResolution Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used. Higher resolution brings clearer visual effect, but also means larger size of the transcoded image resources and longer loading time of the transcoded file. Set this parameter appropriately based on your actual scenario. Example: 1280x720. Note that the character between the numbers is the letter x.

setMinScaleResolution

public void setMinScaleResolution(String MinScaleResolution)

Set Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used. Higher resolution brings clearer visual effect, but also means larger size of the transcoded image resources and longer loading time of the transcoded file. Set this parameter appropriately based on your actual scenario. Example: 1280x720. Note that the character between the numbers is the letter x.

Parameters:

MinScaleResolution - Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used. Higher resolution brings clearer visual effect, but also means larger size of the transcoded image resources and longer loading time of the transcoded file. Set this parameter appropriately based on your actual scenario. Example: 1280x720. Note that the character between the numbers is the letter x.

getAutoHandleUnsupportedElement

public Boolean getAutoHandleUnsupportedElement()

Get Specifies whether to enable auto handling of unsupported elements. By default, this feature is disabled. If auto handling is enabled, the following processes are performed: 1. Inkblots: Remove unsupported inkblots, such as those drawn by using WPS. 2. Auto page flip: Clear the auto page clip settings in the PowerPoint file and set the page flip mode to mouse click. 3. Corrupted audio/videos: Remove the references to corrupted audio/videos in the PowerPoint file.

Returns:

AutoHandleUnsupportedElement Specifies whether to enable auto handling of unsupported elements. By default, this feature is disabled. If auto handling is enabled, the following processes are performed: 1. Inkblots: Remove unsupported inkblots, such as those drawn by using WPS. 2. Auto page flip: Clear the auto page clip settings in the PowerPoint file and set the page flip mode to mouse click. 3. Corrupted audio/videos: Remove the references to corrupted audio/videos in the PowerPoint file.

setAutoHandleUnsupportedElement

public void setAutoHandleUnsupportedElement(Boolean AutoHandleUnsupportedElement)

Set Specifies whether to enable auto handling of unsupported elements. By default, this feature is disabled. If auto handling is enabled, the following processes are performed: 1. Inkblots: Remove unsupported inkblots, such as those drawn by using WPS. 2. Auto page flip: Clear the auto page clip settings in the PowerPoint file and set the page flip mode to mouse click. 3. Corrupted audio/videos: Remove the references to corrupted audio/videos in the PowerPoint file.

Parameters:

AutoHandleUnsupportedElement - Specifies whether to enable auto handling of unsupported elements. By default, this feature is disabled. If auto handling is enabled, the following processes are performed: 1. Inkblots: Remove unsupported inkblots, such as those drawn by using WPS. 2. Auto page flip: Clear the auto page clip settings in the PowerPoint file and set the page flip mode to mouse click. 3. Corrupted audio/videos: Remove the references to corrupted audio/videos in the PowerPoint file.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel