Skip to content

Latest commit

 

History

History

example

README.md

agora_rtc_engine_example

Overview

This project is an open-source demo that will show you different scenes on how to integrate agora_rtc_engine APIs into your project.

Any scene of this project can run successfully alone.

Project structure

Basic demos

Demo Description APIs
JoinChannelAudio Audio live streaming
JoinChannelVideo Video live streaming
StringUid String user ID

Advanced demos

Demo Description APIs
AudioMixing Audio mixing
ChannelMediaRelay Channel media relay
DeviceManager Device Manager
EnableVirtualBackground Enable Virtual Background
JoinMultipleChannel Join multiple channels
MediaPlayer MediaPlayer
RTMPStreaming RTMP streaming
ScreenSharing Screen sharing
SendMetadata Send Metadata
SendMultiCameraStream Send Multi Camera Stream
SendMultiVideoStream Send Multi Video Stream
SetBeautyEffect SetBeautyEffect
SetContentInspect SetContentInspect
SetContentInspect SetContentInspect
SetEncryption Set encryption
SetVideoEncoderConfiguration Set video encoder configuration
StartDirectCDNStreaming Set video encoder configuration
StartLocalVideoTranscoder Start Local Video Transcoder
StartRhythmPlayer Start Rhythm Player
StreamMessage Send data stream
TakeSnapshot Take Snapshot
VoiceChanger Voice effects

How to run the sample project

Developer Environment Requirements

Steps to run

Steps from cloning the code to running the project

  1. Run flutter pub get.

  2. Enter the example folder.

  3. Open agora.config.dart file and specify your App ID and Token.

    See Set up Authentication to learn how to get an App ID and access token. You can get a temporary access token to quickly try out this sample project.

    The Channel name you used to generate the token must be the same as the channel name you use to join a channel.

    To ensure communication security, Agora uses access tokens (dynamic keys) to authenticate users joining a channel.

    Temporary access tokens are for demonstration and testing purposes only and remain valid for 24 hours. In a production environment, you need to deploy your own server for generating access tokens. See Generate a Token for details.

  4. Make the project and run the app in the simulator or connected physical device.

You are all set! Feel free to play with this sample project and explore features of the agora_rtc_engine.