@latest-thinking/lt-player 1.1.0 → 1.2.0-a

package/ README.md

@@ -141,4 +141,130 @@ You can instantiate by javascript object config. See examples:
     })
 </script>
 ```
+# Multiple captions - support for multiple caption tracks
 
+### HTML5 Video config
+
+| Option               | Type                       | Default                                                                                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| -------------------- | -------------------------- |----------------------------------------------------------------------------------------------------------------------| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `captions`           | Object                     | `{ active: true, language: 'auto', update: true, label="", url="" srclang="" default=boolean }` | `active`: Toggles if captions should be active by default. `language`: Sets the default language to load (if available). 'auto' uses the browser language. `update`: Listen to changes to tracks and update menu. This is needed for some streaming libraries, but can result in non-selectable language options).                                                                                                                      |
+
+HTML5 only
+
+### The `.source` setter
+
+This allows changing the player source and type on the fly.
+
+Video example:
+
+```js
+player.source = {
+  tracks: [
+    {
+      kind: 'captions',
+      label: 'English',
+      srclang: 'en',
+      src: '/path/to/captions.en.vtt',
+      default: true,
+    },
+    {
+      kind: 'captions',
+      label: 'French',
+      srclang: 'fr',
+      src: '/path/to/captions.fr.vtt',
+    },
+  ],
+};
+```
+## Methods
+
+Example method use:
+
+```js
+player.toggleCaptions(toggle); 
+```
+
+
+## Example player config
+```json
+ {
+  "version": 2,
+  "body": {
+    "pinText" : true,
+    "pinSeekBar" : false,
+    "pinControls" : false,
+    "embed": false,
+    "playerType": "portrait",
+    "chapters": [
+      {
+        "name": "Capitol 1",
+        "timestamp": "10"
+      },
+      {
+        "name": "Capitol 2",
+        "timestamp": "15"
+      },
+      {
+        "name": "Capitol 3",
+        "timestamp": "17"
+      }
+    ],
+    "defaultConfig": {
+      "captions": {
+        "active": false,
+        "language": "en",
+        "update": true,
+        "label": "asdfasdfasdf",
+        "url": "/lt-player/examples/samples/vtt/Pahl-Kerstin-Maria-MAIN-20230320.vtt",
+        "srclang": "en"
+       }
+    },
+    "captionsEnabled": false,
+    "videoTitle": "Maja Adena",
+    "posterImage": "https://web.lt.dev.welink.sh/sites/default/files/2023-09/Video%201.00_00_00_00.Standbild001.jpg",
+    "videoParagraph": "What Are Some Unintended Consequences of Pension Reform?",
+    "videoUrl": "https://player.vimeo.com/external/837554695.m3u8?s=0c690ee7961cdfabf925774a536d2376e155d7fe",
+    "tracks": "https://web.lt.dev.welink.sh/sites/default/files/video-short/subtitles/Pahl-Kerstin-Maria-MAIN-20230320.vtt",
+    "fullscreenDisabled": true,
+    "share": {
+        "canonicalUrl": "http://stg.lt.org/publication/what-are-economic-consequences-international-migration",
+        "embedUrl": "https://stg.lt.org/embed/2892",
+        "title": "What Are the Economic Consequences of International Migration?"
+      },
+    "additionalInfo": {
+      "bio": {
+        "title": "Bio",
+        "description": "Maja Adena is a Postdoctoral Researcher in economics. She received her PhD from the Free University Berlin, where she worked as a research fellow until 2012. Ever since, Adena worked with the Social Science Research Centre Berlin (WZB), where she acts not only as a researcher, but also as a member of the academic council. \n\nAdena’s research interests reach from applied microeconomics to political economy and behavioural economics with a more specific interest in the economy of non-profit and charitable organisations."
+      },
+      "institution": {
+        "title": "Institution",
+        "institutionName": "Florida State University",
+        "image": "https://web.lt.dev.welink.sh/sites/default/files/institution/florida-state-university_cover.jpg",
+        "description": "Florida State University preserves, expands, and disseminates knowledge in the sciences, technology, arts, humanities, and professions, while embracing a philosophy of learning strongly rooted in the traditions of the liberal arts. The university is dedicated to excellence in teaching, research, creative endeavors, and service. The university strives to instill the strength, skill, and character essential for lifelong learning, personal responsibility, and sustained achievement within a community that fosters free inquiry and embraces diversity."
+      }
+    },
+    "playerContainer": "PLAYER1",
+    "preload": {
+    "start": 5,
+    "stop": 10,
+    "autoType": true,
+    "isActive": true
+    },
+    "autoPlay": true,
+    "fullscreenDisabled": true,
+    "vimeo": {
+      "controls": false,
+      "active": false,
+      "gesture": "media",
+      "transparent": true,
+      "speed": true,
+      "portrait": true,
+      "keyboard": false,
+      "title": false,
+      "byline": false,
+      "playsinline": true,
+      "background": true
+    }
+  }
+}
+```