From 4bdfda8b4139565bceb60ccfaba5e897d17c37f4 Mon Sep 17 00:00:00 2001 From: Daniel Wei Date: Wed, 20 Jan 2021 18:30:54 +0800 Subject: [PATCH] chore: update README --- CHANGELOG.md | 4 ++++ README.md | 17 ++++++++++++++++- example/.flutter-plugins-dependencies | 2 +- example/pubspec.lock | 2 +- lib/flutter_barrage.dart | 2 +- pubspec.yaml | 2 +- 6 files changed, 24 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 58509f9..4ccd179 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.4.5 + +* update README + ## 0.4.4 * fix maxBulletHeight type mismatch issue diff --git a/README.md b/README.md index a7f4cbc..e702d2e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,22 @@ A barrage wall flutter plugin. ## Getting Started -[more examples](https://github.com/danielwii/flutter_barrage/tree/master/example) +#### BarrageWall 参数 + +* **List bullets** - 初始化的弹幕列表 +* **BarrageWallController controller** - 用于初始化后批量发送弹幕的 controller +* **ValueNotifier timelineNotifier** - 用于连接媒体的当前播放进度 +* **int speed** - 速度，从屏幕右侧到左侧的时间，默认 5 +* **child** - 用于填充的容器 +* **double width** - 容器宽度 +* **double height** - 容器高度 +* **bool massiveMode** - 海量模式，默认关闭，此时当所有通道都被占用时弹幕将被丢弃，不会产生覆盖的情况。当开启式会实时显示所有弹幕，所有通道被占用时会覆盖之前的弹幕。 +* **double maxBulletHeight** - 弹幕的最大高度，用于计算通道，默认 16。（有用户提到需要明确设置 https://github.com/danielwii/flutter_barrage/issues/3#issuecomment-759920796 弹幕的覆盖问题才会正确。） +* **int speedCorrectionInMilliseconds** - 默认 3000，用于调整不同通道的速度，不同的通道会在这个值的范围内找到一个随机值并调整当前通道的速度 +* **bool debug** - 调试模式，会显示一个数据面板 +* **int safeBottomHeight** - 默认 0，用于保证在最下方有一个不会显示弹幕的空间，避免挡住字幕 + +[more examples - 详细用法请查看 examples](https://github.com/danielwii/flutter_barrage/tree/master/example) * show barrage only diff --git a/example/.flutter-plugins-dependencies b/example/.flutter-plugins-dependencies index 39ed8d6..77d0854 100644 --- a/example/.flutter-plugins-dependencies +++ b/example/.flutter-plugins-dependencies @@ -1 +1 @@ -{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"video_player","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/video_player-1.0.1/","dependencies":[]},{"name":"wakelock","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/wakelock-0.2.1+1/","dependencies":[]}],"android":[{"name":"video_player","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/video_player-1.0.1/","dependencies":[]},{"name":"wakelock","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/wakelock-0.2.1+1/","dependencies":[]}],"macos":[],"linux":[],"windows":[],"web":[{"name":"import_js_library","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/import_js_library-1.0.2/","dependencies":[]},{"name":"video_player_web","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/video_player_web-0.1.4+1/","dependencies":[]},{"name":"wakelock_web","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/wakelock_web-0.1.0+3/","dependencies":["import_js_library"]}]},"dependencyGraph":[{"name":"import_js_library","dependencies":[]},{"name":"video_player","dependencies":["video_player_web"]},{"name":"video_player_web","dependencies":[]},{"name":"wakelock","dependencies":["wakelock_web"]},{"name":"wakelock_web","dependencies":["import_js_library"]}],"date_created":"2021-01-08 17:34:34.916988","version":"1.22.5"} \ No newline at end of file +{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"video_player","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/video_player-1.0.1/","dependencies":[]},{"name":"wakelock","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/wakelock-0.2.1+1/","dependencies":[]}],"android":[{"name":"video_player","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/video_player-1.0.1/","dependencies":[]},{"name":"wakelock","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/wakelock-0.2.1+1/","dependencies":[]}],"macos":[],"linux":[],"windows":[],"web":[{"name":"import_js_library","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/import_js_library-1.0.2/","dependencies":[]},{"name":"video_player_web","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/video_player_web-0.1.4+1/","dependencies":[]},{"name":"wakelock_web","path":"/Users/daniel/.pub-cache/hosted/pub.dartlang.org/wakelock_web-0.1.0+3/","dependencies":["import_js_library"]}]},"dependencyGraph":[{"name":"import_js_library","dependencies":[]},{"name":"video_player","dependencies":["video_player_web"]},{"name":"video_player_web","dependencies":[]},{"name":"wakelock","dependencies":["wakelock_web"]},{"name":"wakelock_web","dependencies":["import_js_library"]}],"date_created":"2021-01-20 18:43:32.283455","version":"1.22.5"} \ No newline at end of file diff --git a/example/pubspec.lock b/example/pubspec.lock index e8ca466..110b24a 100644 --- a/example/pubspec.lock +++ b/example/pubspec.lock @@ -82,7 +82,7 @@ packages: path: ".." relative: true source: path - version: "0.4.3" + version: "0.4.5" flutter_test: dependency: "direct dev" description: flutter diff --git a/lib/flutter_barrage.dart b/lib/flutter_barrage.dart index 6339b3f..8f6f805 100644 --- a/lib/flutter_barrage.dart +++ b/lib/flutter_barrage.dart @@ -26,7 +26,7 @@ class BarrageWall extends StatefulWidget { /// used to not cover the subtitles final int safeBottomHeight; - /// disable by default, will overwrite other bullets + /// [disable] by default, will overwrite other bullets final bool massiveMode; /// used to make barrage tidy diff --git a/pubspec.yaml b/pubspec.yaml index 829ccd9..157942f 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: flutter_barrage description: A new barrage package project. Used to send bullet(danmu) to a container. -version: 0.4.4 +version: 0.4.5 homepage: https://github.com/danielwii/flutter_barrage.git environment: