Merge pull request #170 from apivideo/documentation-android-player-analytics

[SDK README - api.video-android-player-analytics] README to documentation synchro

Author: olivier-lando

sdks/player/apivideo-android-player-analytics.md

@@ -3,21 +3,21 @@ title: api.video Android Player analytics plugin
 meta: 
   description: The official api.video Android Player analytics plugin for api.video. [api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.
 ---
+<!--
+THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT!
+ IF YOU NEED TO CHANGE THIS FILE,  CREATE A PR IN THE SOURCE REPOSITORY.
+-->
 
 # api.video Android Player analytics plugin
 
-[api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast
-video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in
-your app.
+[api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.
 
 ## Project description
 
 Android library to manually call the api.video analytics collector.
 
 This is useful if you are using a video player for which we do not yet provide a ready-to-use
-monitoring module. 
-
-This module also supports ExoPlayer analytics.
+monitoring module.
 
 ## Getting started
 
@@ -29,7 +29,7 @@ In your module `build.gradle`, add the following code in `dependencies`:
 
 ```groovy
 dependencies {
-    implementation 'video.api:android-player-analytics:1.4.0'
+    implementation 'video.api:android-player-analytics:2.0.2'
 }
 ```
 
@@ -71,25 +71,55 @@ events.
 
 ### ApiVideoPlayerAnalytics API
 
-- Event time or current time
+#### Event time or current time
 
 If you know the event timestamp, you can use it as the `eventTime` parameter. If you don't know the
 event timestamp, you can set the `currentTime` parameter with a scheduler.
 
-#### Methods
+**`play(eventTime: Float = currentTime): Future<void>`**
+
+method to call when the video starts playing for the first time (in the case of a resume after
+
+paused, use `resume()`)
+
+**`resume(eventTime: Float = currentTime): Future<void>`**
+
+method to call when the video playback is resumed after a pause
+
+
+**`ready(eventTime: Float = currentTime): Future<void>`**
+
+method to call once the player is ready to play the media
+
+
+**`end(eventTime: Float = currentTime): Future<void>`**
+
+method to call when the video is ended
+
 
-| Method | Description |
-|----------|----------|
-| `play(eventTime: Float = currentTime): Future<void>` | method to call when the video starts playing for the first time (in the case of a resume after paused, use `resume()`) |
-| `resume(eventTime: Float = currentTime): Future<void>` | method to call when the video playback is resumed after a pause |
-| `ready(eventTime: Float = currentTime): Future<void>` | method to call once the player is ready to play the media |
-| `end(eventTime: Float = currentTime): Future<void>` | method to call when the video is ended |
-| `seek(from: Float, to: Float): Future<void>` | method to call when a seek event occurs, the `from` and `to` parameters are mandatory and should contain the seek start & end times in seconds |
-| `pause(eventTime: Float = currentTime): Future<void>` | method to call when the video is paused |
-| `destroy(eventTime: Float = currentTime): Future<void>` | method to call when the video player is disposed (eg. when the use closes the navigation tab) |
-| `currentTime` | field to call each time the playback time changes (it should be called often, the accuracy of the collected data depends on it) if you don't know event time. |
+**`seek(from: Float, to: Float): Future<void>`**
+
+method to call when a seek event occurs, the `from` and `to` parameters are mandatory and should
+
+contains the seek start & end times in seconds
+
+**`pause(eventTime: Float = currentTime): Future<void>`**
+
+method to call when the video is paused
+
+
+**`destroy(eventTime: Float = currentTime): Future<void>`**
+
+method to call when the video player is disposed (eg. when the use closes the navigation tab)
+
+
+**`currentTime`**
+
+field to call each time the playback time changes (it should be called often, the accuracy of the
+
+collected data depends on it) if you don't know event time.
 
 ### API documentation
 
-A complete [API documentation](https://apivideo.github.io/api.video-android-player-analytics/) is
-available.
+A complete [API documentation](https://apivideo.github.io/api.video-android-player-analytics/) is available.
+