很多 App 使用 String 类型的用户账号。为降低开发成本,声网新增支持 String 型的用户 ID,方便用户使用 App 账号直接加入声网频道。
声网的其他接口仍使用 UID 作为参数。声网维护一个 String 型 User account 和 Int 型 UID 的映射表,方便随时通过 User account 获取 UID 或者通过 UID 获取 User account。
为保证通信质量,频道内所有用户需使用同一数据类型的用户 ID,即频道内的所有用户 ID 应同为 Int 型或同为 String 型。
请确保你已了解实现基本的实时音视频功能的步骤及代码逻辑。详见开始音视频通话或开始互动直播。
参考如下步骤,在你的项目中实现使用 String 型用户 ID 加入频道:
registerLocalUserAccount
方法,注册本地用户的 User account。joinChannelWithUserAccount
方法,使用注册的 User account 加入频道。leaveChannel
方法。下图展示使用 User Account 加入频道的 API 调用时序:
其中:
registerLocalUserAccount
和 joinChannelWithUserAccount
方法中,userAccount
参数均为必填,不可为 null。registerLocalUserAccount
为选调。你可以注册后再调用 joinChannelWithUserAccount
方法加入频道,也可以不注册直接调用 joinChannelWithUserAccount
加入频道。我们建议你调用。提前调用 registerLocalUserAccount
可以减少调用 joinChannelWithUserAccount
加入频道的时间。getUserInfoByUid
或 getUserInfoByUserAccount
获取对应的 User Account 或 UID,无需自己维护映射表。你可以对照 API 时序图,参考下面的示例代码片段,在项目中实现使用 String 型用户 ID:
private void initializeAgoraEngine() {
try {
String appId = getString(R.string.agora_app_id);
mRtcEngine = RtcEngine.create(getBaseContext(), appId, mRtcEventHandler);
// 初始化后、加入频道前先注册用户 ID,可以缩短加入频道的时间
mRtcEngine.registerLocalUserAccount(appId, mLocal.userAccount);
} catch (Exception e) {
Log.e(LOG_TAG, Log.getStackTraceString(e));
throw new RuntimeException("NEED TO check rtc sdk init fatal error\n" + Log.getStackTraceString(e));
}
}
private void joinChannel() {
String token = getString(R.string.agora_access_token);
if (token.isEmpty()) {
token = null;
}
// 使用注册的用户 ID 加入频道
mRtcEngine.joinChannelWithUserAccount(token, "stringifiedChannel1", mLocal.userAccount);
}
同时,我们在 GitHub 提供一个开源的 String-Account 示例项目。你可以前往下载,或参考 CallActivity.java 文件中 initializeAgoraEngine
和 joinChannel
方法的源代码。
registerLocalUserAccount
joinChannelWithUserAccount
getUserInfoByUid
getUserInfoByUserAccount
onLocalUserRegistered
onUserInfoUpdated
uid
可以设为 String 型或 Number 型。