Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zengjiale2 committed Aug 12, 2022
1 parent c85c74d commit 2978e8c
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# YY-EVA <sup>Android</sup>

简体中文 | [English](./README_en.md)

> 轻量级 高性能 跨平台 MP4 礼物播放器
## 支持本项目
Expand Down
89 changes: 89 additions & 0 deletions README_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# YY-EVA <sup>Android</sup>
> Lightweight,High Performance,Cross Platform,MP4 Gift Player
## Intruduction
+ YYEVAPlayer is a lightweight animation library with a simple yet powerful API。Reference [here](https://github.com/yylive/YYEVA/blob/main/YYEVA%E8%AE%BE%E8%AE%A1%E8%A7%84%E8%8C%83.md) can easily export animation resources
+ YYEVA-iOS render with Metal library , providing you with a high-performance, low-cost animation experience.

## Platform support
+ Platform:[Android](https://github.com/yylive/YYEVA-Android), [iOS](https://github.com/yylive/YYEVA-iOS), [Web](https://github.com/yylive/YYEVA-Web)
+ Generation Tool : [AE plguin](https://github.com/yylive/YYEVA/tree/main/AEP)
+ [Data structure](https://github.com/yylive/YYEVA/blob/main/%E6%95%B0%E6%8D%AE%E7%BB%93%E6%9E%84.md)
+ [Docs](https://github.com/yylive/YYEVA)

## Usage

我们在这里介绍 YYEVA-Android 的用法。想要知道如何导出动画,点击[这里](https://github.com/yylive/YYEVA/blob/main/YYEVA%E8%AE%BE%E8%AE%A1%E8%A7%84%E8%8C%83.md)

### Installation with Gradle
build.gradle
```groovy
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```

```groovy
dependencies {
implementation 'com.github.yylive.YYEVA-Android:yyeva:1.0.2'
}
```

### Animation with Key
For SurfaceView can use EvaAnimView,For TextureView can useEvaAnimViewV3,demo show use EvaAnimViewV3

change property interface
```kotlin
interface IEvaFetchResource {
// 获取图片 (暂时不支持Bitmap.Config.ALPHA_8 主要是因为一些机型opengl兼容问题)
fun setImage(resource: EvaResource, result:(Bitmap?) -> Unit)

// 获取文字
fun setText(resource: EvaResource, result:(String?) -> Unit)

// 资源释放通知
fun releaseSrc(resources: List<EvaResource>)
}
```
You can find the example int the project in app module.

Play with IEvaAnimView interface.
```kotlin
interface IEvaAnimView {
...
//播放文件
fun startPlay(file: File)
//播放本地文件
fun startPlay(assetManager: AssetManager, assetsPath: String)
//停止播放
fun stopPlay()
//是否正在运行
fun isRunning(): Boolean
...
}
```


## QQexchange group
![qqgroup](https://github.com/yylive/YYEVA/blob/main/img/qqgroup.png)

## 鸣谢
+ Thanks [vap](https://github.com/Tencent/vap) , our decoder module with good experiences of it.

## Dev Team
<table>
<tbody>
<tr>
<td align="center" valign="top">
<img style="border-radius:8px" width="80" height="80" src="https://avatars.githubusercontent.com/u/10419150?v=4">
<br>
<a href="https://github.com/cangwang">Cangwang</a>
</td>
</tr>
</tbody>
</table>



0 comments on commit 2978e8c

Please sign in to comment.