docs: readme 和 CHANGELOG 文档更新

Author: painld6

CHANGELOG.md

@@ -1,20 +1,30 @@
 # SVGAPlayer-Android CHANGELOG (2021-03-02)
 
-## [2.6.0](2021-08-18)
+## [2.6.1] (2021-08-30)
+
+### Bug Fixes
+
+* fix(SVGAImageView): SVGAImageView sets autoPlay to false, the sound will still be played automatically.
+* fix(SVGAParser): When the type of SVGACache is set to Type.FILE, the zip compressed svga cannot be displayed.
+* fix(SVGACanvasDrawer): When svga is drawn, the repeated setting of alpha and color causes the screen to display abnormally.
+
+
+## [2.6.0](https://github.com/svga/SVGAPlayer-Android/compare/2.5.15...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().
+* 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.([f29563e](https://github.com/svga/SVGAPlayer-Android/commit/f29563e))
+* feat(SVGASoundManager): SVGA volume control. ([010b19c](https://github.com/svga/SVGAPlayer-Android/commit/010b19c))
+* 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.([8437fd7](https://github.com/svga/SVGAPlayer-Android/commit/8437fd7))
+* feat(SVGAParser): Add aliases to the log section to facilitate developers to troubleshoot problems([977059e](https://github.com/svga/SVGAPlayer-Android/commit/977059e))
+* feat(SVGACache): Open cache cleaning method: SVGACache#clearCache().([a8d926e](https://github.com/svga/SVGAPlayer-Android/commit/a8d926e))
 
 ### 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.
+* refactor(ILogger): Remove redundant api.([3f4ef1a](https://github.com/svga/SVGAPlayer-Android/commit/3f4ef1a))
+* fix(SVGAParser): Zip Path Traversal Vulnerability.([000aa61](https://github.com/svga/SVGAPlayer-Android/commit/000aa61))
+* fix(SVGAParser): link reuse problem.([b01174e](https://github.com/svga/SVGAPlayer-Android/commit/b01174e))
+
 
 ## [2.5.15](https://github.com/svga/SVGAPlayer-Android/compare/2.5.14...2.5.15) (2021-03-02)
 

readme.md

@@ -101,7 +101,7 @@ How many times should animation loops. `0` means Infinity Loop.
 
 #### ~~clearsAfterStop: Boolean~~
 
-Defaults to `true`.When the animation is finished, whether to clear the canvas and the internal data of SVGAVideoEntity.
+Defaults to `false`.When the animation is finished, whether to clear the canvas and the internal data of SVGAVideoEntity.
 It is no longer recommended. Developers can control resource release through clearAfterDetached, or manually control resource release through SVGAVideoEntity#clear
 
 #### clearsAfterDetached: Boolean
@@ -116,7 +116,7 @@ Defaults to `Forward`. Could be `Forward`, `Backward`, `Clear`.
 
 `Backward` means animation will pause on first frame after finished.
 
-'Clear' after the animation is played, all the canvas content is cleared, but it is only the canvas and does not involve the internal data of SVGAVideoEntity.
+`Clear` after the animation is played, all the canvas content is cleared, but it is only the canvas and does not involve the internal data of SVGAVideoEntity.
 
 ### Using code
 
@@ -208,11 +208,42 @@ 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
 
+
+```kotlin
+
+// By default, SVGA will not output any log, so you need to manually set it to true
+SVGALogger.setLogEnabled(true)
+
+// If you want to collect the output log of SVGA, you can obtain it in the following way
+SVGALogger.injectSVGALoggerImp(object: ILogger {
+// Implement related interfaces to receive log
+})
+```
+
 ### 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.
 
+```kotlin
+// Initialize the audio manager for easy management of audio playback
+// If it is not initialized, the audio will be loaded in the original way by default
+SVGASoundManager.init()
+
+// Release audio resources
+SVGASoundManager.release()
+
+/**
+* Set the volume level, entity is null by default
+* When entity is null, it controls the volume of all audio loaded through SVGASoundManager, which includes the currently playing audio and subsequent loaded audio
+* When entity is not null, only the SVGA audio volume of the instance is controlled, and the others are not affected
+* 
+* @param volume The value range is [0f, 1f]
+* @param entity That is, the instance of SVGAParser callback
+*/
+SVGASoundManager.setVolume(volume, entity)
+```
+
 ## Features
 
 Here are many feature samples.

readme.zh.md

@@ -87,7 +87,7 @@ SVGAPlayer 可以从本地 `assets` 目录，或者远端服务器上加载动
 默认为 `0`，设置动画的循环次数，0 表示无限循环。
 
 #### ~~clearsAfterStop: Boolean~~
-默认为 `true`，当动画播放完成后，是否清空画布，以及 SVGAVideoEntity 内部数据。
+默认为 `false`，当动画播放完成后，是否清空画布，以及 SVGAVideoEntity 内部数据。
 不再推荐使用，开发者可以通过 clearAfterDetached 控制资源释放，或者手动通过 SVGAVideoEntity#clear 控制资源释放
 
 #### clearsAfterDetached: Boolean
@@ -189,15 +189,46 @@ HttpResponseCache.install(cacheDir, 1024 * 1024 * 128)
 ```
 
 ### SVGALogger
-更新了内部 log 输出，可通过 SVGALogger 去管理和控制，默认是未启用 log 输出，开发者们也可以实现 ILogger 接口，做到外部捕获收集 log，方便排查问题
-通过 `setLogEnabled` 方法设置日志是否开启
-通过 `injectSVGALoggerImp` 方法注入自定义 ILogger 实现类
+更新了内部 log 输出，可通过 SVGALogger 去管理和控制，默认是未启用 log 输出，开发者们也可以实现 ILogger 接口，做到外部捕获收集 log，方便排查问题。
+通过 `setLogEnabled` 方法设置日志是否开启。
+通过 `injectSVGALoggerImp` 方法注入自定义 ILogger 实现类。
+
+```kotlin
+
+// 默认情况下，SVGA 内部不会输出任何 log，所以需要手动设置为 true
+SVGALogger.setLogEnabled(true)
+
+// 如果希望收集 SVGA 内部输出的日志，则可通过下面方式获取
+SVGALogger.injectSVGALoggerImp(object: ILogger {
+// 实现相关接口进行接收 log
+})
+```
 
 ### SVGASoundManager
 新增 SVGASoundManager 控制 SVGA 音频，需要手动调用 init 方法进行初始化，否则按照默认的音频加载逻辑。
 另外通过 SVGASoundManager#setVolume 可控制 SVGA 播放时的音量大小，范围值在 [0f, 1f]，默认控制所有 SVGA 播放时的音量，
 而且该方法可设置第二个可缺省参数：SVGAVideoEntity，表示仅控制当前 SVGA 的音量大小，其他 SVGA 的音量保持不变。
 
+```kotlin
+// 初始化音频管理器，方便管理音频播放
+// 如果没有初始化，则默认按照原有方式加载音频
+SVGASoundManager.init()
+
+// 释放音频资源
+SVGASoundManager.release()
+
+/**
+* 设置音量大小，entity 默认为空
+* 当 entity 为空，则控制所有通过 SVGASoundManager 加载的音频音量大小，即包括当前正在播放的音频以及后续加载的音频
+* 当 entity 不为空，则仅控制该实例的 SVGA 音频音量大小，其他则不受影响
+* 
+* @param volume 取值范围为 [0f, 1f]
+* @param entity 即 SVGAParser 回调回来的实例
+*/
+SVGASoundManager.setVolume(volume, entity)
+```
+
+
 ## 功能示例
 
 * [使用位图替换指定元素。](https://github.com/yyued/SVGAPlayer-Android/wiki/Dynamic-Image)