agora-rdc-webrtc-electron

Agora Remote Desktop Control Guides

Prerequisites

• Getting appId & certificate issued by agora, please read this docs
• Please make sure Node.js 10+ has been installed.

NOTICE

agora-rdc-webrtc-electron currently is only support electron >= 7.0.0

Quick Start

• Check our demos.

Starting in your project.

• Installation, Agora Remote Desktop Control depends on Agora RTC SDK (web), so you need install it first.

  • install agora-rtc-sdk-ng by npm or yarn:

    $ npm install agora-rtc-sdk-ng --save
    $ yarn add agora-rtc-sdk-ng
    

  • install Agora Remote Desktop Control SDK by npm or yarn:

    $ npm install agora-rdc-webrtc-electron --save
    $ yarn add agora-rdc-webrtc-electron
    

• Build your remote desktop control app. See api reference

NOTICE

• Cause electron's limitation, please in your main process register handlers.

  import registerHandlers from 'agora-rdc-webrtc-electron/lib/electron/registerHandlers';
  
  registerHandlers();
  

• You must have to add blow code in your webPreference, eg:

  import { BrowserWindow } from 'electron';
  
  mainWindow = new BrowserWindow({
     //...
     webPreferences: {
        webSecurity: false,
        nodeIntegration: true,
        enableRemoteModule: true,
        contextIsolation: false,
     },
  });
  

  if not our sdk can not communicating with electron's main process.