An open API service indexing awesome lists of open source software.

https://github.com/ekaansharora/agora-rn-broadcast-quickstart

Quickstart for Live Broadcasting on react-native using Agora.io SDK.
https://github.com/ekaansharora/agora-rn-broadcast-quickstart

Last synced: 21 days ago
JSON representation

Quickstart for Live Broadcasting on react-native using Agora.io SDK.

Awesome Lists containing this project

README

        

# Agora React Native Broadcasting Demo

Quickstart for live-broadcasting on react-native using Agora.io SDK.
Use this guide to quickly start a multiple user live broadcast.

You can also check out the updated version using [functional components](https://github.com/EkaanshArora/Agora-RN-Broadcast-Quickstart/tree/functional-components).

## Prerequisites
* '>= react native 0.60.x'
* iOS SDK 8.0+ (and a recent version of XCode and cocoapods)
* Android 5.0+ x86 arm64 armv7a
* A valid Agora account ([Sign up](https://dashboard.agora.io/) for free)

Open the specified ports in Firewall Requirements if your network has a firewall.

## Running this example project

### Structure

```
.
├── android
├── components
│ └── Permission.ts
│ └── Style.ts
├── ios
├── App.tsx
├── index.js
.
```

### Generate an App ID

In the next step, you need to use the App ID of your project. Follow these steps to [create an Agora project](https://docs.agora.io/en/Agora%20Platform/manage_projects?platform=All%20Platforms) in Console and get an [App ID](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#a-nameappidaapp-id ).

1. Go to [Console](https://dashboard.agora.io/) and click the **[Project Management](https://dashboard.agora.io/projects)** icon on the left navigation panel.
2. Click **Create** and follow the on-screen instructions to set the project name, choose an authentication mechanism (for this project select App ID without a certificate), and Click **Submit**.
3. On the **Project Management** page, find the **App ID** of your project.

Check the end of document if you want to use App ID with certificate.

### Steps to run our example

* Download and extract the zip file from the master branch.
* Run npm install or use yarn to install the app dependencies in the unzipped directory.
* Navigate to `./src/App.tsx` and edit line 26 to enter your App ID that we generated.
* If you're using secure mode in the Agora Console, add a token to the token variable on line 25. (You can generate temporary tokens in the Agora Console)
* Connect your device and run `react-native run-android` / `react-native run-ios` to start the app.

The app uses `channel-x` as the channel name.

## Sources
* Agora [API doc](https://docs.agora.io/en/)