Skip to content

Latest commit

 

History

History

example

README.md

Agora-Electron-API-Example

The Example project is an open-source demo that will show you different scenes on how to integrate Agora SDK APIs into your project.

Any scene of this project can run successfully alone.

Quick Start

📋 Requirements

🎉 Steps to run

First, create a developer account at Agora.io, and obtain an App ID.

Then do the following:

git clone git@github.com:AgoraIO-Extensions/Electron-SDK.git
cd example
yarn
yarn start

(Optional) Build From Local SDK

# example path
rm -rf node_modules/agora-electron-sdk
# sdk path
cd .. && npm install --agora_electron_sdk_pre_built=false && yarn link
# example path
cd example && yarn link "agora-electron-sdk"

📖 Project structure

  • Basic demos:
Demo Description APIs
JoinChannelAudio basic demo to show audio call getAudioDeviceManager, setAudioProfile,setRecordingDevice, adjustRecordingSignalVolume, adjustAudioMixingPlayoutVolume, adjustPlaybackSignalVolume
JoinChannelVideo video demo with role selection in Editor Inspector enableVideo, getVideoDeviceManager,setChannelProfile, joinChannelEx, setAudioProfile, setVideoEncoderConfiguration
StringUid basic demo with string uid joinChannelWithUserAccount
  • Advanced demos:
Demo Description APIs
ScreenShare sharing application screen view getScreenCaptureSources, startPrimaryScreenCapture, startSecondaryScreenCapture, joinChannelEx
... ... ...
  • hooks demos:
Demo Description APIs
JoinChannelAudio basic demo to show audio call getAudioDeviceManager, setAudioProfile,setRecordingDevice, adjustRecordingSignalVolume, adjustAudioMixingPlayoutVolume, adjustPlaybackSignalVolume
JoinChannelVideo video demo with role selection in Editor Inspector enableVideo, getVideoDeviceManager,setChannelProfile, joinChannelEx, setAudioProfile, setVideoEncoderConfiguration
StringUid basic demo with string uid joinChannelWithUserAccount
JoinMultipleChannel Joins a channel with the connection ID joinChannelEx, updateChannelMediaOptionsEx
DeviceManager Management tool that can switch microphone and camera getVideoDeviceManager, getAudioDeviceManager
VirtualBackground Enables/Disables the virtual background (beta feature) enableExtension, enableVirtualBackground
AudioMixing Starts playing the music file startAudioMixing, pauseAudioMixing, resumeAudioMixing
TakeSnapshot Takes a snapshot of a video stream takeSnapshot
ScreenShare sharing application screen view getScreenCaptureSources, startPrimaryScreenCapture, startSecondaryScreenCapture,joinChannelEx

👏 Feedback

If you have any problems or suggestions regarding the sample projects, feel free to file an issue.

🚀 Reference

🚀 Related resources

  • Check our FAQ to see if your issue has been recorded.
  • Dive into Agora SDK Samples to see more tutorials
  • Take a look at Agora Use Case for more complicated real use case
  • Repositories managed by developer communities can be found at Agora Community
  • If you encounter problems during integration, feel free to ask questions in Stack Overflow

📄 License

The sample projects are under the MIT license.