程序包 com.aispeech

类 DUILiteSDK

  • public class DUILiteSDK
extends java.lang.Object
    DUILiteSDK 是整个sdk的入口，包括以下功能：
    1. 初始化配置信息
    2. 提供获取 sdk 信息的方法
    3. auth 认证，只有认证成功后才能使用各个模块的功能

    • 字段概要

      字段 
      修饰符和类型 字段 说明
      static int authFailTimes
      授权失败次数 授权失败一次+1，最大是12 授权成功置0

    • 构造器概要

      构造器 
      构造器 说明
      DUILiteSDK()  

    • 方法概要

      所有方法 静态方法 具体方法 已过时的方法 
      修饰符和类型 方法 说明
      static void closeGlobalAudioSave()
      关闭全局音频存储
      static void closeVadCalcVolume()
      关闭vad音量计算反馈 所有引擎中Listener.onRmsChanged将不在被回调 默认开启
      static int getAudioRecorderType()  
      static java.lang.String getAuthParams​(java.lang.String productId)
      获取授权参数信息，用于请求云端服务
      static com.aispeech.auth.ProfileState getAuthState​(java.lang.String scopeType)
      获取授权文件状态
      static AuthType getAuthType()
      只试用于试用授权和在线授权切换 当试用授权授权成功之后,在试用授权状态,链接网络之后要主动授权一次,如果授权失败,还在试用授权类型 获取当前授权后类型,用于判断是否提示网络问题还是授权问题
      static java.lang.String getCoreVersion()
      获取内核版本号
      static java.lang.String getDeviceId​(android.content.Context context)
      获取SDK使用的deviceId
      static java.lang.String getDeviceName()
      获取SDK生成的deviceName
      static boolean getLocalSavedEnabled()
      已过时。
      use {isGlobalAudioSave()} instead
      static java.lang.String getSdkVersion()  
      static void init​(android.content.Context context, DUILiteConfig config, DUILiteSDK.InitListener listener)
      初始化授权信息
      static boolean isAuthorized​(android.content.Context context)
      检查是否授权成功(本地授权文件有效)
      static boolean isGlobalAudioSave()
      是否开启全局音频保存
      static boolean isSavingEngineAudioEnable​(int engine)
      该引擎的是否保存音频
      static void openGlobalAudioSave​(java.lang.String audioSavePath)
      设置全局音频存储路径 默认开启 比引擎单独设置的优先级更高，如需单独配置各引擎保存地址，可传入null
      static void openLog​(android.content.Context context, java.lang.String logFilePath)
      打开sdk日志 日志打开，性能会受影响，调试时可打开日志, 默认日志关闭
      static void openLog​(android.content.Context context, java.lang.String logFilePath, int cachedDays)
      打开sdk日志 日志打开，性能会受影响，调试时可打开日志, 默认日志关闭
      static void openLog​(android.content.Context context, java.lang.String logFilePath, int cachedDays, java.lang.String deviceId, java.lang.String apiKey, java.lang.String apiSecret, boolean salvageEnabled)
      打开sdk日志 日志打开，性能会受影响，调试时可打开日志, 默认日志关闭
      static void setCustomLog​(com.aispeech.common.CustomLog customLog)
      用户自定义log，用于客户自行实现自己的log逻辑，将SDK的log使用客户的log机制实现，将所有的log统一归类，调用此接口之后 不需要在调用openLog(Context, String) 和openLog(Context, String, int)
      static void setDebugMode​(int logLevel)
      设置SDK日志级别，默认W-3 {V = 2 , D =3 , I = 4 , W = 5 , E = 6, A = 7}
      static void setDebugMode​(int logLevel, java.lang.String logFilePath)
      已过时。 
      static void setGlobalAudioSaveEnable​(boolean globalAudioSaveEnable)
      已过时。
      static void setGlobalAudioSaveEngines​(int engine)
      设置要保存音频的模块，其他模块则不会保存音频 支持多个模块配置 例如 setGlobalAudioSaveEngines(SpeechParams.Engine.ECHO | SpeechParams.Engine.CLOUD_ASR); 默认是全开,多次设置或配置setGlobalDisableAudioSaveEngines会覆盖
      static void setGlobalAudioSavePath​(java.lang.String globalAudioSavePath)
      已过时。
      static void setGlobalDisableAudioSaveEngines​(int engine)
      设置不保存音频的模块,其他模块则会保存音频 支持多个模块配置 多次设置会覆盖，注意同时设置setGlobalAudioSaveEngine会覆盖
      static void setGlobalLogLevel​(int globalLogLevel)
      设置 LiteSDK 全局日志等级 默认 android.util.Log.WARN {V = 2 , D =3 , I = 4 , W = 5 , E = 6, A = 7}
      static void setJavaLiteLogLevel​(int logLevel)
      设置 Java lite层日志等级 默认 android.util.Log.WARN {V = 2 , D =3 , I = 4 , W = 5 , E = 6, A = 7}
      static void setLocalSavedEnabled​(boolean localSavedEnabled)
      已过时。
      use {openGlobalAudioSave(String)}
      static void setNativeLogLevel​(int nativeLogLevel)
      设置 SDK 内核层日志等级 默认 android.util.Log.WARN {V = 2 , D =3 , I = 4 , W = 5 , E = 6, A = 7}

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

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • 字段详细资料

      • authFailTimes

        public static int authFailTimes
        授权失败次数 授权失败一次+1，最大是12 授权成功置0

    • 构造器详细资料

      • DUILiteSDK

        public DUILiteSDK()

    • 方法详细资料

      • getSdkVersion

        public static java.lang.String getSdkVersion()

      • getCoreVersion

        public static java.lang.String getCoreVersion()
        获取内核版本号
        返回:
        core_version

      • getDeviceId

        public static java.lang.String getDeviceId​(android.content.Context context)
        获取SDK使用的deviceId
        参数:
        context - context
        返回:
        deviceId

      • getDeviceName

        public static java.lang.String getDeviceName()
        获取SDK生成的deviceName
        返回:
        deviceName

      • getAuthType

        public static AuthType getAuthType()
        只试用于试用授权和在线授权切换 当试用授权授权成功之后,在试用授权状态,链接网络之后要主动授权一次,如果授权失败,还在试用授权类型 获取当前授权后类型,用于判断是否提示网络问题还是授权问题
        返回:
        AuthType

      • getAuthParams

        public static java.lang.String getAuthParams​(java.lang.String productId)
        获取授权参数信息，用于请求云端服务
        参数:
        productId - 产品id
        返回:
        授权参数信息

      • setCustomLog

        public static void setCustomLog​(com.aispeech.common.CustomLog customLog)
        用户自定义log，用于客户自行实现自己的log逻辑，将SDK的log使用客户的log机制实现，将所有的log统一归类，调用此接口之后 不需要在调用openLog(Context, String) 和openLog(Context, String, int)
        参数:
        customLog - 客户自定义的log类

      • setGlobalLogLevel

        public static void setGlobalLogLevel​(int globalLogLevel)
        设置 LiteSDK 全局日志等级 默认 android.util.Log.WARN {V = 2 , D =3 , I = 4 , W = 5 , E = 6, A = 7}
        参数:
        globalLogLevel - 日志级别

      • setJavaLiteLogLevel

        public static void setJavaLiteLogLevel​(int logLevel)
        设置 Java lite层日志等级 默认 android.util.Log.WARN {V = 2 , D =3 , I = 4 , W = 5 , E = 6, A = 7}
        参数:
        logLevel - 日志级别

      • setNativeLogLevel

        public static void setNativeLogLevel​(int nativeLogLevel)
        设置 SDK 内核层日志等级 默认 android.util.Log.WARN {V = 2 , D =3 , I = 4 , W = 5 , E = 6, A = 7}
        参数:
        nativeLogLevel - 日志级别

      • openLog

        public static void openLog​(android.content.Context context,
                           java.lang.String logFilePath)
        打开sdk日志 日志打开，性能会受影响，调试时可打开日志, 默认日志关闭
        参数:
        context - 上下文
        logFilePath - 保存的日志文件路径，包含文件名，比如"/sdcard/duilite/DUILite_SDK.log"

      • openLog

        public static void openLog​(android.content.Context context,
                           java.lang.String logFilePath,
                           int cachedDays)
        打开sdk日志 日志打开，性能会受影响，调试时可打开日志, 默认日志关闭
        参数:
        context - 上下文
        logFilePath - 保存的日志文件路径，包含文件名，比如"/sdcard/duilite/DUILite_SDK.log"
        cachedDays - 日志的清理周期，单位天

      • openLog

        public static void openLog​(android.content.Context context,
                           java.lang.String logFilePath,
                           int cachedDays,
                           java.lang.String deviceId,
                           java.lang.String apiKey,
                           java.lang.String apiSecret,
                           boolean salvageEnabled)
        打开sdk日志 日志打开，性能会受影响，调试时可打开日志, 默认日志关闭
        参数:
        context - 上下文
        logFilePath - 保存的日志文件路径，包含文件名，比如"/sdcard/duilite/DUILite_SDK.log"
        cachedDays - 日志的清理周期，单位天
        apiKey - apikey，日志回捞使用
        apiSecret - APISecret，日志回捞使用
        deviceId - deviceId，日志回捞使用
        salvageEnabled - 是否使用回捞功能

      • isAuthorized

        public static boolean isAuthorized​(android.content.Context context)
        检查是否授权成功(本地授权文件有效)
        参数:
        context - 上下文
        返回:
        true:成功; false:失败

      • getAuthState

        public static com.aispeech.auth.ProfileState getAuthState​(java.lang.String scopeType)
        获取授权文件状态
        参数:
        scopeType - 模块类型，null表示不检查模块
        返回:
        授权文件状态值

      • setDebugMode

        public static void setDebugMode​(int logLevel,
                                java.lang.String logFilePath)
        已过时。
        设置SDK日志级别，默认W-3 {V = 2 , D =3 , I = 4 , W = 5 , E = 6, A = 7}
        参数:
        logLevel - 日志级别
        logFilePath - 日志保存绝对路径

      • setDebugMode

        public static void setDebugMode​(int logLevel)
        设置SDK日志级别，默认W-3 {V = 2 , D =3 , I = 4 , W = 5 , E = 6, A = 7}
        参数:
        logLevel - 日志级别

      • init

        public static void init​(android.content.Context context,
                        DUILiteConfig config,
                        DUILiteSDK.InitListener listener)
        初始化授权信息
        参数:
        context - 上下文
        config - 配置参数，包括产品的 APPKEY，产品ID，产品KEY，产品SECRET，以及其它的全局配置参数
        listener - 授权回调

      • closeVadCalcVolume

        public static void closeVadCalcVolume()
        关闭vad音量计算反馈 所有引擎中Listener.onRmsChanged将不在被回调 默认开启

      • setLocalSavedEnabled

        public static void setLocalSavedEnabled​(boolean localSavedEnabled)
        已过时。
        use {openGlobalAudioSave(String)}

      • openGlobalAudioSave

        public static void openGlobalAudioSave​(java.lang.String audioSavePath)
        设置全局音频存储路径 默认开启 比引擎单独设置的优先级更高，如需单独配置各引擎保存地址，可传入null
        参数:
        audioSavePath - /sdcard/aispeech/

      • isGlobalAudioSave

        public static boolean isGlobalAudioSave()
        是否开启全局音频保存
        返回:
        是否开启全局音频保存

      • closeGlobalAudioSave

        public static void closeGlobalAudioSave()
        关闭全局音频存储

      • setGlobalAudioSavePath

        @Deprecated
