@viostream/viostream-player-svelte 0.1.3 → 0.2.1

package/README.md

@@ -74,16 +74,21 @@ All embed options are optional and passed directly to the Viostream embed API.
 | Prop | Type | Description |
 |---|---|---|
 | `chapters` | `boolean` | Display chapter markers. |
-| `chapterDisplayType` | `'dropdown' \| 'progressbar' \| 'horizontal'` | Chapter display style. |
 | `chapterSlug` | `string` | Seek to a named chapter before playback. |
-| `displayTitle` | `boolean` | Show the video title overlay. |
-| `hlsQualitySelector` | `boolean` | Show the HLS quality selector. |
+| `displayTitle` | `boolean` | Show the video title overlay. Default: `false`. |
+| `hlsQualitySelector` | `boolean` | Show the HLS quality selector. Default: `true`. |
 | `playerKey` | `string` | Override the player theme to use. |
-| `sharing` | `boolean` | Show sharing controls. |
-| `speedSelector` | `boolean` | Show playback speed selector. |
+| `playerStyle` | `'video' \| 'audio' \| 'audio-poster'` | The player rendering style. Default: `'video'`. |
+| `sharing` | `boolean` | Show sharing controls. Default: `false`. |
+| `skinActive` | `string` | Custom skin active colour (e.g. `'#ff0000'`). Requires `skinCustom: true`. |
+| `skinBackground` | `string` | Custom skin background colour (e.g. `'#000000'`). Requires `skinCustom: true`. |
+| `skinCustom` | `boolean` | Enable a custom skin via the API. Default: `false`. |
+| `skinInactive` | `string` | Custom skin inactive colour (e.g. `'#cccccc'`). Requires `skinCustom: true`. |
+| `speedSelector` | `boolean` | Show playback speed selector. Default: `true`. |
 | `startEndTimespan` | `string` | Play a specific section (e.g. `'10,30'`). |
 | `startTime` | `string` | Seek to a time (seconds) before playback. |
-| `transcriptDownload` | `boolean` | Allow transcript download. |
+| `transcriptDownload` | `boolean` | Allow transcript download. Default: `false`. |
+| `useSettingsMenu` | `boolean` | Enable the settings menu on the control bar. Default: `false`. |
 
 #### Event Callbacks
 
@@ -218,36 +223,7 @@ const paused    = await player.getPaused();          // boolean
 const duration  = await player.getDuration();        // number (seconds)
 const muted     = await player.getMuted();           // boolean
 const ratio     = await player.getAspectRatio();     // number
-const liveTime  = await player.getLiveCurrentTime(); // number (seconds)
 const height    = await player.getHeight();          // number (pixels)
-const tracks    = await player.getTracks();          // ViostreamTrack[]
-```
-
-### Track Management
-
-```ts
-const tracks = await player.getTracks();
-player.setTrack(tracks[0]);   // pass a ViostreamTrack object
-player.setTrack('en');        // or a track id string
-```
-
-### Cue Management
-
-```ts
-player.cueAdd({ startTime: 10, text: 'Introduction' });
-
-player.cueUpdate(
-  { startTime: 10, text: 'Introduction' },
-  { text: 'Updated Introduction' }
-);
-
-player.cueDelete('cue-id');
-```
-
-### Automatic Speech Recognition (ASR)
-
-```ts
-player.asrAdd(cueArray, 'asr-track-id');
 ```
 
 ### Events
@@ -304,19 +280,6 @@ After calling `destroy()`:
 - All event listeners are removed.
 - The player iframe is removed from the DOM.
 - Getter calls will reject with `"Player has been destroyed"`.
-- `player.raw` returns `undefined`.
-
-### Raw Escape Hatch
-
-If you need direct access to the underlying Viostream player instance:
-
-```ts
-const raw = player.raw; // RawViostreamPlayerInstance | undefined
-if (raw) {
-  raw.getVolume((vol) => console.log(vol)); // callback-based original API
-}
-```
-
 ---
 
 ## Script Loader
@@ -354,12 +317,7 @@ import type {
   ViostreamProgressData,
   ViostreamPlayerEventMap,
   ViostreamEventHandler,
-  ViostreamCue,
-  ViostreamCueFieldUpdate,
-  ViostreamTrack,
   CreateViostreamPlayerOptions,
-  RawViostreamPlayerInstance,
-  ViostreamGlobal
 } from 'viostream-player-svelte';
 ```
 
@@ -422,10 +380,6 @@ A complete example showing the component with custom controls, event logging, an
     const vol = await player?.getVolume();
     log = [`volume: ${vol}`, ...log];
   }}>Get Volume</button>
