docs: 文档更新

Author: painld6

CHANGELOG.md

@@ -1,5 +1,20 @@
 # SVGAPlayer-Android CHANGELOG (2021-03-02)
 
+## [2.6.0](2021-08-18)
+
+## Features
+
+* feat(SVGASoundManager): Added SVGASoundManager to control SVGA audio, you need to manually call the init method to initialize, otherwise follow the default audio loading logic.
+* feat(SVGAParser): SVGAParser#decodeFromAssets and SVGAParser#decodeFromURL add a parameter, which can be null. It is used to send the audio file back to the developer. The developer can control the audio playback by himself. If this parameter is set, the audio part will not be processed internally.
+* feat(SVGAParser): Add aliases to the log section to facilitate developers to troubleshoot problems
+* feat(SVGACache): Open cache cleaning method: SVGACache#clearCache().
+
+### Bug Fixes
+
+* refactor(ILogger): Remove redundant api.
+* fix(SoundPool): Added SVGASoundManager to solve the problem that the internal SoundPool does not load audio occasionally.
+* fix(SVGAParser): Zip Path Traversal Vulnerability.
+* fix(SVGAParser): link reuse problem.
 
 ## [2.5.15](https://github.com/svga/SVGAPlayer-Android/compare/2.5.14...2.5.15) (2021-03-02)
 

readme.md

@@ -151,18 +151,24 @@ You can also create `SVGAParser` instance by yourself.
 
 ```kotlin
 parser = new SVGAParser(this);
-parser.decodeFromAssets("posche.svga", new SVGAParser.ParseCompletion() {
+// The third parameter is a default parameter, which is null by default. If this method is set, the audio parsing and playback will not be processed internally. The audio File instance will be sent back to the developer through PlayCallback, and the developer will control the audio playback and playback. stop
+parser.decodeFromAssets("posche.svga", object : SVGAParser.ParseCompletion {
     // ...
-});
+}, object : SVGAParser.PlayCallback {
+    // The default is null, can not be set
+})
 ```
 
 #### Create a `SVGAParser` instance, parse from remote server like this.
 
 ```kotlin
 parser = new SVGAParser(this);
+// The third parameter is a default parameter, which is null by default. If this method is set, the audio parsing and playback will not be processed internally. The audio File instance will be sent back to the developer through PlayCallback, and the developer will control the audio playback and playback. stop
 parser.decodeFromURL(new URL("https://github.com/yyued/SVGA-Samples/blob/master/posche.svga?raw=true"), new SVGAParser.ParseCompletion() {
-    
-});
+    // ...
+}, object : SVGAParser.PlayCallback {
+    // The default is null, can not be set
+})
 ```
 
 #### Create a `SVGADrawable` instance then set to `SVGAImageView`, play it as you want.
@@ -203,6 +209,11 @@ Updated the internal log output, which can be managed and controlled through SVG
 Set whether the log is enabled through the `setLogEnabled` method
 Inject a custom ILogger implementation class through the `injectSVGALoggerImp` method
 
+### SVGASoundManager
+Added SVGASoundManager to control SVGA audio, you need to manually call the init method to initialize, otherwise follow the default audio loading logic.
+In addition, through SVGASoundManager#setVolume, you can control the volume of SVGA playback. The range is [0f, 1f]. By default, the volume of all SVGA playbacks is controlled.
+And this method can set a second default parameter: SVGAVideoEntity, which means that only the current SVGA volume is controlled, and the volume of other SVGAs remains unchanged.
+
 ## Features
 
 Here are many feature samples.

readme.zh.md

@@ -132,18 +132,24 @@ SVGAParser.shareParser().init(this);
 
 ```kotlin
 parser = new SVGAParser(this);
-parser.decodeFromAssets("posche.svga", new SVGAParser.ParseCompletion() {
-    
-});
+// 第三个为可缺省参数，默认为 null，如果设置该方法，则内部不在处理音频的解析以及播放，会通过 PlayCallback 把音频 File 实例回传给开发者，有开发者自行控制音频的播放与停止。
+parser.decodeFromAssets("posche.svga", object : SVGAParser.ParseCompletion {
+    // ...
+}, object : SVGAParser.PlayCallback {
+    // The default is null, can not be set
+})
 ```
 
 #### 创建一个 `SVGAParser` 实例，加载远端服务器中的动画。
 
 ```kotlin
 parser = new SVGAParser(this);
+// 第三个为可缺省参数，默认为 null，如果设置该方法，则内部不在处理音频的解析以及播放，会通过 PlayCallback 把音频 File 实例回传给开发者，有开发者自行控制音频的播放与停止。
 parser.decodeFromURL(new URL("https://github.com/yyued/SVGA-Samples/blob/master/posche.svga?raw=true"), new SVGAParser.ParseCompletion() {
-    
-});
+    // ...
+}, object : SVGAParser.PlayCallback {
+    // The default is null, can not be set
+})
 ```
 
 #### 创建一个 `SVGADrawable` 实例，并赋值给 `SVGAImageView`，然后播放动画。
@@ -184,6 +190,11 @@ HttpResponseCache.install(cacheDir, 1024 * 1024 * 128)
 通过 `setLogEnabled` 方法设置日志是否开启
 通过 `injectSVGALoggerImp` 方法注入自定义 ILogger 实现类
 
+### SVGASoundManager
+新增 SVGASoundManager 控制 SVGA 音频，需要手动调用 init 方法进行初始化，否则按照默认的音频加载逻辑。
+另外通过 SVGASoundManager#setVolume 可控制 SVGA 播放时的音量大小，范围值在 [0f, 1f]，默认控制所有 SVGA 播放时的音量，
+而且该方法可设置第二个可缺省参数：SVGAVideoEntity，表示仅控制当前 SVGA 的音量大小，其他 SVGA 的音量保持不变。
+
 ## 功能示例
 
 * [使用位图替换指定元素。](https://github.com/yyued/SVGAPlayer-Android/wiki/Dynamic-Image)