@touchcastllc/napster-companion-api-dev 2.0.0-alpha.17 → 2.0.0-alpha.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.css +1 -1
- package/lib/index.d.ts +3 -0
- package/lib/index.esm.js +1 -1
- package/lib/index.js +1 -1
- package/lib/index.standalone.js +1 -1
- package/lib/services/sessionAnnouncements.d.ts +32 -0
- package/package.json +1 -1
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Turns session, microphone, sound and screen-share changes into short
|
|
3
|
+
* screen-reader announcements (CA-1145, WCAG 4.1.3). Texts proposed by the
|
|
4
|
+
* developer, approved by the manager in review.
|
|
5
|
+
*
|
|
6
|
+
* "Session ended" is not here: teardown resets the avatar and the session
|
|
7
|
+
* before anything could tell an end from a reset, so `destroyInstance()`
|
|
8
|
+
* stops this watcher first and announces the end itself.
|
|
9
|
+
*
|
|
10
|
+
* Everything is spoken through the widget's announcer (utils/announcer.ts).
|
|
11
|
+
*/
|
|
12
|
+
export declare const ANNOUNCEMENTS: {
|
|
13
|
+
readonly connecting: "Connecting";
|
|
14
|
+
readonly ready: "Avatar is ready";
|
|
15
|
+
readonly muted: "Microphone muted";
|
|
16
|
+
readonly unmuted: "Microphone unmuted";
|
|
17
|
+
readonly micUnavailable: "Microphone unavailable";
|
|
18
|
+
readonly micAvailable: "Microphone available again";
|
|
19
|
+
readonly soundMuted: "Sound muted";
|
|
20
|
+
readonly soundUnmuted: "Sound unmuted";
|
|
21
|
+
readonly screenShareStarted: "Screen sharing started";
|
|
22
|
+
readonly screenShareStopped: "Screen sharing stopped";
|
|
23
|
+
readonly sessionEnded: "Session ended";
|
|
24
|
+
};
|
|
25
|
+
export declare function watchSessionAnnouncements(announce: (text: string) => void): () => void;
|
|
26
|
+
/**
|
|
27
|
+
* Speaks `text` from a short-lived region on the page body, `delayMs` from
|
|
28
|
+
* now. Only for the end of a session whose root is removed (no click-to-start
|
|
29
|
+
* button): the widget's announcer lives in that root and goes with it.
|
|
30
|
+
* Returns a function that removes the region early.
|
|
31
|
+
*/
|
|
32
|
+
export declare function announceOutsideWidget(text: string, delayMs?: number): () => void;
|