# LyricViewX

**Repository Path**: toorup/LyricViewX

## Basic Information

- **Project Name**: LyricViewX
- **Description**: No description available
- **Primary Language**: Android
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-14
- **Last Updated**: 2023-12-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# LyricViewX

[![](https://www.jitpack.io/v/Moriafly/LyricViewX.svg)](https://www.jitpack.io/#Moriafly/LyricViewX)

LyricViewX 是一个美观的安卓歌词控件。

基于 [LrcView](https://github.com/zion223/NeteaseCloudMusic-MVVM/blob/master/lib_common_ui/src/main/java/com/netease/lib_common_ui/lrc/LrcView.java) 设计。

## 比较与 LrcView

- 100% Kotlin 代码
- 交互优化，移除过时方法
- 提供 JitPack 库方便使用
- 提供新功能

## 如何使用

### 步骤 1. 将 JitPack 存储库添加到构建文件中

将它添加到 build.gradle(root) 中:
```
allprojects {
    repositories {
        ...
        maven { url 'https://www.jitpack.io' }
    }
}
```
### 步骤 2. 添加依赖关系
```
dependencies {
    implementation 'com.github.Moriafly:LyricViewX:#Tag' // $Tag 改成最新版本
}
```

## 布局
```xml
<com.dirror.lyricviewx.LyricViewX
    android:id="@+id/lyricViewX"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:lrcPadding="16dp">
</com.dirror.lyricviewx.LyricViewX>
```

## Activity
```kt
    binding.lyricViewX.loadLyric()
```

### 方法
```kotlin
/**
 * 设置非当前行歌词字体颜色 [normalColor]
 */
fun setNormalColor(normalColor: Int)

/**
 * 普通歌词文本字体大小 [size]，单位 px
 */
fun setNormalTextSize(size: Float)

/**
 * 当前歌词文本字体大小
 */
fun setCurrentTextSize(size: Float)

/**
 * 设置当前行歌词的字体颜色
 */
fun setCurrentColor(currentColor: Int)

/**
 * 设置拖动歌词时选中歌词的字体颜色
 */
fun setTimelineTextColor(timelineTextColor: Int)

/**
 * 设置拖动歌词时时间线的颜色
 */
fun setTimelineColor(timelineColor: Int)

/**
 * 设置拖动歌词时右侧时间字体颜色
 */
fun setTimeTextColor(timeTextColor: Int)

/**
 * 设置歌词为空时屏幕中央显示的文字 [label]，如“暂无歌词”
 */
fun setLabel(label: String)

/**
 * 加载歌词文件
 * 两种语言的歌词时间戳需要一致
 * @param mainLyricFile 第一种语言歌词文件
 * @param secondLyricFile 可选，第二种语言歌词文件
 */
fun loadLyric(mainLyricFile: File, secondLyricFile: File? = null)

/**
 * 加载歌词文本
 * 两种语言的歌词时间戳需要一致
 * @param mainLyricText 第一种语言歌词文本
 * @param secondLyricText 可选，第二种语言歌词文本
 */
fun loadLyric(mainLyricText: String?, secondLyricText: String? = null)

/**
 * 加载在线歌词
 * @param lyricUrl  歌词文件的网络地址
 * @param charset 编码格式
 */
fun loadLyricByUrl(lyricUrl: String, charset: String? = "utf-8")

/**
 * 刷新歌词
 * @param time 当前播放时间
 */
fun updateTime(time: Long)

/**
 * 设置歌词是否允许拖动
 * @param draggable 是否允许拖动
 * @param onPlayClickListener 设置歌词拖动后播放按钮点击监听器，如果允许拖动，则不能为 null
 */
fun setDraggable(draggable: Boolean, onPlayClickListener: OnPlayClickListener?)

/**
 * 设置单击
 */
fun setOnSingerClickListener(onSingerClickListener: OnSingleClickListener?)

/**
 * @新增加
 * 获取当前歌词每句实体，可用于歌词分享
 * @return LyricEntry 集合
 */
fun getLyricEntryList(): List<LyricEntry>


/**
 * 播放按钮被点击，应该跳转到指定播放位置
 * @return 是否成功消费该事件，如果成功消费，则会更新UI
 */
fun onPlayClick(time: Long): Boolean

/**
 * 单击事件
 */
fun onClick()

```

## License

    LyricViewX  Copyright (C) 2021  Moriafly
    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.