DDSConfigBuilder.CommonBuilder (lib-dds API)

java.lang.Object
- com.aispeech.dui.dds.DDSConfigBuilder.BaseBuilder
- - com.aispeech.dui.dds.DDSConfigBuilder.CommonBuilder

封闭类:: DDSConfigBuilder

public static class DDSConfigBuilder.CommonBuilder
extends DDSConfigBuilder.BaseBuilder

设备信息、使用目录、VOIP功能等通用配置

字段概要
- 从类继承的字段 com.aispeech.dui.dds.DDSConfigBuilder.BaseBuilder
  mDdsConfig

构造器概要

构造器
构造器和说明

CommonBuilder(DDSConfig ddsConfig)

构造器
构造器和说明
`CommonBuilder(DDSConfig ddsConfig)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`DDSConfigBuilder.CommonBuilder`	`enableDynamicUiAgentPort(boolean enable)` 是否使用 uiagent 动态端口号默认值：false
`DDSConfigBuilder.CommonBuilder`	`enableReplaceProfile(boolean enable)` 试用授权是否连网更新成在线授权默认值：true
`DDSConfigBuilder.CommonBuilder`	`enableUpdateDuicore(boolean enable)` 是否更新语音资源默认值：false
`DDSConfigBuilder.CommonBuilder`	`enableUpdateNotification(boolean enable)` 是否使用内置的资源更新通知栏默认值：true
`DDSConfigBuilder.CommonBuilder`	`setAccessToken(java.lang.String accessToken)` 保留字段，上传、升级时使用
`DDSConfigBuilder.CommonBuilder`	`setCachePath(java.lang.String cachePath)` 缓存文件保存目录默认值：/sdcard/Android/data/包名/cache 还需设置 setCacheSize(int)
`DDSConfigBuilder.CommonBuilder`	`setCacheSize(int cacheSize)` 缓存文件大小限制是否必需：自定义缓存目录时必需默认值：无
`DDSConfigBuilder.CommonBuilder`	`setCustomBackupZipUserDefined(java.lang.String customBackupZipUserDefined)` 产品资源包保存路径取值：绝对路径默认值：无
`DDSConfigBuilder.CommonBuilder`	`setCustomHome(java.lang.String customHome)` 产品资源存放的目录取值：绝对路径默认值：/data/data/com.xxx/files/dds/custom/
`DDSConfigBuilder.CommonBuilder`	`setCustomSha256(java.lang.String customSha256)` 自定义授权证书的SHA256, sdk 授权时会检查包名和签名的SHA256，第三方加固后可能改变，可以配置新的SHA256 默认值：
`DDSConfigBuilder.CommonBuilder`	`setCustomZip(java.lang.String customZip)` 使用内置产品资源包, 从官网下载的产品资源包一般叫 product.zip 取值：assets目录下为压缩包名称，其他目录为绝对路径默认值：无
`DDSConfigBuilder.CommonBuilder`	`setDeviceId(java.lang.String deviceId)` 设备ID 用于授权认证的原始设备ID，请务必确保设备ID唯一。
`DDSConfigBuilder.CommonBuilder`	`setDeviceName(java.lang.String deviceName)` 设备 DeviceName, 用来标识设备的标识符取值：设备 DeviceName 默认值：无
`DDSConfigBuilder.CommonBuilder`	`setDuicoreBackupZipUserDefined(java.lang.String duicoreBackupZipUserDefined)` duicore 资源包保存路径取值：绝对路径默认值：无
`DDSConfigBuilder.CommonBuilder`	`setDuicoreHome(java.lang.String duicoreHome)` duicore 资源存放的目录取值：绝对路径默认值：/data/data/包名/files/dds/duicore/
`DDSConfigBuilder.CommonBuilder`	`setInitTimeout(int timeout)` SDK初始化超时时间,单位秒默认值：60
`DDSConfigBuilder.CommonBuilder`	`setMessageQueueMaxSize(int messageQueueMaxSize)` 设置 sdk 内部的消息队列最大长度默认 500, 0表示不限制长度, 建议大于100 动态库方法运行在一个单独的线程里，通过消息队列依次调用。
`DDSConfigBuilder.CommonBuilder`	`setOfflineProfileName(java.lang.String offlineProfileName)` assets目录下的离线授权文件名取值：assets目录下的离线授权文件名默认值：
`DDSConfigBuilder.CommonBuilder`	`setProductLicenseId(java.lang.String productLicenseId)` 产品licenseID 预分配licence模式下的参数默认值：无
`DDSConfigBuilder.CommonBuilder`	`setProductVersion(java.lang.String productVersion)` 连接指定产品版本的对话服务取值：版本号默认值：本地最新版本
`DDSConfigBuilder.CommonBuilder`	`setUserId(java.lang.String userId)` 用户ID 取值：用户ID（保留字段）默认值：USER2021ID
`DDSConfigBuilder.CommonBuilder`	`setVoipResBin(java.lang.String voipResBin)` voip 的资源的路径。
`DDSConfigBuilder.CommonBuilder`	`setVoipType(java.lang.String voipType)` 使用 voip 功能时的类型，现在支持线性双麦(line_2)和线性4麦(line_4) 取值：line_4, line_2 默认值：无

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CommonBuilder
```
public CommonBuilder(DDSConfig ddsConfig)
```
- 方法详细资料
  - setDeviceName
```
public DDSConfigBuilder.CommonBuilder setDeviceName(java.lang.String deviceName)
```
    设备 DeviceName, 用来标识设备的标识符
    取值：设备 DeviceName
    默认值：无
    
    参数:
    
    deviceName - 设备 DeviceName
    
    返回:
    
    CommonBuilder
  - setUserId
```
public DDSConfigBuilder.CommonBuilder setUserId(java.lang.String userId)
```
    用户ID
    取值：用户ID（保留字段）
    默认值：USER2021ID
    
    参数:
    
    userId - 用户ID
    
    返回:
    
    CommonBuilder
  - setInitTimeout
```
public DDSConfigBuilder.CommonBuilder setInitTimeout(int timeout)
```
    SDK初始化超时时间,单位秒
    默认值：60
    
    参数:
    
    timeout - 初始化超时时间,单位秒
    
    返回:
    
    CommonBuilder
  - setCustomSha256
```
public DDSConfigBuilder.CommonBuilder setCustomSha256(java.lang.String customSha256)
```
    自定义授权证书的SHA256, sdk 授权时会检查包名和签名的SHA256，第三方加固后可能改变，可以配置新的SHA256
    默认值：
    
    参数:
    
    customSha256 - 授权证书的SHA256
    
    返回:
    
    CommonBuilder
  - setDeviceId
```
public DDSConfigBuilder.CommonBuilder setDeviceId(java.lang.String deviceId)
```
    设备ID
    用于授权认证的原始设备ID，请务必确保设备ID唯一。若不填，则SDK自己收集设备ID。
    可以通过 DDS.getInstance().getDeviceName() 获取授权认证后的唯一ID
    取值：设备ID
    默认值：IMEI号
    
    参数:
    
    deviceId - 设备ID
    
    返回:
    
    CommonBuilder
  - setOfflineProfileName
```
public DDSConfigBuilder.CommonBuilder setOfflineProfileName(java.lang.String offlineProfileName)
```
    assets目录下的离线授权文件名
    取值：assets目录下的离线授权文件名
    默认值：
    
    参数:
    
    offlineProfileName - 离线授权文件名
    
    返回:
    
    CommonBuilder
  - setMessageQueueMaxSize
```
public DDSConfigBuilder.CommonBuilder setMessageQueueMaxSize(int messageQueueMaxSize)
```
    设置 sdk 内部的消息队列最大长度
    
    默认 500, 0表示不限制长度, 建议大于100
    
    动态库方法运行在一个单独的线程里，通过消息队列依次调用。在设备性能不好的设备上可以设置消息队列最大长度，防止算力不够导致内核无法及时处理完音频数据而导致内存过大的问题
    是否必需：否
    默认值：500
    
    参数:
    
    messageQueueMaxSize - 消息队列最大长度
    
    返回:
    
    CommonBuilder
  - enableReplaceProfile
```
public DDSConfigBuilder.CommonBuilder enableReplaceProfile(boolean enable)
```
    试用授权是否连网更新成在线授权
    默认值：true
    
    参数:
    
    enable - 是否连网更新成在线授权
    
    返回:
    
    CommonBuilder
  - enableUpdateNotification
```
public DDSConfigBuilder.CommonBuilder enableUpdateNotification(boolean enable)
```
    是否使用内置的资源更新通知栏
    默认值：true
    
    参数:
    
    enable - 是否使用内置的资源更新通知栏
    
    返回:
    
    CommonBuilder
  - enableUpdateDuicore
```
public DDSConfigBuilder.CommonBuilder enableUpdateDuicore(boolean enable)
```
    是否更新语音资源
    默认值：false
    
    参数:
    
    enable - 是否更新语音资源
    
    返回:
    
    CommonBuilder
  - setProductLicenseId
```
public DDSConfigBuilder.CommonBuilder setProductLicenseId(java.lang.String productLicenseId)
```
    产品licenseID
    预分配licence模式下的参数
    默认值：无
    
    参数:
    
    productLicenseId - 产品 licenseID
    
    返回:
    
    CommonBuilder
  - setCachePath
```
public DDSConfigBuilder.CommonBuilder setCachePath(java.lang.String cachePath)
```
    缓存文件保存目录
    默认值：/sdcard/Android/data/包名/cache
    还需设置 setCacheSize(int)
    
    参数:
    
    cachePath - 缓存文件保存目录
    
    返回:
    
    CommonBuilder
    
    另请参阅:
    
    setCacheSize(int)
  - setCacheSize
```
public DDSConfigBuilder.CommonBuilder setCacheSize(int cacheSize)
```
    缓存文件大小限制
    是否必需：自定义缓存目录时必需
    默认值：无
    
    参数:
    
    cacheSize - 缓存文件大小
    
    返回:
    
    CommonBuilder
    
    另请参阅:
    
    setCachePath(java.lang.String)
  - setCustomZip
```
public DDSConfigBuilder.CommonBuilder setCustomZip(java.lang.String customZip)
```
    使用内置产品资源包, 从官网下载的产品资源包一般叫 product.zip
    取值：assets目录下为压缩包名称，其他目录为绝对路径
    默认值：无
    
    参数:
    
    customZip - 产品资源包
    
    返回:
    
    CommonBuilder
  - setDuicoreHome
```
public DDSConfigBuilder.CommonBuilder setDuicoreHome(java.lang.String duicoreHome)
```
    duicore 资源存放的目录
    取值：绝对路径
    默认值：/data/data/包名/files/dds/duicore/
    
    参数:
    
    duicoreHome - duicore资源存放的目录
    
    返回:
    
    CommonBuilder
  - setCustomHome
```
public DDSConfigBuilder.CommonBuilder setCustomHome(java.lang.String customHome)
```
    产品资源存放的目录
    取值：绝对路径
    默认值：/data/data/com.xxx/files/dds/custom/
    
    参数:
    
    customHome - 产品资源存放的目录
    
    返回:
    
    CommonBuilder
  - setProductVersion
```
public DDSConfigBuilder.CommonBuilder setProductVersion(java.lang.String productVersion)
```
    连接指定产品版本的对话服务
    取值：版本号
    默认值：本地最新版本
    
    参数:
    
    productVersion - 产品版本
    
    返回:
    
    CommonBuilder
  - enableDynamicUiAgentPort
```
public DDSConfigBuilder.CommonBuilder enableDynamicUiAgentPort(boolean enable)
```
    是否使用 uiagent 动态端口号
    默认值：false
    
    参数:
    
    enable - 是否使用 uiagent 动态端口号
    
    返回:
    
    CommonBuilder
  - setAccessToken
```
public DDSConfigBuilder.CommonBuilder setAccessToken(java.lang.String accessToken)
```
    保留字段，上传、升级时使用
    
    参数:
    
    accessToken - accessToken
    
    返回:
    
    CommonBuilder
  - setVoipType
```
public DDSConfigBuilder.CommonBuilder setVoipType(java.lang.String voipType)
```
    使用 voip 功能时的类型，现在支持线性双麦(line_2)和线性4麦(line_4)
    取值：line_4, line_2
    默认值：无
    
    参数:
    
    voipType - voip 的类型
    
    返回:
    
    CommonBuilder
  - setVoipResBin
```
public DDSConfigBuilder.CommonBuilder setVoipResBin(java.lang.String voipResBin)
```
    voip 的资源的路径。assets目录下为压缩包名称，其他目录为绝对路径
    默认值：内置资源
    
    参数:
    
    voipResBin - voip 的资源
    
    返回:
    
    CommonBuilder
  - setDuicoreBackupZipUserDefined
```
public DDSConfigBuilder.CommonBuilder setDuicoreBackupZipUserDefined(java.lang.String duicoreBackupZipUserDefined)
```
    duicore 资源包保存路径
    取值：绝对路径
    默认值：无
    
    参数:
    
    duicoreBackupZipUserDefined - duicore 资源包保存路径
    
    返回:
    
    CommonBuilder
  - setCustomBackupZipUserDefined
```
public DDSConfigBuilder.CommonBuilder setCustomBackupZipUserDefined(java.lang.String customBackupZipUserDefined)
```
    产品资源包保存路径
    取值：绝对路径
    默认值：无
    
    参数:
    
    customBackupZipUserDefined - 产品资源包保存路径
    
    返回:
    
    CommonBuilder

类 DDSConfigBuilder.CommonBuilder

字段概要

从类继承的字段 com.aispeech.dui.dds.DDSConfigBuilder.BaseBuilder

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

CommonBuilder

方法详细资料

setDeviceName

setUserId

setInitTimeout

setCustomSha256

setDeviceId

setOfflineProfileName

setMessageQueueMaxSize

enableReplaceProfile

enableUpdateNotification

enableUpdateDuicore

setProductLicenseId

setCachePath

setCacheSize

setCustomZip

setDuicoreHome

setCustomHome

setProductVersion

enableDynamicUiAgentPort

setAccessToken

setVoipType

setVoipResBin

setDuicoreBackupZipUserDefined

setCustomBackupZipUserDefined