@byteplus/veplayer 1.8.1 → 2.3.0-rc.0

package/LICENSE

@@ -0,0 +1,18 @@
+## [@byteplus/veplayer] License
+
+Copyright 2024 BytePlus Pte Ltd. All Rights Reserved.
+
+The @byteplus/veplayer was developed by BytePlus Pte Ltd. (hereinafter
+“BytePlus”). Any copyright or patent right is owned by and proprietary material of the
+BytePlus.
+
+@byteplus/veplayer is available under the @byteplus/veplayer and licensed under the
+commercial license. Customers can contact contact@byteplus.com for commercial licensing
+options. Here is also a link to subscription services agreement:
+https://www.byteplus.com/en/product/medialive.
+
+Without BytePlus's prior written permission, any use of @byteplus/veplayer, in particular
+any use for commercial purposes, is prohibited. This includes, without limitation, incorporation in a commercial product, use in a commercial service.
+
+Without BytePlus's prior written permission, the @byteplus/veplayer may not be
+reproduced, modified and/or made available in any form to any third party.

package/README.md

@@ -1,46 +1,13 @@
-### VePlayer
+# VePlayer
 
 [BytePlus](https://www.byteplus.com/en) Web player SDK，can automatically adapt to PC and H5 scenes, support MP4, HLS, FLV, DASH and other formats of on-demand and live broadcast, combined with video cloud, it has functions such as playback quality log reporting, encrypted playback, etc.
 
-### Import the SDK
-Install SDK dependencies into the project through the package management tool.
-```bash
-npm install @byteplus/veplayer --save
-```
-Import VePlayer and style files in the project.
-```javascript
-import VePlayer from '@byteplus/veplayer';
-import '@byteplus/veplayer/dist/index.min.css';
-```
+## Quick Start
 
-### Add playback container
-Add a player container on the page where the player needs to be displayed, for example, add the following code to index.html.
-```javascript
-<div id="video"></div>
+```node
+npm install @volcengine/veplayer
 ```
-### Player instantiation
-After getting the video URL, instantiate the player.
 
-#### Video On Demand
-```javascript
-const player = new VePlayer({
-    id: 'video', // playback container
-    url: "https://demo.vod.com/xxx.mp4", // video URL
-    vodLogOpts: {
-        vtype: 'MP4', // Video format, the video of HLS protocol should be imported into HLS
-        tag: 'Normal', // Business tags, used to distinguish different scenarios in the business, to facilitate subsequent multi-dimensional analysis
-        line_app_id: 235399, // [Required] The value is int type, the SDK application id for accessing VOD, which can be obtained from VOD Console-VOD SDK-Application Management
-        line_user_id: 'XXX' // User id, String or int type, if not passed in, it will be a value randomly generated according to the user's browser
-    }
-});
-```
-For a detailed description of VOD, refer to[BytePlus - Video On Demand - Player SDK - Web](https://docs.byteplus.com/en/byteplus-vod/docs/getting-started-with-the-sdk_2)
+## Documents
 
-#### Live
-```javascript
-const playerSdk = new VePlayer({
-  id: 'video',
-  isLive: true,
-  url: '//livepull.example.com/appname/streamname.flv'
-});
-```
+[Introduction](https://docs.byteplus.com/en/byteplus-media-live/docs/introduction-to-the-player-sdk-for-web) <br>