@seams/voice-capture 0.67.1 → 0.68.1

package/README.md

@@ -108,13 +108,36 @@ try {
 
 - `record()` resolves with `recorded` (the samples) or `cancelled`. A too quiet recording
   stays on the card with "Try again".
+- `autoStart: true` starts the first recording with no press on Record. Use it when the person
+  just asked for the card with a click or a key. The card then shows no Record button and has
+  no row for it, so it is shorter and its rows sit in the middle. If the browser starts audio
+  only after a press, the card shows its Record button; "Try again" and a result's button
+  bring the row back too.
 - `show()` resolves with `action` when the person selects the button of a result, `closed`
   when the person closes the card, or `replaced` when a new view or recording takes its place.
 - The card uses the CSS variables `--seams-colors-*`, `--seams-shape-*` and
   `--seams-font-family` when the page sets them, and has its own values when it does not.
+  Record and the other main buttons use `--seams-colors-buttonBackground` and
+  `--seams-colors-textButton`. Without them, the main button has the text colour
+  (`textPrimary`) with the card's background colour as its text.
+  The voice line and the Beam glow under it take these values, and keep today's look
+  without them:
+
+  | CSS variable | Theme key (Seams Wallet) | What it sets | Default |
+  | --- | --- | --- | --- |
+  | `--seams-colors-voiceLine` | `colors.voiceLine` | The voice line, its ring and its seal | The text colour |
+  | `--seams-colors-voiceEcho` | `colors.voiceEcho` | Echo lines 1 and 3 behind the line | `voiceLine` |
+  | `--seams-colors-voiceEchoDeep` | `colors.voiceEchoDeep` | Echo line 2 | `voiceEcho` |
+  | `--seams-colors-voiceBeam` | `colors.voiceBeam` | The Beam palette: `colorful`, `mono`, `ocean`, `sunset`, `forest`, `candy`, `ice` or `gold`. `mono` is grey, band included | `ocean` |
+  | `--seams-shape-voiceLineWidth` | `shape.voiceLineWidth` | The width of the voice line | `1px` |
+  | `--seams-shape-voiceEchoWidth` | `shape.voiceEchoWidth` | The width of the echo lines | `0.65px` |
   `data-theme="light"` or `"dark"` on the page selects the glow colours.
-- `frame` adds what a host needs: the parent element, more class names, a Back control, and a
-  callback when the card is in the document.
+- `frame` adds what a host needs: the parent element, more class names, the corner controls,
+  and a callback when the card is in the document.
+- `frame.controls` sets the corner controls: `'close'` (default), `'back'` (Back in place of
+  Close) or `'back_and_close'`. Back is in the leading corner, Close in the trailing corner.
+  Each one ends the card. `frame.pressed(control)` tells you which one the person
+  pressed, before the card ends. Escape also ends the card, with no `pressed` call.
 - `VoicePrompt`, `PhraseCard`, `VoiceRibbon` and `VoiceVisual` are exported for a host that
   makes its own surfaces.