Class CreateTranscodeRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Boolean getAutoHandleUnsupportedElement()
      Get 是否对不支持元素开启自动处理的功能。默认不开启。 在开启自动处理的情况下,会自动进行如下处理: 1.
      String getCompressFileType()
      Get 转码文件压缩格式,不传、传空字符串或不是指定的格式则不生成压缩文件,目前支持如下压缩格式: zip: 生成`.zip`压缩包 tar.gz: 生成`.tar.gz`压缩包
      String getExtraData()
      Get 内部参数
      Boolean getIsStaticPPT()
      Get 是否为静态PPT,默认为False; 如果IsStaticPPT为False,后缀名为.ppt或.pptx的文档会动态转码成HTML5页面,其他格式的文档会静态转码成图片;如果IsStaticPPT为True,所有格式的文档会静态转码成图片;
      String getMinResolution()
      Get 注意: 该参数已废弃, 请使用最新的 [云API SDK](https://cloud.tencent.com/document/api/1137/40060#SDK) ,使用 MinScaleResolution字段传递分辨率 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
      String getMinScaleResolution()
      Get 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率。 分辨率越高,效果越清晰,转出来的图片资源体积会越大,课件加载耗时会变长,请根据实际使用场景配置此参数。 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
      String getPriority()
      Get 文档转码优先级, 只有对于PPT动态转码生效,支持填入以下值:
      - low: 低优先级转码,对于动态转码,能支持500MB(下载超时时间10分钟)以及2000页文档,但资源有限可能会有比较长时间的排队,请酌情使用该功能。
      - 不填表示正常优先级转码,支持200MB文件(下载超时时间2分钟),500页以内的文档进行转码
      注意:对于PDF等静态文件转码,无论是正常优先级或者低优先级,最大只能支持200MB
      Long getSdkAppId()
      Get 客户的SdkAppId
      String getThumbnailResolution()
      Get 动态PPT转码可以为文件生成该分辨率的缩略图,不传、传空字符串或分辨率格式错误则不生成缩略图,分辨率格式同MinResolution
      String getUrl()
      Get 经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式,比如文档地址为http://example.com/测试.pdf,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率,请对URL进行编码。
      void setAutoHandleUnsupportedElement​(Boolean AutoHandleUnsupportedElement)
      Set 是否对不支持元素开启自动处理的功能。默认不开启。 在开启自动处理的情况下,会自动进行如下处理: 1.
      void setCompressFileType​(String CompressFileType)
      Set 转码文件压缩格式,不传、传空字符串或不是指定的格式则不生成压缩文件,目前支持如下压缩格式: zip: 生成`.zip`压缩包 tar.gz: 生成`.tar.gz`压缩包
      void setExtraData​(String ExtraData)
      Set 内部参数
      void setIsStaticPPT​(Boolean IsStaticPPT)
      Set 是否为静态PPT,默认为False; 如果IsStaticPPT为False,后缀名为.ppt或.pptx的文档会动态转码成HTML5页面,其他格式的文档会静态转码成图片;如果IsStaticPPT为True,所有格式的文档会静态转码成图片;
      void setMinResolution​(String MinResolution)
      Set 注意: 该参数已废弃, 请使用最新的 [云API SDK](https://cloud.tencent.com/document/api/1137/40060#SDK) ,使用 MinScaleResolution字段传递分辨率 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
      void setMinScaleResolution​(String MinScaleResolution)
      Set 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率。 分辨率越高,效果越清晰,转出来的图片资源体积会越大,课件加载耗时会变长,请根据实际使用场景配置此参数。 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
      void setPriority​(String Priority)
      Set 文档转码优先级, 只有对于PPT动态转码生效,支持填入以下值:
      - low: 低优先级转码,对于动态转码,能支持500MB(下载超时时间10分钟)以及2000页文档,但资源有限可能会有比较长时间的排队,请酌情使用该功能。
      - 不填表示正常优先级转码,支持200MB文件(下载超时时间2分钟),500页以内的文档进行转码
      注意:对于PDF等静态文件转码,无论是正常优先级或者低优先级,最大只能支持200MB
      void setSdkAppId​(Long SdkAppId)
      Set 客户的SdkAppId
      void setThumbnailResolution​(String ThumbnailResolution)
      Set 动态PPT转码可以为文件生成该分辨率的缩略图,不传、传空字符串或分辨率格式错误则不生成缩略图,分辨率格式同MinResolution
      void setUrl​(String Url)
      Set 经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式,比如文档地址为http://example.com/测试.pdf,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率,请对URL进行编码。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.
    • 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
        Returns:
        SdkAppId 客户的SdkAppId
      • setSdkAppId

        public void setSdkAppId​(Long SdkAppId)
        Set 客户的SdkAppId
        Parameters:
        SdkAppId - 客户的SdkAppId
      • getUrl

        public String getUrl()
        Get 经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式,比如文档地址为http://example.com/测试.pdf,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率,请对URL进行编码。
        Returns:
        Url 经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式,比如文档地址为http://example.com/测试.pdf,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率,请对URL进行编码。
      • setUrl

        public void setUrl​(String Url)
        Set 经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式,比如文档地址为http://example.com/测试.pdf,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率,请对URL进行编码。
        Parameters:
        Url - 经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式,比如文档地址为http://example.com/测试.pdf,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率,请对URL进行编码。
      • getIsStaticPPT

        public Boolean getIsStaticPPT()
        Get 是否为静态PPT,默认为False; 如果IsStaticPPT为False,后缀名为.ppt或.pptx的文档会动态转码成HTML5页面,其他格式的文档会静态转码成图片;如果IsStaticPPT为True,所有格式的文档会静态转码成图片;
        Returns:
        IsStaticPPT 是否为静态PPT,默认为False; 如果IsStaticPPT为False,后缀名为.ppt或.pptx的文档会动态转码成HTML5页面,其他格式的文档会静态转码成图片;如果IsStaticPPT为True,所有格式的文档会静态转码成图片;
      • setIsStaticPPT

        public void setIsStaticPPT​(Boolean IsStaticPPT)
        Set 是否为静态PPT,默认为False; 如果IsStaticPPT为False,后缀名为.ppt或.pptx的文档会动态转码成HTML5页面,其他格式的文档会静态转码成图片;如果IsStaticPPT为True,所有格式的文档会静态转码成图片;
        Parameters:
        IsStaticPPT - 是否为静态PPT,默认为False; 如果IsStaticPPT为False,后缀名为.ppt或.pptx的文档会动态转码成HTML5页面,其他格式的文档会静态转码成图片;如果IsStaticPPT为True,所有格式的文档会静态转码成图片;
      • getMinResolution

        public String getMinResolution()
        Get 注意: 该参数已废弃, 请使用最新的 [云API SDK](https://cloud.tencent.com/document/api/1137/40060#SDK) ,使用 MinScaleResolution字段传递分辨率 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
        Returns:
        MinResolution 注意: 该参数已废弃, 请使用最新的 [云API SDK](https://cloud.tencent.com/document/api/1137/40060#SDK) ,使用 MinScaleResolution字段传递分辨率 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
      • setMinResolution

        public void setMinResolution​(String MinResolution)
        Set 注意: 该参数已废弃, 请使用最新的 [云API SDK](https://cloud.tencent.com/document/api/1137/40060#SDK) ,使用 MinScaleResolution字段传递分辨率 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
        Parameters:
        MinResolution - 注意: 该参数已废弃, 请使用最新的 [云API SDK](https://cloud.tencent.com/document/api/1137/40060#SDK) ,使用 MinScaleResolution字段传递分辨率 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
      • getThumbnailResolution

        public String getThumbnailResolution()
        Get 动态PPT转码可以为文件生成该分辨率的缩略图,不传、传空字符串或分辨率格式错误则不生成缩略图,分辨率格式同MinResolution
        Returns:
        ThumbnailResolution 动态PPT转码可以为文件生成该分辨率的缩略图,不传、传空字符串或分辨率格式错误则不生成缩略图,分辨率格式同MinResolution
      • setThumbnailResolution

        public void setThumbnailResolution​(String ThumbnailResolution)
        Set 动态PPT转码可以为文件生成该分辨率的缩略图,不传、传空字符串或分辨率格式错误则不生成缩略图,分辨率格式同MinResolution
        Parameters:
        ThumbnailResolution - 动态PPT转码可以为文件生成该分辨率的缩略图,不传、传空字符串或分辨率格式错误则不生成缩略图,分辨率格式同MinResolution
      • getCompressFileType

        public String getCompressFileType()
        Get 转码文件压缩格式,不传、传空字符串或不是指定的格式则不生成压缩文件,目前支持如下压缩格式: zip: 生成`.zip`压缩包 tar.gz: 生成`.tar.gz`压缩包
        Returns:
        CompressFileType 转码文件压缩格式,不传、传空字符串或不是指定的格式则不生成压缩文件,目前支持如下压缩格式: zip: 生成`.zip`压缩包 tar.gz: 生成`.tar.gz`压缩包
      • setCompressFileType

        public void setCompressFileType​(String CompressFileType)
        Set 转码文件压缩格式,不传、传空字符串或不是指定的格式则不生成压缩文件,目前支持如下压缩格式: zip: 生成`.zip`压缩包 tar.gz: 生成`.tar.gz`压缩包
        Parameters:
        CompressFileType - 转码文件压缩格式,不传、传空字符串或不是指定的格式则不生成压缩文件,目前支持如下压缩格式: zip: 生成`.zip`压缩包 tar.gz: 生成`.tar.gz`压缩包
      • getExtraData

        public String getExtraData()
        Get 内部参数
        Returns:
        ExtraData 内部参数
      • setExtraData

        public void setExtraData​(String ExtraData)
        Set 内部参数
        Parameters:
        ExtraData - 内部参数
      • getPriority

        public String getPriority()
        Get 文档转码优先级, 只有对于PPT动态转码生效,支持填入以下值:
        - low: 低优先级转码,对于动态转码,能支持500MB(下载超时时间10分钟)以及2000页文档,但资源有限可能会有比较长时间的排队,请酌情使用该功能。
        - 不填表示正常优先级转码,支持200MB文件(下载超时时间2分钟),500页以内的文档进行转码
        注意:对于PDF等静态文件转码,无论是正常优先级或者低优先级,最大只能支持200MB
        Returns:
        Priority 文档转码优先级, 只有对于PPT动态转码生效,支持填入以下值:
        - low: 低优先级转码,对于动态转码,能支持500MB(下载超时时间10分钟)以及2000页文档,但资源有限可能会有比较长时间的排队,请酌情使用该功能。
        - 不填表示正常优先级转码,支持200MB文件(下载超时时间2分钟),500页以内的文档进行转码
        注意:对于PDF等静态文件转码,无论是正常优先级或者低优先级,最大只能支持200MB
      • setPriority

        public void setPriority​(String Priority)
        Set 文档转码优先级, 只有对于PPT动态转码生效,支持填入以下值:
        - low: 低优先级转码,对于动态转码,能支持500MB(下载超时时间10分钟)以及2000页文档,但资源有限可能会有比较长时间的排队,请酌情使用该功能。
        - 不填表示正常优先级转码,支持200MB文件(下载超时时间2分钟),500页以内的文档进行转码
        注意:对于PDF等静态文件转码,无论是正常优先级或者低优先级,最大只能支持200MB
        Parameters:
        Priority - 文档转码优先级, 只有对于PPT动态转码生效,支持填入以下值:
        - low: 低优先级转码,对于动态转码,能支持500MB(下载超时时间10分钟)以及2000页文档,但资源有限可能会有比较长时间的排队,请酌情使用该功能。
        - 不填表示正常优先级转码,支持200MB文件(下载超时时间2分钟),500页以内的文档进行转码
        注意:对于PDF等静态文件转码,无论是正常优先级或者低优先级,最大只能支持200MB
      • getMinScaleResolution

        public String getMinScaleResolution()
        Get 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率。 分辨率越高,效果越清晰,转出来的图片资源体积会越大,课件加载耗时会变长,请根据实际使用场景配置此参数。 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
        Returns:
        MinScaleResolution 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率。 分辨率越高,效果越清晰,转出来的图片资源体积会越大,课件加载耗时会变长,请根据实际使用场景配置此参数。 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
      • setMinScaleResolution

        public void setMinScaleResolution​(String MinScaleResolution)
        Set 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率。 分辨率越高,效果越清晰,转出来的图片资源体积会越大,课件加载耗时会变长,请根据实际使用场景配置此参数。 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
        Parameters:
        MinScaleResolution - 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率。 分辨率越高,效果越清晰,转出来的图片资源体积会越大,课件加载耗时会变长,请根据实际使用场景配置此参数。 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
      • getAutoHandleUnsupportedElement

        public Boolean getAutoHandleUnsupportedElement()
        Get 是否对不支持元素开启自动处理的功能。默认不开启。 在开启自动处理的情况下,会自动进行如下处理: 1. 墨迹:移除不支持的墨迹(比如使用WPS画的) 2. 自动翻页:移除PPT上所有的自动翻页设置,并设置为单击鼠标翻页 3. 已损坏音视频:移除PPT上对损坏音视频的引用
        Returns:
        AutoHandleUnsupportedElement 是否对不支持元素开启自动处理的功能。默认不开启。 在开启自动处理的情况下,会自动进行如下处理: 1. 墨迹:移除不支持的墨迹(比如使用WPS画的) 2. 自动翻页:移除PPT上所有的自动翻页设置,并设置为单击鼠标翻页 3. 已损坏音视频:移除PPT上对损坏音视频的引用
      • setAutoHandleUnsupportedElement

        public void setAutoHandleUnsupportedElement​(Boolean AutoHandleUnsupportedElement)
        Set 是否对不支持元素开启自动处理的功能。默认不开启。 在开启自动处理的情况下,会自动进行如下处理: 1. 墨迹:移除不支持的墨迹(比如使用WPS画的) 2. 自动翻页:移除PPT上所有的自动翻页设置,并设置为单击鼠标翻页 3. 已损坏音视频:移除PPT上对损坏音视频的引用
        Parameters:
        AutoHandleUnsupportedElement - 是否对不支持元素开启自动处理的功能。默认不开启。 在开启自动处理的情况下,会自动进行如下处理: 1. 墨迹:移除不支持的墨迹(比如使用WPS画的) 2. 自动翻页:移除PPT上所有的自动翻页设置,并设置为单击鼠标翻页 3. 已损坏音视频:移除PPT上对损坏音视频的引用