@pie-players/pie-tool-tts-inline 1.0.0-beta.0 → 1.0.0-beta.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PIE Framework contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -38,8 +38,9 @@ content to read. Section players provide both; around a plain item player, the
 host writes the toolkit and the scope. The packaged
 `textToSpeech` capability in `@pie-players/pie-default-tool-loaders` creates
 this element in item and passage toolbars, takes `catalog-id` and `size` from
-the toolbar, and takes `layout-mode`, `speedOptions` and
-`showSingleSpeedOption` from the toolkit's `textToSpeech` tool configuration.
+the toolbar, takes `layout-mode`, `speedOptions` and `showSingleSpeedOption` from
+the toolkit's `textToSpeech` tool configuration, and takes `base-rate`, `pitch`
+and `volume` from the policy's `textToSpeech` tool parameters.
 
 ```javascript
 import '@pie-players/pie-tool-tts-inline';
@@ -80,6 +81,17 @@ passageHeader.append(ttsButton);
   the first keeps the controls row reserved and the second expands it while the
   panel is open. `'floating-overlay'` and `'left-aligned'` open the panel as an
   overlay to the left of the trigger.
+- `base-rate` - Multiplies every speed option, so a learner's normal speed
+  can differ from the provider's (default: `1`). A value that is not a
+  positive number means `1`.
+- `pitch` - The pitch this element's reads start at, `0`–`2` with `1` normal,
+  clamped to that range (default: the service's).
+- `volume` - The volume this element's reads start at, `0`–`1`, clamped
+  (default: the service's).
+
+Pitch and volume stay the service's after a read, so a read started
+elsewhere, such as the annotation toolbar's read-selection, uses the last
+values set.
 
 ### JavaScript Properties
 

package/custom-elements.json

@@ -25,7 +25,7 @@
 							"kind": "field",
 							"name": "size",
 							"type": {
-								"text": "'sm' | 'md' | 'lg'"
+								"text": "TtsInlineSize"
 							},
 							"default": "'md'",
 							"attribute": "size"
@@ -55,6 +55,34 @@
 							},
 							"default": "'left-aligned'",
 							"attribute": "layout-mode"
+						},
+						{
+							"kind": "field",
+							"name": "baseRate",
+							"type": {
+								"text": "number"
+							},
+							"default": "1",
+							"description": "Multiplies every speed choice's rate, so 1× reads at this rate.",
+							"attribute": "base-rate"
+						},
+						{
+							"kind": "field",
+							"name": "pitch",
+							"type": {
+								"text": "number"
+							},
+							"description": "The pitch each read starts at, 0–2 with 1 normal.",
+							"attribute": "pitch"
+						},
+						{
+							"kind": "field",
+							"name": "volume",
+							"type": {
+								"text": "number"
+							},
+							"description": "The volume each read starts at, 0–1.",
+							"attribute": "volume"
 						}
 					],
 					"attributes": [
@@ -96,6 +124,31 @@
 							},
 							"default": "'left-aligned'",
 							"fieldName": "layoutMode"
+						},
+						{
+							"name": "base-rate",
+							"type": {
+								"text": "number"
+							},
+							"default": "1",
+							"description": "Multiplies every speed choice's rate, so 1× reads at this rate.",
+							"fieldName": "baseRate"
+						},
+						{
+							"name": "pitch",
+							"type": {
+								"text": "number"
+							},
+							"description": "The pitch each read starts at, 0–2 with 1 normal.",
+							"fieldName": "pitch"
+						},
+						{
+							"name": "volume",
+							"type": {
+								"text": "number"
+							},
+							"description": "The volume each read starts at, 0–1.",
+							"fieldName": "volume"
 						}
 					],
 					"events": [

package/dist/THIRD-PARTY-LICENSES.txt

@@ -0,0 +1,14 @@
+Third-party software included in this package's bundles, with the licence each is used under.
+
+========================================================================
+
+svelte 5.57.3
+License: MIT
+
+Copyright (c) 2016-2025 [Svelte Contributors](https://github.com/sveltejs/svelte/graphs/contributors)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/element-props.d.ts

@@ -0,0 +1,16 @@
+import { TTSLayoutMode, TTSSpeedOption } from '@pie-players/pie-assessment-toolkit/tools/registration';
+export type TtsInlineSize = "sm" | "md" | "lg";
+/** Inputs shared by the component and its native element declaration. */
+export interface TtsInlineProps {
+    catalogId?: string;
+    size?: TtsInlineSize;
+    speedOptions?: TTSSpeedOption[];
+    showSingleSpeedOption?: boolean;
+    layoutMode?: TTSLayoutMode;
+    /** Multiplies every speed choice's rate, so 1× reads at this rate. */
+    baseRate?: number;
+    /** The pitch each read starts at, 0–2 with 1 normal. */
+    pitch?: number;
+    /** The volume each read starts at, 0–1. */
+    volume?: number;
+}

package/dist/index.d.ts

@@ -1,8 +1,13 @@
-/**
- * pie-tool-tts-inline
- *
- * Importing this package registers `<pie-tool-tts-inline>`. The build entry is
- * the component, so this file is the type entry alone and declares nothing: a
- * runtime export here would not exist in the built bundle.
- */
-export type {};
+import { TTSLayoutMode, TTSSpeedOption } from '@pie-players/pie-assessment-toolkit/tools/registration';
+import { TtsInlineProps, TtsInlineSize } from './element-props.js';
+export type PieToolTtsInlineSize = TtsInlineSize;
+export type PieToolTtsInlineLayoutMode = TTSLayoutMode;
+export type PieToolTtsInlineSpeedOption = TTSSpeedOption;
+/** Native host interface for `<pie-tool-tts-inline>`. Properties may be unset until it mounts. */
+export interface PieToolTtsInlineElement extends HTMLElement, TtsInlineProps {
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "pie-tool-tts-inline": PieToolTtsInlineElement;
+    }
+}