[ PROMPT_NODE_24268 ]
Realtimekit API 参考
[ SKILL_DOCUMENTATION ]
# RealtimeKit API 参考
会议对象、REST 接口和 SDK 方法的完整 API 参考。
## 会议对象 API
### `meeting.self` - 本地参与者
typescript
// 属性: id, userId, name, audioEnabled, videoEnabled, screenShareEnabled, audioTrack, videoTrack, screenShareTracks, roomJoined, roomState
// 方法
await meeting.self.enableAudio() / disableAudio() / enableVideo() / disableVideo() / enableScreenShare() / disableScreenShare()
await meeting.self.setName("Name") // 仅限加入前
await meeting.self.setDevice(device)
const devices = await meeting.self.getAllDevices() / getAudioDevices() / getVideoDevices() / getSpeakerDevices()
// 事件: 'roomJoined', 'audioUpdate', 'videoUpdate', 'screenShareUpdate', 'deviceUpdate', 'deviceListUpdate'
meeting.self.on('roomJoined', () => {})
meeting.self.on('audioUpdate', ({ audioEnabled, audioTrack }) => {})
### `meeting.participants` - 远程参与者
**集合**:
typescript
meeting.participants.joined / active / waitlisted / pinned // 映射
const participants = meeting.participants.joined.toArray()
const count = meeting.participants.joined.size()
const p = meeting.participants.joined.get('peer-id')
**参与者属性**:
typescript
participant.id / userId / name
participant.audioEnabled / videoEnabled / screenShareEnabled
participant.audioTrack / videoTrack / screenShareTracks
**事件**:
typescript
meeting.participants.joined.on('participantJoined', (participant) => {})
meeting.participants.joined.on('participantLeft', (participant) => {})
### `meeting.meta` - 元数据
typescript
meeting.meta.meetingId / meetingTitle / meetingStartedTimestamp
### `meeting.chat` - 聊天
typescript
meeting.chat.messages // 数组
await meeting.chat.sendTextMessage("Hello") / sendImageMessage(file)
meeting.chat.on('chatUpdate', ({ message, messages }) => {})
### `meeting.polls` - 投票
typescript
meeting.polls.items // 数组
await meeting.polls.create(question, options, anonymous, hideVotes)
await meeting.polls.vote(pollId, optionIndex)
### `meeting.plugins` - 协作应用
typescript
meeting.plugins.all // 数组
await meeting.plugins.activate(pluginId) / deactivate()
### `meeting.ai` - AI 功能
typescript
meeting.ai.transcripts // 实时转录(在预设中启用时)
### 核心方法
typescript
await meeting.join() // 在 meeting.self 上触发 'roomJoined'
await meeting.leave()
## TypeScript