API概览
ARTalkClient
ARTalkClientListener
ARTalkChannel
ARTalkChannelListener
AudioQuality
ResultCallback
状态码和错误码

ARTalkClient

最近更新时间：2023-02-21 10:39:53

详细描述
成员函数说明
createInstance
login
logout
release
renewToken
createChannel
setDefaultPushAudioQuality
setDefaultPullAudioQuality
enableAudioCapture
enableLocalAudioRecord
enableLocalMicDataCallback
enableLocalSpeakerDataCallback
createChannel
setLogFile
setLogFileSize
setLogFilter
getSdkVersion
setParameters
Public 成员函数
ARTalkClientcreateInstance (@NonNull Context context, @NonNull String appId, @NonNull ARTalkClientListener eventListener)
voidrelease ()
voidlogin (@Nullable String token, @NonNull String userId,String userData,@Nullable ResultCallback resultCallback)
voidlogout (@Nullable ResultCallback resultCallback)
intrenewToken ()
intsetDefaultPushAudioQuality (AudioQuality quality)
intsetDefaultPullAudioQuality (AudioQuality quality)
intenableAudioCapture (boolean enable)
intenableLocalAudioRecord (boolean enable, String path)
intenableLocalMicDataCallback (boolean enable)
intenableLocalSpeakerDataCallback (boolean enable, String channelId)
intsetParameters (String parameters)
ARTalkChannelcreateChannel (String channelId,ARTalkChannelListener channelListener )
intsetLogFile (String path)
intsetLogFilter (LOG_FILTER_TYPE filter)
intsetLogFileSize (int size)
StringgetSdkVersion()

详细描述

RTK SDK 方法

成员函数说明

createInstance

public static ARTalkClient createInstance(@NonNull Context context, @NonNull String appId, @NonNull ARTalkClientListener eventListener)

初始化一个 ARTalkClient 实例

参数说明
context安卓活动（Android Activity）的上下文。
appIdanyRTC 发给你的 App ID。 如果 SDK 中缺少 App ID，请从 anyRTC 申请新的 App ID。
eventListenerr一个 ARTalkClientListener 对象，用于上传 anyRTC RTK SDK 运行事件给应用程序。

返回

一个 ARTalkClient 实例

login

void login(@Nullable String token, @NonNull String userId,String userData,@Nullable ResultCallback<Void> resultCallback);

登录 anyRTC RTK 系统