-  <button onclick={async () => {
-    const tracks = await player?.getTracks();
-    log = [`tracks: ${JSON.stringify(tracks)}`, ...log];
-  }}>Get Tracks</button>
 </div>
 
 <pre>{log.join('\n')}</pre>

package/dist/ViostreamPlayer.svelte

@@ -41,16 +41,21 @@
 
 		// Embed options
 		chapters,
-		chapterDisplayType,
 		chapterSlug,
 		displayTitle,
 		hlsQualitySelector,
 		playerKey,
+		playerStyle,
 		sharing,
+		skinActive,
+		skinBackground,
+		skinCustom,
+		skinInactive,
 		speedSelector,
 		startEndTimespan,
 		startTime,
 		transcriptDownload,
+		useSettingsMenu,
 
 		// Event callbacks
 		onplay,
@@ -94,16 +99,21 @@
 	function buildEmbedOptions(): ViostreamEmbedOptions {
 		const opts: ViostreamEmbedOptions = {};
 		if (chapters !== undefined) opts.chapters = chapters;
-		if (chapterDisplayType !== undefined) opts.chapterDisplayType = chapterDisplayType;
 		if (chapterSlug !== undefined) opts.chapterSlug = chapterSlug;
 		if (displayTitle !== undefined) opts.displayTitle = displayTitle;
 		if (hlsQualitySelector !== undefined) opts.hlsQualitySelector = hlsQualitySelector;
 		if (playerKey !== undefined) opts.playerKey = playerKey;
+		if (playerStyle !== undefined) opts.playerStyle = playerStyle;
 		if (sharing !== undefined) opts.sharing = sharing;
+		if (skinActive !== undefined) opts.skinActive = skinActive;
+		if (skinBackground !== undefined) opts.skinBackground = skinBackground;
+		if (skinCustom !== undefined) opts.skinCustom = skinCustom;
+		if (skinInactive !== undefined) opts.skinInactive = skinInactive;
 		if (speedSelector !== undefined) opts.speedSelector = speedSelector;
 		if (startEndTimespan !== undefined) opts.startEndTimespan = startEndTimespan;
 		if (startTime !== undefined) opts.startTime = startTime;
 		if (transcriptDownload !== undefined) opts.transcriptDownload = transcriptDownload;
+		if (useSettingsMenu !== undefined) opts.useSettingsMenu = useSettingsMenu;
 		return opts;
 	}
 

package/dist/index.d.ts

@@ -33,6 +33,6 @@
  * ```
  */
 export { default as ViostreamPlayer } from './ViostreamPlayer.svelte';
-export { createViostreamPlayer, wrapRawPlayer, loadViostream, } from '@viostream/viostream-player-core';
-export type { CreateViostreamPlayerOptions, ViostreamEmbedOptions, ViostreamTimeUpdateData, ViostreamVolumeChangeData, ViostreamErrorData, ViostreamProgressData, ViostreamPlayerEventMap, ViostreamEventHandler, ViostreamCue, ViostreamCueFieldUpdate, ViostreamTrack, ViostreamPlayer as ViostreamPlayerInstance, RawViostreamPlayerInstance, ViostreamGlobal, } from '@viostream/viostream-player-core';
+export { createViostreamPlayer, loadViostream, } from '@viostream/viostream-player-core';
+export type { CreateViostreamPlayerOptions, ViostreamEmbedOptions, ViostreamTimeUpdateData, ViostreamVolumeChangeData, ViostreamErrorData, ViostreamProgressData, ViostreamPlayerEventMap, ViostreamEventHandler, ViostreamPlayer as ViostreamPlayerInstance, } from '@viostream/viostream-player-core';
 export type { ViostreamPlayerProps, ViostreamPlayerEventProps, } from './types.js';

package/dist/index.js

@@ -35,4 +35,4 @@
 // Component
 export { default as ViostreamPlayer } from './ViostreamPlayer.svelte';
 // Re-export everything from core so consumers can import from this package
-export { createViostreamPlayer, wrapRawPlayer, loadViostream, } from '@viostream/viostream-player-core';
+export { createViostreamPlayer, loadViostream, } from '@viostream/viostream-player-core';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@viostream/viostream-player-svelte",
-  "version": "0.1.3",
+  "version": "0.2.1",
   "description": "Svelte 5 SDK for the Viostream video player — embed, control, and listen to player events",
   "license": "MIT",
   "publishConfig": {
@@ -30,7 +30,7 @@
     "!dist/**/*.spec.*"
   ],
   "dependencies": {
-    "@viostream/viostream-player-core": "^0.1.2"
+    "@viostream/viostream-player-core": "^0.2.1"
   },
   "peerDependencies": {
     "svelte": "^5.0.0"