Skip to content

AgoraDoc/readme-templates-for-sample_projects

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 

Repository files navigation

<Title> The title should be a brief description of the project, such as "Sample projects for the Agora RTC Android SDK"

English | 中文

Overview

This repository contains sample projects using the Agora RTC XXX SDK .

image_of_a_running_project

Project structure

The project uses a single app to combine a variety of functionalities.

Function Location
Function description Link to the source file
Function description Link to the source file
... ...

How to run the sample project

Prerequisites

Necessary requirements for the project to run.

  • Requirement 1
  • Requirement 2
  • Requirement 3

Steps to run

Steps from cloning the code to running the project

  1. First step

  2. Second step

  3. Open xxx file and specify your App ID and Token.

    See Get Started with Agora 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. Keep the list until the project is up and running

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.

About

Readme templates for Agora sample projects

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published