連線用戶列表

更新時間：2024-10-10 17:27:10

本文檔主要講述連線用戶列表及節點 ConnectMicItem 的 API 說明。

一、連線列表

1.1 取得連線列表

觀眾觀看連線用戶串流方式：

當觀眾未連線時，以混流方式觀看；
當觀眾連線後，以 RTC 串流觀看；

當觀眾上麥或連線用戶串流加入後觸發 ConnectMicEvents.ConnectMicDataChange 事件，開發者透過事件的 micDatas 或 getMicDatas 方法取得連線用戶列表。

API 方法： getMicDatas(): ConnectMicItemData[]

回傳值說明： ConnectMicItemData[] 類型

範例：

watchCore.connectMic.eventEmitter.on(ConnectMicEvents.ConnectMicDataChange, () => {
  const micDatas = watchCore.connectMic.getMicDatas();
  console.log('连麦用户列表', micDatas);
});

1.2 連線節點資料

Interface 介面： ConnectMicItemData

屬性名稱	說明	類型
`userId`	用戶 ID	`string`
`nickname`	用戶暱稱	`string`
`avatar`	用戶頭像	`string`
`userType`	用戶類型	`ChatUserType`
`isLocal`	是否為本地推流	`boolean`
`isMaster`	是否為主講	`boolean`
`currentVolume`	當前音量(0 ~ 1)	`number`
`isAudioMuted`	是否關閉麥克風	`boolean`
`isVideoMuted`	是否關閉攝影機	`boolean`
`pusherAttributes`	推流參數	`PusherAttributes`
`playerAttributes`	拉流參數	`PlayerAttributes`

二、連線資料事件

當連線列表發生改變時會觸發 ConnectMicEvents.ConnectMicDataChange 連線列表修改事件，場景包括：上下麥、連線用戶麥克風和攝影機狀態更改、音量更改等，開發者在取得新的連線列表資料後，需要將資料中的 pusherAttributes 或 playerAttributes 重新賦值給 <live-pusher> 或 <live-player>，詳細可參考 demo 中的 <connect-mic-player> 元件。