Browse Source

update documents

cjl_macbook 6 years ago
parent
commit
c1e1712906
3 changed files with 31 additions and 27 deletions
  1. 6 4
      README-EN.md
  2. 22 20
      README.md
  3. 3 3
      TODOLIST.md

+ 6 - 4
README-EN.md

@@ -31,7 +31,7 @@ Before using library, you can star and download the code to try the example.
       - [screen shot](#screen-shot)
       - [Observer for resource](#observer-for-resource)
       - [IjkStatus](#ijkstatus)
-      - [自定义 Option](#%E8%87%AA%E5%AE%9A%E4%B9%89-option)
+      - [Custom Options](#custom-options)
         - [IjkOptionCategory](#ijkoptioncategory)
       - [release resource](#release-resource)
     - [Use self controller UI](#use-self-controller-ui)
@@ -271,7 +271,9 @@ Stream<IjkStatus> ijkStatusStream = controller.ijkStatusStream;
 | complete          | Media is play complete.                                        |
 | disposed          | After Controller calls `dispose()`.                            |
 
-#### 自定义 Option
+#### Custom Options
+
+**This function may cause problems, such as not playing, etc.** Stop using this feature if you find that you cannot use or have an exception after setting options.
 
 Support custom IJKPlayer options, which are transmitted directly to Android/iOS native. For specific values and meanings, you need to see bilibili/ijkplayer](https://github.com/bilibili/ijkplayer).
 
@@ -297,9 +299,9 @@ void initIjkController() async {
 }
 ```
 
-第一个参数是一个数组,代表了你 option 目标设备的类型(android/iOS)
+The first parameter is an array that represents the type of device you choose to target (android/iOS).
 
-第二个参数是一个`Set<IjkOption>`,代表了 Option 的集合,因为 category 和 key 均相同的情况下会覆盖,所以这里使用了 set
+The second parameter is a `Set<IjkOption>`, which represents the set of Option, because both categories and keys are covered, so set is used here.
 
 ##### IjkOptionCategory
 

+ 22 - 20
README.md

@@ -19,30 +19,30 @@ android 模拟器 mac android sdk 自带的 emulator(API28 android9)可用,其
 ## 目录
 
 - [ijkplayer](#ijkplayer)
-  - [目录](#%E7%9B%AE%E5%BD%95)
+  - [目录](#目录)
   - [English Readme](#english-readme)
-  - [安装](#%E5%AE%89%E8%A3%85)
-  - [原生部分说明](#%E5%8E%9F%E7%94%9F%E9%83%A8%E5%88%86%E8%AF%B4%E6%98%8E)
+  - [安装](#安装)
+  - [原生部分说明](#原生部分说明)
     - [iOS](#ios)
     - [Android](#android)
-  - [入门示例](#%E5%85%A5%E9%97%A8%E7%A4%BA%E4%BE%8B)
-  - [使用](#%E4%BD%BF%E7%94%A8)
-    - [设置](#%E8%AE%BE%E7%BD%AE)
-    - [关于销毁](#%E5%85%B3%E4%BA%8E%E9%94%80%E6%AF%81)
-    - [控制器的使用](#%E6%8E%A7%E5%88%B6%E5%99%A8%E7%9A%84%E4%BD%BF%E7%94%A8)
-      - [设置资源](#%E8%AE%BE%E7%BD%AE%E8%B5%84%E6%BA%90)
-      - [播放器的控制](#%E6%92%AD%E6%94%BE%E5%99%A8%E7%9A%84%E6%8E%A7%E5%88%B6)
-      - [获取播放信息](#%E8%8E%B7%E5%8F%96%E6%92%AD%E6%94%BE%E4%BF%A1%E6%81%AF)
-      - [截取视频帧](#%E6%88%AA%E5%8F%96%E8%A7%86%E9%A2%91%E5%B8%A7)
-      - [资源监听](#%E8%B5%84%E6%BA%90%E7%9B%91%E5%90%AC)
-      - [IjkStatus 说明](#ijkstatus-%E8%AF%B4%E6%98%8E)
-      - [自定义 Option](#%E8%87%AA%E5%AE%9A%E4%B9%89-option)
+  - [入门示例](#入门示例)
+  - [使用](#使用)
+    - [设置](#设置)
+    - [关于销毁](#关于销毁)
+    - [控制器的使用](#控制器的使用)
+      - [设置资源](#设置资源)
+      - [播放器的控制](#播放器的控制)
+      - [获取播放信息](#获取播放信息)
+      - [截取视频帧](#截取视频帧)
+      - [资源监听](#资源监听)
+      - [IjkStatus 说明](#ijkstatus-说明)
+      - [自定义 Option](#自定义-option)
         - [IjkOptionCategory](#ijkoptioncategory)
-      - [释放资源](#%E9%87%8A%E6%94%BE%E8%B5%84%E6%BA%90)
-    - [自定义控制器 UI](#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%8E%A7%E5%88%B6%E5%99%A8-ui)
-    - [自定义纹理界面](#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%BA%B9%E7%90%86%E7%95%8C%E9%9D%A2)
-    - [根据当前状态构建一个 widget](#%E6%A0%B9%E6%8D%AE%E5%BD%93%E5%89%8D%E7%8A%B6%E6%80%81%E6%9E%84%E5%BB%BA%E4%B8%80%E4%B8%AA-widget)
-  - [进度](#%E8%BF%9B%E5%BA%A6)
+      - [释放资源](#释放资源)
+    - [自定义控制器 UI](#自定义控制器-ui)
+    - [自定义纹理界面](#自定义纹理界面)
+    - [根据当前状态构建一个 widget](#根据当前状态构建一个-widget)
+  - [进度](#进度)
   - [LICENSE](#license)
 
 ## English Readme
@@ -298,6 +298,8 @@ Stream<IjkStatus> ijkStatusStream = controller.ijkStatusStream;
 
 #### 自定义 Option
 
+**本功能可能会出问题,导致不能播放等等情况,**如果发现设置选项后不能使用或出现异常,请停止使用此功能
+
 支持自定义 IJKPlayer 的 option,这个 option 会直接传输至 android/iOS 原生,具体的数值和含义你需要查看[bilibili/ijkplayer](https://github.com/bilibili/ijkplayer)的设置选项
 
 但这个设置后的选项不是即时生效的

+ 3 - 3
TODOLIST.md

@@ -76,6 +76,6 @@
   - [x] 在悬浮窗中播放
     - [x] 悬浮窗的 UI 控制器
 - [x] iOS 部分视频无法显示图像的问题: 可能很长时间内都无法解决
-- [ ] 支持在 dart 端初始化 ijkPlayer 播放器的 option
-  - [ ] android
-  - [ ] iOS
+- [x] 支持在 dart 端初始化 ijkPlayer 播放器的 option
+  - [x] android
+  - [x] iOS