参数说明
token用于登录 anyRTC RTK 系统的动态密钥。开启动态鉴权后可用。集成及测试阶段请将 token 设置为 空字符串“ ”。
userId登录 anyRTC RTK 系统的用户 ID。该字符串不可超过 64 字节。不可设为空、null 或 "null"。以下为支持的字符集范围:
  • 26 个小写英文字母 a-z
  • 26 个大写英文字母 A-Z
  • 10 个数字 0-9
  • 空格
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "~", ",","¦"
    • userData自定义信息
    resultCallback登录结果回调

    登录失败错误码详见 LOGIN_ERR_CODE。

    注意事项：

    • 异地登录后之前的状态（目前主要是加入的频道）不会保留。
    • 如果你在不同实例中以相同用户 ID 登录，之前的登录将会失效，你会被踢出之前加入的频道。
    • 只有在调用本方法成功加入频道后（即：当收到 onSuccess回调时才可以调用 RTK 的核心业务逻辑。

    logout

    void  logout(@Nullable ResultCallback<Void> resultCallback)
    参数说明
    resultCallback结果回调

    登出 anyRTC RTK 系统

    release

    void release()

    释放实例使用的所有资源。

    renewToken

    int renewToken(String token)

    更新当前的 RTK Token

    在收到 onTokenWillExpired 回调时你需要调用此方法更新 Token。 onRenewTokenResult 回调会返回 Token 更新的结果。该方法的调用频率为 2 次每秒。

    参数说明
    token新的 RTK Token

    返回

    createChannel

    public abstract ARTalkChannel createChannel(@NonNull String channelId,ARTalkChannelListener channelListener)

    创建一个 RTK 频道

    参数说明
    channelIdanyRTC RTK 频道名称。该字符串不可超过 64 字节。不可设为空、null 或 "null"。以下为支持的字符集范围:
  • 26 个小写英文字母 a-z
  • 26 个大写英文字母 A-Z
  • 10 个数字 0-9
  • 空格
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "~", ",","¦"
    • channelListener详见 ARTalkChannelListener。

    返回

    一个 ARTalkChannel 对象

    异常描述
    Exception如果 appId 无效，或者 context和 channelListener其一为空，会返回异常信息。

    setDefaultPushAudioQuality

    int setDefaultPushAudioQuality(AudioQuality quality)

    设置默认推流音频质量

    参数说明
    quality见AudioQuality

    返回

    • 0: 方法调用成功。
    • ≠0: 方法调用失败。

    setDefaultPullAudioQuality

    int setDefaultPullAudioQuality(int nQuality)

    设置默认拉流音频质量

    参数说明
    quality见AudioQuality

    返回

    • 0: 方法调用成功。
    • ≠0: 方法调用失败。

    enableAudioCapture

    int enableAudioCapture(boolean enable)

    开关音频采集模块

    参数说明
    enable设置true:打开音频采集模块，设置false，关闭音频采集模块

    返回

    • 0: 方法调用成功。
    • ≠0: 方法调用失败。

    注释：

    1. 上麦前必须先打开音频采集模块，才能上麦成功

    enableLocalAudioRecord

    int enableLocalAudioRecord(boolean enable, String path)

    开关本地音频录制模块

    参数

    参数说明
    enable设置true:打开音频录音模块，设置false，关闭音频录音模块
    path录音路径

    返回

    • 0: 方法调用成功。
    • ≠0: 方法调用失败。

    注释：

    1. 打开录制前必须先打开音频采集并申请上麦，才会有录音文件。

    2. 下麦、断网、被打断，如果之前设置了录制，会自动结束本地录制。

    enableLocalMicDataCallback

    int enableLocalMicDataCallback(boolean enable)

    开关本地录音音频数据回调

    根据回调的本地录音的音频数据，可以进行语音转文字，对声音进行分析等。

    参数说明
    enable设置true:打开本地录音音频数据回调，设置false，关闭本地录音音频数据回调

    返回

    • 0: 方法调用成功。
    • ≠0: 方法调用失败。

    enableLocalSpeakerDataCallback

    int enableLocalSpeakerDataCallback(boolean enable, String channelId)

    开关远程音频数据回调

    根据回调的其他人的音频数据，可以进行语音转文字，对声音进行分析等。

    参数说明
    enable设置true:打开其他人上麦音频数据回调，设置false，关闭其他人上麦音频数据回调
    channelId频道号

    返回

    • 0: 方法调用成功。
    • ≠0: 方法调用失败。

    createChannel

    ARTalkChannel createChannel(@NonNull String channelId,ARTalkChannelListener channelListener)

    创建频道

    参数说明
    channelId频道ID
    channelListener一个 ARTalkChannelListener 对象

    返回

    • ARTalkChannel: 方法调用成功。
    • null: 方法调用失败。

    setLogFile

    int setLogFile(String path)

    设定日志文件的默认地址

    参数说明
    path日志文件的绝对路径。logfile 的编码格式为 UTF-8。

    返回

    • 0: 方法调用成功。
    • ≠0: 方法调用失败。

    注意事项：

    1. 请确保指定的路径可写。
    2. Android 平台的日志默认路径为Android/data/app包名/files/ar_rtk_sdk.log

    setLogFileSize

    int setLogFileSize(int size)

    设置日志文件大小

    设置 SDK 输出日志文件的大小，单位为 KB。 SDK 设有 2 个日志文件，每个文件大小为 512 KB。如果你将 fileSizeInKByte 设置为 1024 KB， SDK 会最多输出 2 MB 的日志文件。

    参数说明
    size指定 SDK 输出日志文件的大小，单位为 KB。

    返回

    • 0: 方法调用成功。
    • ≠0: 方法调用失败。

    setLogFilter

    int setLogFilter(int filter)

    设置日志输出等级

    设置 SDK 的输出日志输出等级。不同的输出等级可以单独或组合使用。日志级别顺序依次为 OFF、CRITICAL、ERROR、WARNING 和 INFO。选择一个级别，你就可以看到在该级别之前所有级别的日志信息。例如，你选择 WARNING 级别，就可以看到在 CRITICAL、ERROR 和 WARNING 级别上的所有日志信息。

    参数说明
    filter日志输出等级。详见 LOG_FILTER_TYPE 。

    返回

    • 0: 方法调用成功。
    • ≠0: 方法调用失败。

    getSdkVersion

    String getSdkVersion()

    返回

    ​ SDK版本

    setParameters

    int setParameters(String parameters)

    通过 JSON 配置 SDK 提供技术预览或特别定制功能

    参数说明
    parametersJSON 格式的 SDK 选项。

    返回

    • 0: 方法调用成功。
    • ≠0: 方法调用失败。

    注释：

    1. JSON 选项默认不公开。anyRTC工程师正在努力寻求以标准化方式公开 JSON 选项。详情请联系 sales@dync.cc。