Browse Source

增加了文档

Caijinglong 6 years ago
parent
commit
83b5e07bb0

+ 2 - 0
lib/src/config.dart

@@ -1,3 +1,5 @@
+/// IJKPlayer Config
 class IjkConfig {
+  /// when [isLog] is true, will print log in console
   static bool isLog = false;
 }

+ 2 - 2
lib/src/controller.dart

@@ -35,7 +35,7 @@ class IjkMediaController {
   bool get isInit => textureId == null;
 
   /// channel of native to flutter
-  IJKEventChannel eventChannel;
+  _IJKEventChannel eventChannel;
 
   /// playing state
   bool _isPlaying = false;
@@ -92,7 +92,7 @@ class IjkMediaController {
       var id = await _createIjk();
       this.textureId = id;
       _plugin = _IjkPlugin(id);
-      eventChannel = IJKEventChannel(this);
+      eventChannel = _IJKEventChannel(this);
       await eventChannel.init();
       volume = 100;
     } catch (e) {

+ 4 - 0
lib/src/controller_builder.dart

@@ -2,6 +2,10 @@ import 'package:flutter/material.dart';
 import 'package:flutter_ijkplayer/flutter_ijkplayer.dart';
 import 'package:flutter_ijkplayer/src/widget/controller_builder.dart';
 
+/// Using mediaController to Construct a Controller UI
+typedef Widget ControllerWidgetBuilder(IjkMediaController controller);
+
+/// default create IJK Controller UI
 Widget defaultBuildIjkControllerWidget(IjkMediaController controller) {
   return DefaultControllerWidget(controller: controller);
 }

+ 2 - 0
lib/src/error.dart

@@ -1,3 +1,5 @@
+/// errors enum
 enum Error {
+  /// file is not exists
   fileNotExists,
 }

+ 3 - 9
lib/src/ijk_event_channel.dart

@@ -1,17 +1,11 @@
-import 'dart:async';
+part of 'ijkplayer.dart';
 
-import 'package:flutter/services.dart';
-import 'package:flutter_ijkplayer/src/logutil.dart';
-import 'package:flutter_ijkplayer/src/video_info.dart';
-
-import './ijkplayer.dart';
-
-class IJKEventChannel {
+class _IJKEventChannel {
   int get textureId => controller?.textureId;
 
   IjkMediaController controller;
 
-  IJKEventChannel(this.controller);
+  _IJKEventChannel(this.controller);
 
   MethodChannel channel;
 

+ 1 - 5
lib/src/ijkplayer.dart

@@ -3,7 +3,6 @@ import 'dart:io';
 
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
-import 'package:flutter_ijkplayer/src/ijk_event_channel.dart';
 import 'package:flutter_ijkplayer/src/video_info.dart';
 import 'package:flutter_ijkplayer/src/widget/ijkplayer_builder.dart';
 
@@ -12,11 +11,8 @@ import './error.dart';
 import 'logutil.dart';
 
 part './controller.dart';
-
 part './manager.dart';
-
-/// Using mediaController to Construct a Controller UI
-typedef Widget ControllerWidgetBuilder(IjkMediaController controller);
+part 'ijk_event_channel.dart';
 
 /// Main Classes of Library
 class IjkPlayer extends StatefulWidget {

+ 1 - 0
lib/src/logutil.dart

@@ -1,5 +1,6 @@
 import 'config.dart';
 
+/// IJKPlayer Log Util
 class LogUtils {
   LogUtils._();
   static void log(Object msg) {

+ 2 - 2
lib/src/manager.dart

@@ -1,7 +1,7 @@
 part of './ijkplayer.dart';
 
 /// create 2019/3/18 by cai
-
+///
 class IjkManager {
   /// For the hot reload/ hot restart to release last texture resource. Release version does not have hot reload, so you can not call it.
   ///
@@ -10,7 +10,7 @@ class IjkManager {
   ///
   /// If this method is not invoked in the debug version, the sound before the hot reload will continue to play.
   static Future<void> initIJKPlayer() async {
-    _globalChannel.invokeMethod("init");
+    await _globalChannel.invokeMethod("init");
   }
 
   /// set system volume

+ 1 - 0
lib/src/video_info.dart

@@ -1,5 +1,6 @@
 import 'dart:convert';
 
+/// about video info
 class VideoInfo {
   /// Width of Video
   int width;

+ 3 - 0
lib/src/widget/controller_builder.dart

@@ -5,6 +5,9 @@ import 'package:flutter_ijkplayer/flutter_ijkplayer.dart';
 import 'package:flutter_ijkplayer/src/logutil.dart';
 import 'package:flutter_ijkplayer/src/widget/progress_bar.dart';
 
+/// Default Controller Widget
+///
+/// see [IjkPlayer] and []
 class DefaultControllerWidget extends StatefulWidget {
   final IjkMediaController controller;
   final bool doubleTapPlay;