ovenplayer 0.10.2 → 0.10.3-3.alpha-2

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2021 AirenSoft Co., Ltd.
+Copyright (c) 2022 AirenSoft Co., Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,56 +1,42 @@
-# "HTML5 player for OvenMediaEngine" OvenPlayer
-
+# OvenPlayer
 
 ## What is OvenPlayer?
+<img src="demo/assets/images/OP_LLHLS_220610.svg" style="max-width: 100%; height: auto;">
 
-In short, OvenPlayer is <b>Open-Source HTML5 Player</b>.
-
-OvenPlayer supports WebRTC Signaling from OvenMediaEngine for Sub-Second Latency Streaming. And, it automatically plays and fallbacks using <b>WebRTC</b>, <b>Low Latency MPEG-DASH</b> (LLDASH), <b>MPEG-DASH</b>, <b>HLS</b>, and <b>RTMP</b>.
-
-See the picture below:
-<img src="docs/assets/images/01_OvenPlayer_210512.png" style="max-width: 100%; height: auto;">
+OvenPlayer is a JavaScript-based Player that can play Low Latency HLS (LLHLS) and WebRTC streams optimized for [OvenMediaEngine](https://github.com/AirenSoft/OvenMediaEngine). It provides various APIs, so you can build and operate your media service more easily.
 
-We also provide [OvenMediaEngine](https://github.com/AirenSoft/OvenMediaEngine), Open-Source Sub-Second Latency Streaming Server.
-
-
-## What is the goal of this project?
-
-AirenSoft aims to make it easier for you to build a stable broadcasting/streaming service with Sub-Second Latency.
-Therefore, we will continue developing and providing the most optimized tools for smooth Sub-Second Latency Streaming.
-
-Would you mind clicking on each link below for details:
-* ["Live Streaming Encoder for Mobile" <b>OvenLiveKit SDK](https://www.airensoft.com/olk)</b>
-* ["Sub-Second Latency Streaming Server" <b>OvenMediaEngine](https://www.ovenmediaengine.com/ome)</b>
-* ["HTML5 Player" <b>OvenPlayer](https://www.ovenmediaengine.com/ovenplayer)</b>
+## Demo
+<img src="demo/assets/images/05_OvenSpace_230214.png" style="max-width: 100%; height: auto;">
 
+OvenSpace is a sub-second latency streaming demo service using [OvenMediaEngine](https://github.com/AirenSoft/OvenMediaEngine), [OvenPlayer](https://github.com/AirenSoft/OvenPlayer) and [OvenLiveKit](https://github.com/AirenSoft/OvenLiveKit-Web). You can experience OvenPlayer in the **[OvenSpace Demo](https://space.ovenplayer.com/)** and see examples of applying in [OvenSpace Repository](https://github.com/AirenSoft/OvenSpace).
 
 ## Features
-
-* HTML5 Standard Player
-* Streaming Playback with Various Protocols
+* HTML5 Standard Video Player
+* Live Streaming with Various Protocols
     * Sub-Second Latency: WebRTC (Signalling Protocol Conforms to the OME Specification)
-    * Low Latency: MPEG-DASH (Chunked CMAF)
-    * Legacy: MPEG-DASH, HLS
-* Automatic Fallback
+    * Low Latency: LLHLS, LLDASH (Chunked CMAF)
+    * Legacy: HLS, MPEG-DASH
+* Automatic Fallback Streaming
 * Fully Customizable UI and SDK
-* Insert ADs with Various Formats
+* Insert ADs with Various Formats<
     * VAST4, VAST3, VAST2, VPAID2 (HTML5), VMAP1.0.1
 * Support Multiple Subtitle Formats
     * SMI, VTT, SRT
 
-
 ## Quick Start
-
 Please read the [Quick Start](https://airensoft.gitbook.io/ovenplayer/#quick-start).
 
+### OvenPlayer Demo
+* Without TLS: http://demo.ovenplayer.com
+* With TLS: https://demo.ovenplayer.com
 
 ## API and Configuration
+Start the [Demo](https://demo.ovenplayer.com) and see [API and Configuration](https://airensoft.gitbook.io/ovenplayer/initialization) for more details.
 
-Start the [Demo](https://airensoft.github.io/OvenPlayer/docs/demo.html) and see [API and Configuration](docs/api.md) for more details.
-
+## Build the source code
+Check out [Build](https://airensoft.gitbook.io/ovenplayer/builds) section how to create `ovenplayer.js` for deployment or development after modifying the source code.
 
 ## How to contribute
-
 We appreciate your interest in OvenPlayer.
 
 We need your help to keep and develop our open-source project, and we want to tell you that you can contribute in many ways. Please read our [Guidelines](CONTRIBUTING.md), [Rules](CODE_OF_CONDUCT.md), and [Contribute](https://www.ovenmediaengine.com/contribute).
@@ -66,20 +52,27 @@ We need your help to keep and develop our open-source project, and we want to te
 We always hope that OvenPlayer will make your project a success.
 
 ## For more information
-
-* [OvenPlayer Website](https://www.ovenmediaengine.com/ovenplayer) 
-  * Basic Information about OvenPlayer
-* [OvenPlayer Tutorial](https://airensoft.gitbook.io/ovenplayer/)
-  * Quick Start, API Reference, and Examples
-* Test Player
-  * `Without TLS`: [http://demo.ovenplayer.com](http://demo.ovenplayer.com)
-  * `With TLS`: [https://demo.ovenplayer.com](https://demo.ovenplayer.com)
-* [OvenMediaEngine Github](https://github.com/AirenSoft/OvenMediaEngine)
-  * Sub-Second Latency Streaming Server
-* [AirenSoft Website](https://www.airensoft.com/)
-  * AirenSoft's Solutions/Services, and Blog (Tech Journal)
-
+* [AirenSoft Website](https://airensoft.com) 
+  * About OvenMediaEngine, OvenMediaEngine Enterprise, OvenVideo, AirenBlog and more
+* [OvenPlayer Getting Started](https://airensoft.gitbook.io/ovenplayer)
+  * User guide for OvenPlayer UI Customize, API Reference, Examples, and more
+* [OvenMediaEngine GitHub](https://github.com/AirenSoft/OvenMediaEngine)
+  * Sub-Second Latency Streaming Server with LLHLS and WebRTC
+* [OvenMediaEngine Getting Started](https://airensoft.gitbook.io/ovenmediaengine/)
+  * User guide for OvenMediaEngine Configuration, ABR, Clustering, and more
+* [OvenLiveKit](https://github.com/AirenSoft/OvenLiveKit-Web)
+  * JavaScript-based Live Streaming Encoder for OvenMediaEngine
+* [OvenSpace Demo](https://space.ovenplayer.com/)
+  * Sub-Second Latency Streaming Demo Service
 
 ## License
-
 OvenPlayer is licensed under the [MIT license](LICENSE).
+
+## About AirenSoft
+AirenSoft aims to make it easier for you to build a stable broadcasting/streaming service with Sub-Second Latency.
+Therefore, we will continue developing and providing the most optimized tools for smooth Sub-Second Latency Streaming.
+
+Would you please click on each link below for details:
+* ["JavaScript-based Live Streaming Encdoer" **OvenLiveKit**](https://github.com/AirenSoft/OvenLiveKit-Web)
+* ["Sub-Second Latency Streaming Server with LLHLS and WebRTC" **OvenMediaEngine**](https://github.com/AirenSoft/OvenMediaEngine)
+* ["JavaScript-based Player with LLHLS and WebRTC" **OvenPlayer**](https://github.com/AirenSoft/OvenPlayer)