agorameeting-electron-sdk v1.0.12

agorameeting electron sdk

agora prebuilt config

// package.json
{
  ....
  "agora_prebuilt": {
    "prebuilt": true
  }
  ...
}
或者
// .npmrc
agora_electron:prebuilt=true

想要了解更多配置详情, 请访问 agora-electron-sdk.

安装

npm install agorameeting-electron-sdk

主进程

// electron > 12
const main = require('@electron/main')
main.initialize()
main.enable(xx.webContents) // xx为窗口实例

import { MainRtcEngine } from 'agorameeting-electron-sdk'

// 初始化main
const engine = new MainRtcEngine({
  debug: true,
})
engine.initialize()

预加载脚本中增加

// electron <= 12
const { remote } = require('electron')
// electron > 12
const remote = require('@electron/remote')

window.UzRtcMain = remote.getGlobal('UzRtcMain')

渲染进程

import { RtcEngine } from 'agorameeting-electron-sdk'
// 初始化renderer
const engine = new RtcEngine({
  setListener: true
})

// 登录
const r = await engine.login({
  userid: 'xx',
  ticket: 'xx',
  nickname: 'xxx',
  avatar: 'xxx'
})

// 创建会议
const { data: meeting } = engine.getMeetingService()

await meeting.create({
  title: 'xxx',
  ....
})

// 加入会议
await meeting.join({
  channelId: 'xxx',
  microphone: true,
  camera: true
})

// 离开会议
await meeting.leave()


// 会议OT
const { data: meetingOt } = engine.getInMeetingOtService()

// 更新OT
meetingOt.put({
  g: 'group',
  k: 'key',
  v: 'value'
})

// 删除OT
meetingOt.del({
  g: 'group',
  k: 'key'
})

// 获取OT
meetingOt.getGroup('group')

// 监听OT更新
meetingOt.on('put', (data, beforeData)=>{
  // ...
})

// 监听OT删除
meetingOt.on('del', (data, beforeData)=>{
  // ...
})