@readium/speech 0.6.0 → 0.7.1

package/build/preferences/SpeechDefaults.d.ts

@@ -1,5 +1,5 @@
 import { GndRole } from '../gnd/types.js';
-import { ExtractionFormat, LanguageMode, PauseScope, VerbosityPreset } from './SpeechPreferences.js';
+import { AutoPauseScope, ExtractionFormat, LanguageMode, VerbosityPreset } from './SpeechPreferences.js';
 export interface ISpeechDefaults {
     format?: ExtractionFormat | null;
     inlineContextualization?: boolean | null;
@@ -8,8 +8,7 @@ export interface ISpeechDefaults {
     contextualize?: GndRole[] | null;
     language?: LanguageMode | null;
     pauseDuration?: number | null;
-    pauseScope?: PauseScope | null;
-    automaticPausesAtPageOrSpreadEnd?: boolean | null;
+    autoPause?: AutoPauseScope | null;
     rate?: number | null;
     pitch?: number | null;
     volume?: number | null;
@@ -22,8 +21,7 @@ export declare class SpeechDefaults {
     readonly contextualize: GndRole[];
     readonly language: LanguageMode;
     readonly pauseDuration: number;
-    readonly pauseScope: PauseScope;
-    readonly automaticPausesAtPageOrSpreadEnd: boolean;
+    readonly autoPause: AutoPauseScope;
     readonly rate: number;
     readonly pitch: number;
     readonly volume: number;

package/build/preferences/SpeechPreferences.d.ts

@@ -3,7 +3,7 @@ import { ConfigurablePreferences } from './Configurable.js';
 export type VerbosityPreset = "none" | "few" | "some" | "most" | "custom";
 export type LanguageMode = "none" | "block-level" | "always";
 export type ExtractionFormat = "plain" | "ssml";
-export type PauseScope = "utterance" | "block";
+export type AutoPauseScope = "none" | "utterance" | "block";
 export interface ISpeechPreferences {
     format?: ExtractionFormat | null;
     inlineContextualization?: boolean | null;
@@ -12,8 +12,7 @@ export interface ISpeechPreferences {
     contextualize?: GndRole[] | null;
     language?: LanguageMode | null;
     pauseDuration?: number | null;
-    pauseScope?: PauseScope | null;
-    automaticPausesAtPageOrSpreadEnd?: boolean | null;
+    autoPause?: AutoPauseScope | null;
     rate?: number | null;
     pitch?: number | null;
     volume?: number | null;
@@ -26,8 +25,7 @@ export declare class SpeechPreferences implements ISpeechPreferences, Configurab
     contextualize: GndRole[] | null | undefined;
     language: LanguageMode | null | undefined;
     pauseDuration: number | null | undefined;
-    pauseScope: PauseScope | null | undefined;
-    automaticPausesAtPageOrSpreadEnd: boolean | null | undefined;
+    autoPause: AutoPauseScope | null | undefined;
     rate: number | null | undefined;
     pitch: number | null | undefined;
     volume: number | null | undefined;

package/build/preferences/SpeechPreferencesEditor.d.ts

@@ -1,6 +1,6 @@
 import { IPreferencesEditor } from './PreferencesEditor.js';
 import { BooleanPreference, EnumPreference, RangePreference, StringArrayPreference } from './Preference.js';
-import { SpeechPreferences, VerbosityPreset, LanguageMode, ExtractionFormat, PauseScope } from './SpeechPreferences.js';
+import { SpeechPreferences, VerbosityPreset, LanguageMode, ExtractionFormat, AutoPauseScope } from './SpeechPreferences.js';
 import { SpeechSettings } from './SpeechSettings.js';
 export declare class SpeechPreferencesEditor implements IPreferencesEditor {
     preferences: SpeechPreferences;
@@ -15,8 +15,7 @@ export declare class SpeechPreferencesEditor implements IPreferencesEditor {
     get contextualize(): StringArrayPreference;
     get language(): EnumPreference<LanguageMode>;
     get pauseDuration(): RangePreference<number>;
-    get pauseScope(): EnumPreference<PauseScope>;
-    get automaticPausesAtPageOrSpreadEnd(): BooleanPreference;
+    get autoPause(): EnumPreference<AutoPauseScope>;
     get rate(): RangePreference<number>;
     get pitch(): RangePreference<number>;
     get volume(): RangePreference<number>;

package/build/preferences/SpeechSettings.d.ts

@@ -1,7 +1,7 @@
 import { GndRole } from '../gnd/types.js';
 import { ConfigurableSettings } from './Configurable.js';
 import { SpeechDefaults } from './SpeechDefaults.js';
-import { ExtractionFormat, LanguageMode, PauseScope, SpeechPreferences, VerbosityPreset } from './SpeechPreferences.js';
+import { AutoPauseScope, ExtractionFormat, LanguageMode, SpeechPreferences, VerbosityPreset } from './SpeechPreferences.js';
 export declare class SpeechSettings implements ConfigurableSettings {
     [key: string]: unknown;
     readonly format: ExtractionFormat;
@@ -11,8 +11,7 @@ export declare class SpeechSettings implements ConfigurableSettings {
     readonly contextualize: GndRole[];
     readonly language: LanguageMode;
     readonly pauseDuration: number;
-    readonly pauseScope: PauseScope;
-    readonly automaticPausesAtPageOrSpreadEnd: boolean;
+    readonly autoPause: AutoPauseScope;
     readonly rate: number;
     readonly pitch: number;
     readonly volume: number;

package/build/preferences/constraints.d.ts

@@ -1,4 +1,4 @@
-import { ExtractionFormat, ISpeechPreferences, LanguageMode, PauseScope, VerbosityPreset } from './SpeechPreferences.js';
+import { AutoPauseScope, ExtractionFormat, ISpeechPreferences, LanguageMode, VerbosityPreset } from './SpeechPreferences.js';
 export interface RangeConfig {
     range: [number, number];
     step: number;
@@ -10,5 +10,5 @@ export declare const volumeRangeConfig: RangeConfig;
 export declare const verbosityPresets: VerbosityPreset[];
 export declare const languageModes: LanguageMode[];
 export declare const extractionFormats: ExtractionFormat[];
-export declare const pauseScopes: PauseScope[];
+export declare const autoPauseScopes: AutoPauseScope[];
 export declare const extractionPreferenceKeys: (keyof ISpeechPreferences)[];

package/build/speechNavigator.d.ts

@@ -23,8 +23,10 @@ export declare class ReadiumSpeechNavigator implements ReadiumSpeechNavigatorCon
     private _preferencesEditor;
     private source;
     private contentSources;
+    private contentBlockStarts;
     private pendingResumeIndex;
     private pendingResumeState;
+    private pendingAutoPauseIndex;
     constructor(engine: ReadiumSpeechPlaybackEngine, configuration?: ReadiumSpeechNavigatorConfiguration);
     private applyEngineParameters;
     private initializeEngine;

package/build/utterance.d.ts

@@ -3,5 +3,4 @@ export interface ReadiumSpeechUtterance {
     plain?: string;
     ssml?: string;
     language?: string;
-    startsNewBlock?: true;
 }

package/build/utterances/extractUtterances.d.ts

@@ -11,9 +11,11 @@ import { ExtractUtterancesOptions } from './types.js';
  */
 export declare function extractUtterances(nodes: GndObject[], options: ExtractUtterancesOptions): ReadiumSpeechUtterance[];
 /**
- * Same as `extractUtterances()`, plus `sources[i]`: the node that produced `utterances[i]`.
+ * Same as `extractUtterances()`, plus `sources[i]`: the node that produced `utterances[i]`,
+ * and `blockStarts[i]`: whether `utterances[i]` begins a new block-level element.
  */
 export declare function extractUtterancesWithSources(nodes: GndObject[], options: ExtractUtterancesOptions): {
     utterances: ReadiumSpeechUtterance[];
     sources: (GndObject | undefined)[];
+    blockStarts: boolean[];
 };

package/package.json

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