Skip to content

Commit

Permalink
add refactored readme
Browse files Browse the repository at this point in the history
  • Loading branch information
plutoless committed May 31, 2019
1 parent 2a4ff26 commit 3cb224e
Show file tree
Hide file tree
Showing 13 changed files with 741 additions and 0 deletions.
72 changes: 72 additions & 0 deletions Group-Video/OpenVideoCall-Android/README.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
Meta:
name: Open Video Call for Android
# en or cn
lang: en
# | 代表这里是字符串
description: |
The Open Video Call for Android Sample App is an open-source demo that will help you get video chat integrated directly into your Android applications using the Agora Video SDK.
With this sample app, you can:
- Join / leave channel
- Mute / unmute audio
- Enable / disable video
- Switch camera
- Send message to channel
- Setup resolution, frame rate and bit rate
- Enable encryption
- Enable / disable black and white filter
Prerequisites:
- Android Studio 3.3 or above
- Real devices (Nexus 5X or other devices)
- Some simulators are function missing or have performance issue, so real device is the best choice

QuickStart:
description:
This section shows you how to prepare, build, and run the sample application.
sections:
- title: Obtain an App ID
content: |
To build and run the sample application, get an App ID:
1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/).
2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation.
3. Copy the **App ID** from the Dashboard.
4. Update "app/src/main/res/values/strings_config.xml" with your App ID.
```
<string name="private_app_id"><#YOUR APP ID#></string>
```
- title: Integrate the Agora Video SDK
content: |
There are two ways to integrate:
- The recommended way to integrate:
- Add the address which can integrate the Agora Video SDK automatically through JCenter in the property of the dependence of the "app/build.gradle":
```
implementation 'io.agora.rtc:full-sdk:2.4.0'
```
(Adding the link address is the most important step if you want to integrate the Agora Video SDK in your own application.)
- Download the **Agora Video SDK** from [Agora.io SDK](https://www.agora.io/en/download/). Unzip the downloaded SDK package and copy ***.h** under **libs/include** to **app/src/main/cpp/agora**.
- Alternative way to integrate:
- Download the **Agora Video SDK** from [Agora.io SDK](https://www.agora.io/en/download/). Unzip the downloaded SDK package and copy ***.jar** under **libs** to **app/libs**, **arm64-v8a**/**x86**/**armeabi-v7a** under **libs** to **app/src/main/jniLibs**, ***.h** under **libs/include** to **app/src/main/cpp/agora**.
- Add the following code in the property of the dependence of the "app/build.gradle":
```
compile fileTree(dir: 'libs', include: ['*.jar'])
```
- title: Run the Application
content: |
Open project with Android Studio, connect your Android device, build and run.
Or use `Gradle` to build and run.
Resources:
document: https://docs.agora.io/en/
issue: https://github.com/AgoraIO/Basic-Video-Call/issues

License:
type: MIT
75 changes: 75 additions & 0 deletions Group-Video/OpenVideoCall-Android/README.zh.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
Meta:
name: Open Video Call for Android
# en or cn
lang: cn
# | 代表这里是字符串
description: |
这个开源示例项目演示了如何快速集成 Agora 视频 SDK,实现多人视频通话。
在这个示例项目中包含了以下功能:
- 加入通话和离开通话;
- 静音和解除静音;
- 关闭摄像头和打开摄像头;
- 切换前置摄像头和后置摄像头;
- 发送频道内消息;
- 选择分辨率、码率和帧率;
- 设置加密模式;
- 开启和关闭黑白滤镜;
你也可以在这里查看入门版的示例项目:[Agora-Android-Tutorial-1to1](https://github.com/AgoraIO/Basic-Video-Call/tree/master/One-to-One-Video/Agora-Android-Tutorial-1to1)
Prerequisites:
- Android Studio 3.3 +
- 真实 Android 设备 (Nexus 5X 或者其它设备)
- 部分模拟器会存在功能缺失或者性能问题,所以推荐使用真机

QuickStart:
description:
这个段落主要讲解了如何编译和运行实例程序。
sections:
- title: 创建Agora账号并获取AppId
content: |
在编译和启动实例程序前,您需要首先获取一个可用的App ID:
1. 在[agora.io](https://dashboard.agora.io/signin/)创建一个开发者账号
2. 前往后台页面,点击左部导航栏的 **项目 > 项目列表** 菜单
3. 复制后台的 **App ID** 并备注,稍后启动应用时会用到它
4. 将 AppID 填写进 "app/src/main/res/values/strings_config.xml"
```
<string name="private_app_id"><#YOUR APP ID#></string>
```
- title: 集成 Agora 视频 SDK
content: |
集成方式有以下两种:
- 首选集成方式:
- 在项目对应的模块的 "app/build.gradle" 文件的依赖属性中加入通过 JCenter 自动集成 Agora 视频 SDK 的地址:
```
implementation 'io.agora.rtc:full-sdk:2.4.0'
```
(如果要在自己的应用中集成 Agora 视频 SDK,添加链接地址是最重要的一步。)
- 在 [Agora.io SDK](https://www.agora.io/cn/download/) 下载 **视频通话 + 直播 SDK**,解压后将其中的 **libs**/**include** 文件夹下的 ***.h** 复制到本项目的 **app**/**src**/**main**/**cpp**/**agora** 下。
- 次选集成方式:
- 在 [Agora.io SDK](https://www.agora.io/cn/download/) 下载 **视频通话 + 直播 SDK**,解压后将其中的 **libs** 文件夹下的 ***.jar** 复制到本项目的 **app/libs** 下,其中的 **libs** 文件夹下的 **arm64-v8a**/**x86**/**armeabi-v7a** 复制到本项目的 **app/src/main/jniLibs** 下,其中的 **libs**/**include** 文件夹下的 ***.h** 复制到本项目的 **app**/**src**/**main**/**cpp**/**agora** 下。
- 在本项目的 "app/build.gradle" 文件依赖属性中添加如下依赖关系:
```
compile fileTree(dir: 'libs', include: ['*.jar'])
```
- title: 启动应用程序
content: |
用 Android Studio 打开该项目,连上设备,编译并运行。
也可以使用 `Gradle` 直接编译运行。
Resources:
document: https://docs.agora.io/cn/
issue: https://github.com/AgoraIO/Basic-Video-Call/issues

License:
type: MIT
67 changes: 67 additions & 0 deletions Group-Video/OpenVideoCall-Web/README.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
Meta:
name: Open Video Call for Web
# en or cn
lang: en
# | 代表这里是字符串
description: |
This tutorial shows you how to quickly create an open video call using the Agora sample app.
Prerequisites:
- Node.js 6.9.1+
- A web server that supports SSL (https)

QuickStart:
description:
This section shows you how to prepare, build, and run the sample application.
sections:
- title: Obtain an App ID
content: |
To build and run the sample application, get an App ID:
1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/).
2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation.
3. Copy the **App ID** from the Dashboard.
- title: Install dependencies and integrate the Agora Video SDK
content: |
1. Open the **src/utils/Settings.js** file. At the bottom of the file, replace `<#YOUR APP ID#>` with the App ID from the dashboard.
**Note:** Place the App ID within single or double quotes.
```xml
export const APP_ID = <#YOUR APP ID#>;
```
2. Using the Terminal app, enter the `install` command in your project directory. This command installs libraries that are required to run the sample application.
``` bash
# install dependencies
npm install
```
3. Start the application by entering the `run dev` or `run build` command.
The `run dev` command is for development purposes.
``` bash
# serve with hot reload at localhost:8080
npm run dev
```
The `run build` command is for production purposes and minifies code.
``` bash
# build for production with minification
npm run build
```
4. Your default browser should open and display the sample application, as shown here.
![index.jpg](images/index.jpg)
**Note:** In some cases, you may need to open a browser and enter `http://localhost:8080` as the URL.
Resources:
document: https://docs.agora.io/en/
issue: https://github.com/AgoraIO/Basic-Video-Call/issues

License:
type: MIT
47 changes: 47 additions & 0 deletions Group-Video/OpenVideoCall-Web/README.zh.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
Meta:
name: Open Video Call for Web
# en or cn
lang: cn
# | 代表这里是字符串
description: |
这个开源示例项目演示了如何快速集成 Agora 视频 SDK,实现多人视频通话。
Prerequisites:
- Node.js 6.9.1+
- 支持SSL(https)的服务器

QuickStart:
description:
这个段落主要讲解了如何编译和运行示例程序。
sections:
- title: 创建Agora账号并获取AppId
content: |
在编译和启动实例程序前,您需要首先获取一个可用的App ID:
1. 在[agora.io](https://dashboard.agora.io/signin/)创建一个开发者账号
2. 前往后台页面,点击左部导航栏的 **项目 > 项目列表** 菜单
3. 复制后台的 **App ID** 并备注,稍后启动应用时会用到它
- title: 集成 Agora 视频 SDK
content: |
1. 打开 **src/utils/Settings.js** 文件。在文件的底部,将`<#YOUR APP ID#>`替换为您自己的App ID
**注意:** App ID是字符串类型,需要双引号或者单引号
```javascript
export const APP_ID = <#YOUR APP ID#>;
```
2. 在Terminal中,在您的项目根目录输入`install`命令以安装项目依赖
```shell
# install dependencies
npm install
```
2. 输入`run dev`命令以启动Web程序
```shell
# serve with hot reload at localhost:8080
npm run dev
```
Resources:
document: https://docs.agora.io/cn/
issue: https://github.com/AgoraIO/Basic-Video-Call/issues

License:
type: MIT
69 changes: 69 additions & 0 deletions Group-Video/OpenVideoCall-Windows/README.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
Meta:
name: Open Video Call Windows
# en or cn
lang: en
# | 代表这里是字符串
description: |
The Open Video Call Windows Sample App is an open-source demo that will help you get video chat integrated directly into your Windows applications using the Agora Video SDK.
With this sample app, you can:
- Join / leave channel
- Mute / unmute audio
- Enable / disable video
- Change camera
- Send message to channel
- Setup resolution, frame rate and bit rate
- Enable encryption
- Enable / disable black and white filter
This demo is written in **C++**
A tutorial demo can be found here: [Agora-Windows-Tutorial-1to1](https://github.com/AgoraIO/Basic-Video-Call/tree/master/One-to-One-Video/Agora-Windows-Tutorial-1to1)
Agora Video SDK supports iOS / Android / Windows / macOS etc. You can find demos of these platform here:
- [OpenVideoCall-Android](https://github.com/AgoraIO/Basic-Video-Call/tree/master/Group-Video/OpenVideoCall-Android)
- [OpenVideoCall-iOS](https://github.com/AgoraIO/Basic-Video-Call/tree/master/Group-Video/OpenVideoCall-iOS)
- [OpenVideoCall-macOS](https://github.com/AgoraIO/Basic-Video-Call/tree/master/Group-Video/OpenVideoCall-macOS)
Prerequisites:
- Visual Studio 2013 or higher
- Windows 7 or higher

QuickStart:
description:
This section shows you how to prepare, build, and run the sample application.
sections:
- title: Obtain an App ID
content: |
To build and run the sample application, get an App ID:
1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/).
2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation.
3. Copy the **App ID** from the Dashboard.
- title: Integrate the Agora Video SDK
content: |
1. Define the APP_ID with your App ID.
```
#define APP_ID _T("Your App ID")
```
2. Download the **Agora Video SDK** from [Agora.io SDK](https://www.agora.io/en/blog/download/). Unzip the downloaded SDK package and copy the **sdk** to the "OpenVideoCall" folder in project(the old one may be over written.
3. Open OpenVideoCall.sln, build the solution and run.
- title: Note
content: |
1. After the program is compiled, if the program "xxx\xxx\xxx\Debug\Language\English.dll" cannot be started when running the program,
please select the OpenVideoCall project in the Solution Explorer and right click. In the pop-up menu bar, select "Set as active project" to solve. Then run the program again.
2. The dll library under the sdk/dll file needs to be placed in the corresponding execution path.
Tips: The relevant dll library has been configured for you in this case tutorial. If you want to use the interface provided by agora for related development, you need to put the dll library into the corresponding execution path as prompted above.
Resources:
document: https://docs.agora.io/en/
issue: https://github.com/AgoraIO/Basic-Video-Call/issues

License:
type: MIT
Loading

0 comments on commit 3cb224e

Please sign in to comment.