# RealtimeMusicClass-Android

**Repository Path**: mirrors_AgoraIO-Community/RealtimeMusicClass-Android

## Basic Information

- **Project Name**: RealtimeMusicClass-Android
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: release/1.0.1
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-07
- **Last Updated**: 2026-03-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 实时音乐课堂

If you need The English version of this readme, click [here](readme.md)

## 运行demo

请参考[官方文档](https://docs.agora.io/cn/online_music_class/music_class_apaas_android?platform=All%20Platforms) 获取如何运行demo的指引

## 创建个性化合唱音乐
### 创建音乐配置文件
Create a json file named **musics.json**, put the following content to the file as below

````json
    [{
      "name": "music1",
      "identifier": "0001",
      "music": "music1.mp3",
      "lyric": "music1.xml"
    }, {
      "name": "music2",
      "identifier": "0002",
      "music": "music2.mp3",
      "lyric": "music2.xml"
    }]
````

每个音乐配置项包含四个属性：
* **name**: 歌曲名称，显示在歌曲列表上
* **identifier**: 歌曲的id，当前并未使用，由项目的需求进行指定
* **music**: 歌曲名称及音乐格式扩展名，当前支持多种音乐格式
* **lyric**: 歌词文件及相应的扩展名，当前支持多种歌词文件格式

歌曲列表的歌曲数目可以根据需求任意指定

### 准备歌曲和歌词文件

将配置文件 musics.config， 以及歌曲和歌词文件复制到项目的以下文件夹中：

**app/src/main/assets**

### 运行程序
当提供了有效的 app id 后即可运行demo程序。demo会自动读取配置文件的歌曲并显示在列表里。