public static void setGlobalAudioSavePath​(java.lang.String globalAudioSavePath)
        已过时。

      • setGlobalAudioSaveEnable

        @Deprecated
public static void setGlobalAudioSaveEnable​(boolean globalAudioSaveEnable)
        已过时。

      • setGlobalAudioSaveEngines

        public static void setGlobalAudioSaveEngines​(int engine)
        设置要保存音频的模块，其他模块则不会保存音频 支持多个模块配置 例如 setGlobalAudioSaveEngines(SpeechParams.Engine.ECHO | SpeechParams.Engine.CLOUD_ASR); 默认是全开,多次设置或配置setGlobalDisableAudioSaveEngines会覆盖
        参数:
        engine - Engines

      • setGlobalDisableAudioSaveEngines

        public static void setGlobalDisableAudioSaveEngines​(int engine)
        设置不保存音频的模块,其他模块则会保存音频 支持多个模块配置 多次设置会覆盖，注意同时设置setGlobalAudioSaveEngine会覆盖
        参数:
        engine -

      • isSavingEngineAudioEnable

        public static boolean isSavingEngineAudioEnable​(int engine)
        该引擎的是否保存音频
        参数:
        engine - Engines

      • getLocalSavedEnabled

        public static boolean getLocalSavedEnabled()
        已过时。
        use {isGlobalAudioSave()} instead

      • getAudioRecorderType

        public static int getAudioRecorderType()