Skip to content

Latest commit

 

History

History
 
 

example

README.md

API-Example-Flutter

其他语言版本： 简体中文

Overview

This 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.

img.png

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
CustomCaptureAudio Custom audio capture
JoinMultipleChannel Join multiple channels
RTMPStreaming RTMP streaming
ScreenSharing Screen sharing
SetEncryption Set encryption
SetVideoEncoderConfiguration Set video encoder configuration
StreamMessage Send data stream
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.json 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 SDK.

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.