night-kang / lyricview

Android multifunctional lyric view

LyricView

中文版 readme

download demo apk.

Blog Introduce: https://www.jianshu.com/p/ab735509cc74

Screenshots

Download

    all projects {
	    repositories {
		    ...
		    maven { url 'https://jitpack.io' }
	    }
	}

    dependencies {
    	        implementation 'com.github.Lauzy:LyricView:VERSION_CODE'
    	}

The latest version code is here.

Usage

Xml file：

       <com.lauzy.freedom.library.LrcView
            ...
            app:currentIndicateLrcColor="@color/colorAccent"
            app:indicatorTextColor="@android:color/holo_orange_dark"
            app:playIcon="@drawable/play_music"/>

Functions:

Parse lyric and set lyric data:

      From file:
      List<Lrc> lrcs = LrcHelper.parseLrcFromFile(file);

      From asset:
      List<Lrc> lrcs = LrcHelper.parseLrcFromAssets(context, assetFileName);

      Set lyric data：
      mLrcView.setLrcData(lrcs);

Update the lyric according to playing process:

      mLrcView.updateTime(mMediaPlayer.getCurrentPosition());

Seek to a specific time by indicator:

      mLrcView.setOnPlayIndicatorLineListener(new LrcView.OnPlayIndicatorLineListener() {
                 @Override
                 public void onPlay(long time, String content) {
                     mMediaPlayer.seekTo((int) time);
                 }
             });

Set the description while there is no lyric data:

     mLrcView.setEmptyContent("no data");

Attributes：

        <attr name="lrcTextSize" format="dimension"/>
        <attr name="lrcLineSpaceSize" format="dimension"/>
        <attr name="lrcNormalTextColor" format="reference|color"/>
        <attr name="lrcCurrentTextColor" format="reference|color"/>
        <attr name="lrcTouchDelay" format="integer"/>   //delay of rolling back
        <attr name="noLrcTextSize" format="dimension"/>
        <attr name="noLrcTextColor" format="reference|color"/>
        <attr name="indicatorLineHeight" format="dimension"/>
        <attr name="indicatorTextSize" format="dimension"/>
        <attr name="indicatorTextColor" format="reference|color"/>
        <attr name="currentIndicateLrcColor" format="reference|color"/> //current lyric line color
        <attr name="indicatorTouchDelay" format="integer"/>    //delay of indicator's disappearance
        <attr name="indicatorLineColor" format="reference|color"/> // color of indicator line
        <attr name="indicatorStartEndMargin" format="dimension"/>  //start and end margin of indicator
        <attr name="iconLineGap" format="dimension"/>   // space between indicator's playing icon and line
        <attr name="playIconWidth" format="dimension"/>
        <attr name="playIconHeight" format="dimension"/>
        <attr name="playIcon" format="reference"/>   // indicator's playing icon

License

Copyright (c) 2017-present Lauzy

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.