com.herewhite.sdk.converter.ConverterV5.Builder class 参考
- Android
更新时间
详细描述
适用版本:Whiteboard Android SDK 2.16.134。
属性与 JSON 字段
Java 非公开字段通过对应 getter/setter 访问;可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值;其他构造参数以签名为准。
| 字段 | 声明 | 源码初值 | 说明 |
|---|---|---|---|
| resource | String resource | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| type | ConvertType type | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| preview | boolean preview | false | 模型属性;通过对应 getter/setter 访问。 |
| scale | double scale | 1.2 | 静态文档转图片的缩放比例,取值 0.1~3,默认 1.2。 |
| outputFormat | ImageFormat outputFormat | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| pack | boolean pack | false | 模型属性;通过对应 getter/setter 访问。 |
| region | Region region | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| sdkToken | String sdkToken | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| taskUuid | String taskUuid | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| taskToken | String taskToken | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| timeout | long timeout | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| callback | ConverterCallbacks callback | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| 公开成员签名 | |
|---|---|
| Builder | setResource (String resource) |
| Builder | setType (ConvertType type) |
| Builder | setPreview (boolean preview) |
| Builder | setScale (double scale) |
| Builder | setOutputFormat (ImageFormat outputFormat) |
| Builder | setPack (boolean pack) |
| Builder | setRegion (Region region) |
| Builder | setSdkToken (String sdkToken) |
| Builder | setTaskUuid (String taskUuid) |
| Builder | setTaskToken (String taskToken) |
| Builder | setPoolInterval (long interval) |
| Builder | setTimeout (long timeout) |
| Builder | setCallback (ConverterCallbacks callback) |
| ConverterV5 | build () |
变量说明
resource
String resource源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
type
ConvertType type源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
preview
boolean preview源码初值:false
模型属性;通过对应 getter/setter 访问。
scale
double scale源码初值:1.2
静态文档转图片的缩放比例,取值 0.1~3,默认 1.2。
outputFormat
ImageFormat outputFormat源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
pack
boolean pack源码初值:false
模型属性;通过对应 getter/setter 访问。
region
Region region源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
sdkToken
String sdkToken源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
taskUuid
String taskUuid源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
taskToken
String taskToken源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
timeout
long timeout源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
callback
ConverterCallbacks callback源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
函数说明
setResource()
Builder setResource(String resource)参数
| 参数名 | 描述 |
|---|---|
resource | 转换任务源文件 url |
返回值
当前 Builder 实例,可继续链式配置。
setType()
Builder setType(ConvertType type)参数
| 参数名 | 描述 |
|---|---|
type | 转换任务类型,枚举:dynamic, static |
返回值
当前 Builder 实例,可继续链式配置。
setPreview()
Builder setPreview(boolean preview)只有动态文档转换支持预览图功能,同时生成预览图需要消耗较长时间,请根据业务需要选择
参数
| 参数名 | 描述 |
|---|---|
preview | 是否需要生成预览图,默认为 false |
返回值
当前 Builder 实例,可继续链式配置。
setScale()
Builder setScale(double scale)静态文档转图片的缩放比例,取值 0.1~3,默认 1.2。
setOutputFormat()
Builder setOutputFormat(ImageFormat outputFormat)只有静态文档转换支持自定义输出格式
参数
| 参数名 | 描述 |
|---|---|
outputFormat | 输出图片格式,默认为 png,可选参数为 png/jpg/jpeg/webp |
返回值
当前 Builder 实例,可继续链式配置。
setPack()
Builder setPack(boolean pack)只有静态文档转换支持 pack 参数
参数
| 参数名 | 描述 |
|---|---|
pack | 是否要生成资源包 |
返回值
当前 Builder 实例,可继续链式配置。
setRegion()
Builder setRegion(Region region)参数
| 参数名 | 描述 |
|---|---|
region | 数据中心 ID(不填则为 cn-hz) |
返回值
当前 Builder 实例,可继续链式配置。
setSdkToken()
Builder setSdkToken(String sdkToken)参数
| 参数名 | 描述 |
|---|---|
sdkToken | 用于发起文档转换任务并得到 taskuuid |
注意
由于 sdktoken 的权限过大,我们不建议将 sdktoken 暴露到前端,建议使用 sdktoken 签出 tasktoken,将 tasktoken 传到前端使用,只有拥有 tasktoken 的用户才能查询对应的任务进度。
返回值
当前 Builder 实例,可继续链式配置。
setTaskUuid()
Builder setTaskUuid(String taskUuid)参数
| 参数名 | 描述 |
|---|---|
taskUuid | 任务唯一标识 |
返回值
当前 Builder 实例,可继续链式配置。
setTaskToken()
Builder setTaskToken(String taskToken)参数
| 参数名 | 描述 |
|---|---|
taskToken | 任务查询token |
返回值
当前 Builder 实例,可继续链式配置。
setPoolInterval()
Builder setPoolInterval(long interval)setPoolInterval:com.herewhite.sdk.converter.ConverterV5.Builder 的公开成员。参数和返回类型见下方签名。
setTimeout()
Builder setTimeout(long timeout)setTimeout:com.herewhite.sdk.converter.ConverterV5.Builder 的公开成员。参数和返回类型见下方签名。
setCallback()
Builder setCallback(ConverterCallbacks callback)setCallback:com.herewhite.sdk.converter.ConverterV5.Builder 的公开成员。参数和返回类型见下方签名。
build()
ConverterV5 build()build:com.herewhite.sdk.converter.ConverterV5.Builder 的公开成员。参数和返回类型见下方签名。