使用 String 型用户 ID
- Java
更新时间
了解如何在 RTC 服务端 SDK 中字符串型用户 ID,包括适用场景、配置步骤、实现要点和注意事项。
声网服务端网关 SDK 同时支持 int 型用户 ID 和 String 型用户 ID。
本文介绍如何使用 String 型用户 ID。
实现方法
-
在初始化
AgoraService对象时,调用AgoraServiceConfiguration.setUseStringUid(1)。Java // Creates an AgoraService object AgoraService service = new AgoraService(); if (null == service) { System.out.printf("createAndInitAgoraService fail\n"); return; } AgoraServiceConfig config = new AgoraServiceConfig(); // Disables the audio device module (Normally we do not directly connect audio capture or playback devices to a server) config.setEnableAudioDevice(0); // Enables the audio processing module config.setEnableAudioProcessor(1); // Enables video config.setEnableVideo(1); // Enables user ID in String format config.setUseStringUid(1); int ret = service.initialize(config); if (ret != 0) { System.out.printf("createAndInitAgoraService AgoraService.initialize fail ret=%d\n", ret); return; } service.setLogFile("agorasdk.log",10*1024); -
调用
connect连接声网 RTC 频道。Java RtcConnConfig ccfg = new RtcConnConfig(); ccfg.setAutoSubscribeAudio(0); ccfg.setAutoSubscribeVideo(0); ccfg.setChannelProfile(Constants.CHANNEL_PROFILE_LIVE_BROADCASTING); ccfg.setClientRoleType(Constants.CLIENT_ROLE_BROADCASTER); AgoraRtcConn conn = service.agoraRtcConnCreate(ccfg); if (conn == null) { System.out.printf("AgoraService.agoraRtcConnCreate fail\n"); return; } conn.connect(token, "demo_channel", "1");
订阅用户注意事项
在初始化 AgoraService 对象时开启 String 型用户 ID 的设置会在调用 connect 成功连接频道之后生效。因此,在成功连接频道之前,SDK 使用的用户 ID 模式仍然为 int 型。你无法订阅包含数字之外的字符的用户 ID。如果你在成功连接频道之前调用 subscribe 方法订阅了特定 uid,uid 的字符必须仅包含数字。connect 完成之后,你可以订阅包含其他字符类型的用户 ID。
其他注意事项
-
int型用户 ID 支持的字符集包括:- 10 个数字 0-9
-
String型用户 ID 支持的字符集包括:- 26 个小写英文字母 a~z
- 26 个大写英文字母 A~Z
- 10 个数字 0-9
- 空格
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
-
String型用户 ID 能且只能与String型用户 ID 互通。如果一个频道内同时存在String型用户 ID 和int型用户 ID,会导致未知的错误。 -
和
int型用户 ID 不同,在调用connect方法时,你必须给userId赋值。将其设为null会报错。 -
String型用户 ID 必须是频道内唯一的。