用户信息

用户信息管理相关的 API。

getOnlineRemoteUsers

获取在线远端用户列表。

方法签名

getOnlineRemoteUsers(): string[]

返回值

string[] - 在线远端用户 ID 数组

使用示例

const onlineUsers = engine.getOnlineRemoteUsers();
console.log('在线用户:', onlineUsers);

onlineUsers.forEach(userId => {
  console.log('用户 ID:', userId);
});

getUserInfo

获取指定用户的信息。

方法签名

getUserInfo(uid: string): AliRtcRemoteUserInfo | undefined

参数说明

参数	类型	描述
uid	string	用户 ID

返回值

AliRtcRemoteUserInfo | undefined - 用户信息对象，如果用户不存在则返回 undefined

用户信息对象说明

interface AliRtcRemoteUserInfo {
  // 用户 ID
  userId: string;
  // 用户显示名称
  displayName?: string;
  // 是否推送音频
  hasAudio: boolean;
  // 是否推送视频
  hasVideo: boolean;
  // 是否推送屏幕共享
  hasScreen: boolean;
  // 音频是否静音
  isAudioMuted: boolean;
  // 视频是否静音
  isVideoMuted: boolean;
}

使用示例

const userInfo = engine.getUserInfo('user123');
if (userInfo) {
  console.log('用户名:', userInfo.displayName);
  console.log('是否有音频:', userInfo.hasAudio);
  console.log('是否有视频:', userInfo.hasVideo);
  console.log('是否有屏幕共享:', userInfo.hasScreen);
}

isUserOnline

检查指定用户是否在线。

方法签名

isUserOnline(uid: string): boolean

参数说明

参数	类型	描述
uid	string	用户 ID

返回值

• true: 用户在线
• false: 用户不在线

使用示例

const isOnline = engine.isUserOnline('user123');
console.log('用户是否在线:', isOnline);

if (isOnline) {
  // 用户在线，可以进行订阅操作
  await engine.subscribeRemoteVideoStream('user123', true, 1);
}

属性

channel

获取当前频道号。

类型

readonly channel: string | undefined

说明

• 已入会成功返回频道号
• 未入会返回 undefined

使用示例

const currentChannel = engine.channel;
console.log('当前频道:', currentChannel);

userId

获取当前用户的 userId。

类型

readonly userId: string | undefined

说明

• 已入会成功返回自己的 userId
• 未入会返回 undefined

使用示例

const myUserId = engine.userId;
console.log('我的用户 ID:', myUserId);

remoteUsers

获取远端用户列表。

类型

readonly remoteUsers: RemoteUser[]

说明

返回当前频道内所有远端用户的详细信息数组。

使用示例

const remoteUsers = engine.remoteUsers;
console.log('远端用户数量:', remoteUsers.length);

remoteUsers.forEach(user => {
  console.log('用户 ID:', user.userId);
  console.log('用户状态:', user);
});