@readium/speech 0.4.0 → 0.5.0

package/build/navigator.d.ts

@@ -5,7 +5,7 @@ export interface ReadiumSpeechPlaybackEvent {
     type: "start" | "pause" | "resume" | "end" | "stop" | "skip" | "error" | "boundary" | "mark" | "idle" | "loading" | "ready" | "voiceschanged" | "languagefallback";
     detail?: any;
 }
-export interface ReadiumSpeechNavigator {
+export interface ReadiumSpeechNavigatorContract {
     getVoices(): Promise<ReadiumSpeechVoice[]>;
     setVoice(voice: ReadiumSpeechVoice | string): void;
     getCurrentVoice(): ReadiumSpeechVoice | null;

package/build/providerRegistry.d.ts

@@ -0,0 +1,19 @@
+import { ReadiumSpeechEngineProvider } from './provider';
+import { ReadiumSpeechPlaybackEngine } from './engine';
+import { ReadiumSpeechVoice } from './voices/types';
+export interface ReadiumSpeechProviderVoices {
+    providerId: string;
+    voices: ReadiumSpeechVoice[];
+}
+export declare class ReadiumSpeechProviderRegistry {
+    private providers;
+    register(provider: ReadiumSpeechEngineProvider): void;
+    unregister(providerId: string): void;
+    get(providerId: string): ReadiumSpeechEngineProvider | undefined;
+    list(): ReadiumSpeechEngineProvider[];
+    getVoices(providerId: string): Promise<ReadiumSpeechVoice[]>;
+    getAllVoices(): Promise<ReadiumSpeechProviderVoices[]>;
+    createEngine(providerId: string, voice?: ReadiumSpeechVoice | string): Promise<ReadiumSpeechPlaybackEngine>;
+    destroy(): Promise<void>;
+    private require;
+}

package/build/{WebSpeech/TmpNavigator.d.ts → speechNavigator.d.ts}

@@ -1,13 +1,13 @@
-import { ReadiumSpeechPlaybackEngine } from '../engine';
-import { ReadiumSpeechNavigator, ReadiumSpeechPlaybackEvent, ReadiumSpeechPlaybackState } from '../navigator';
-import { ReadiumSpeechUtterance } from '../utterance';
-import { ReadiumSpeechVoice } from '../voices/types';
-export declare class WebSpeechReadAloudNavigator implements ReadiumSpeechNavigator {
+import { ReadiumSpeechPlaybackEngine } from './engine';
+import { ReadiumSpeechNavigatorContract, ReadiumSpeechPlaybackEvent, ReadiumSpeechPlaybackState } from './navigator';
+import { ReadiumSpeechUtterance } from './utterance';
+import { ReadiumSpeechVoice } from './voices/types';
+export declare class ReadiumSpeechNavigator implements ReadiumSpeechNavigatorContract {
     private engine;
     private contentQueue;
     private eventListeners;
     private navigatorState;
-    constructor(engine?: ReadiumSpeechPlaybackEngine);
+    constructor(engine: ReadiumSpeechPlaybackEngine);
     private initializeEngine;
     private setupEngineListeners;
     private setNavigatorState;

package/build/voices/types.d.ts

@@ -13,7 +13,17 @@ export type TLocalizedName = "android" | "apple";
 /**
  * Source of the voice data
  */
-export type TSource = "json" | "browser";
+export type TSource = "json" | "browser" | "server";
+/**
+ * Controls a speech-server voice reports as enabled, e.g. {ssml: true}.
+ * A control absent from this object is not supported by that voice.
+ */
+export interface TServerVoiceControls {
+    pitch?: boolean;
+    speed?: boolean;
+    ssml?: boolean;
+    boundary?: boolean;
+}
 /**
  * Supported operating systems for voices
  */
@@ -70,6 +80,8 @@ export interface ReadiumSpeechVoice {
     nativeID?: string | string[];
     note?: string;
     provider?: string;
+    identifier?: string;
+    controls?: TServerVoiceControls;
     isDefault?: boolean;
     offlineAvailability?: boolean;
     isNovelty?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readium/speech",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "A TypeScript library for implementing read aloud features with Web technologies, following best practices for digital publishing.",
   "author": "Readium Foundation",
   "keywords": [