@mentra/miniapp 3.4.0-dev.999 → 3.4.0
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/README.md +7 -7
- package/dist/background/index.d.ts +5 -2
- package/dist/background/index.d.ts.map +1 -1
- package/dist/background/index.js.map +1 -1
- package/dist/background/register.d.ts +3 -1
- package/dist/background/register.d.ts.map +1 -1
- package/dist/background/register.js +19 -2
- package/dist/background/register.js.map +1 -1
- package/dist/index.d.ts +6 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/modules/blob.d.ts +2 -1
- package/dist/modules/blob.d.ts.map +1 -1
- package/dist/modules/blob.js +2 -1
- package/dist/modules/blob.js.map +1 -1
- package/dist/modules/events.d.ts +16 -6
- package/dist/modules/events.d.ts.map +1 -1
- package/dist/modules/events.js +53 -47
- package/dist/modules/events.js.map +1 -1
- package/dist/modules/mic.d.ts +26 -4
- package/dist/modules/mic.d.ts.map +1 -1
- package/dist/modules/mic.js +13 -4
- package/dist/modules/mic.js.map +1 -1
- package/dist/modules/miniapps.d.ts +44 -57
- package/dist/modules/miniapps.d.ts.map +1 -1
- package/dist/modules/miniapps.js +21 -24
- package/dist/modules/miniapps.js.map +1 -1
- package/dist/modules/speaker.d.ts +41 -10
- package/dist/modules/speaker.d.ts.map +1 -1
- package/dist/modules/speaker.js +17 -6
- package/dist/modules/speaker.js.map +1 -1
- package/dist/modules/speechProcessing.d.ts +29 -0
- package/dist/modules/speechProcessing.d.ts.map +1 -0
- package/dist/modules/speechProcessing.js +22 -0
- package/dist/modules/speechProcessing.js.map +1 -0
- package/dist/modules/stream.d.ts +39 -0
- package/dist/modules/stream.d.ts.map +1 -1
- package/dist/modules/stream.js +13 -1
- package/dist/modules/stream.js.map +1 -1
- package/dist/modules/system.d.ts +8 -3
- package/dist/modules/system.d.ts.map +1 -1
- package/dist/modules/system.js +1 -1
- package/dist/modules/system.js.map +1 -1
- package/dist/modules/telemetry.d.ts +25 -0
- package/dist/modules/telemetry.d.ts.map +1 -0
- package/dist/modules/telemetry.js +61 -0
- package/dist/modules/telemetry.js.map +1 -0
- package/dist/modules/transcription.d.ts +70 -3
- package/dist/modules/transcription.d.ts.map +1 -1
- package/dist/modules/transcription.js +68 -2
- package/dist/modules/transcription.js.map +1 -1
- package/dist/protocol.d.ts +29 -15
- package/dist/protocol.d.ts.map +1 -1
- package/dist/protocol.js +30 -15
- package/dist/protocol.js.map +1 -1
- package/dist/react/MentraProvider.d.ts +13 -1
- package/dist/react/MentraProvider.d.ts.map +1 -1
- package/dist/react/MentraProvider.js +31 -1
- package/dist/react/MentraProvider.js.map +1 -1
- package/dist/react/stream-preview/PreviewConnection.d.ts +13 -0
- package/dist/react/stream-preview/PreviewConnection.d.ts.map +1 -1
- package/dist/react/stream-preview/PreviewConnection.js +40 -1
- package/dist/react/stream-preview/PreviewConnection.js.map +1 -1
- package/dist/react/stream-preview/transport.d.ts.map +1 -1
- package/dist/react/stream-preview/transport.js +2 -0
- package/dist/react/stream-preview/transport.js.map +1 -1
- package/dist/session.d.ts +59 -6
- package/dist/session.d.ts.map +1 -1
- package/dist/session.js +203 -43
- package/dist/session.js.map +1 -1
- package/dist/transport/auto.js +6 -0
- package/dist/transport/auto.js.map +1 -1
- package/dist/transport/dispatch.d.ts +2 -0
- package/dist/transport/dispatch.d.ts.map +1 -1
- package/dist/transport/dispatch.js +7 -2
- package/dist/transport/dispatch.js.map +1 -1
- package/dist/transport/local-socket.d.ts +6 -0
- package/dist/transport/local-socket.d.ts.map +1 -1
- package/dist/transport/local-socket.js +34 -2
- package/dist/transport/local-socket.js.map +1 -1
- package/dist/transport/types.d.ts +4 -1
- package/dist/transport/types.d.ts.map +1 -1
- package/dist/ui/index.d.ts +7 -4
- package/dist/ui/index.d.ts.map +1 -1
- package/dist/ui/index.js.map +1 -1
- package/package.json +2 -2
- package/src/background/index.ts +6 -3
- package/src/background/register.ts +24 -2
- package/src/index.ts +13 -3
- package/src/modules/blob.ts +2 -1
- package/src/modules/events.ts +65 -51
- package/src/modules/mic.ts +30 -4
- package/src/modules/miniapps.ts +59 -71
- package/src/modules/speaker.ts +56 -12
- package/src/modules/speechProcessing.ts +42 -0
- package/src/modules/stream.ts +44 -1
- package/src/modules/system.ts +8 -3
- package/src/modules/telemetry.ts +62 -0
- package/src/modules/transcription.ts +106 -9
- package/src/protocol.ts +32 -16
- package/src/react/MentraProvider.tsx +23 -2
- package/src/react/stream-preview/PreviewConnection.ts +54 -3
- package/src/react/stream-preview/transport.ts +4 -8
- package/src/session.ts +206 -52
- package/src/transport/auto.ts +5 -0
- package/src/transport/dispatch.ts +7 -2
- package/src/transport/local-socket.ts +30 -1
- package/src/transport/types.ts +4 -1
- package/src/ui/index.ts +7 -4
|
@@ -5,13 +5,15 @@
|
|
|
5
5
|
* audio chunks, VAD) lives on session.mic — the split is by I/O direction.
|
|
6
6
|
*
|
|
7
7
|
* Imperative surface:
|
|
8
|
-
* speaker.play({audioUrl}) — play an
|
|
8
|
+
* speaker.play({audioUrl}) — play an http(s) or data: URL, or one of this
|
|
9
|
+
* miniapp's blobs, via the phone's
|
|
9
10
|
* AudioPlaybackService.
|
|
10
|
-
* speaker.speak(text) — send a SPEAK request.
|
|
11
|
-
* TTS when connected and falls
|
|
12
|
-
*
|
|
11
|
+
* speaker.speak(text) — send a SPEAK request. By default the phone
|
|
12
|
+
* streams cloud TTS when connected and falls
|
|
13
|
+
* back to its on-device voice; the
|
|
14
|
+
* `processing` option picks the order.
|
|
13
15
|
* Resolves when playback completes; rejects
|
|
14
|
-
* with a TTS_* error code on
|
|
16
|
+
* with a TTS_* error code on failure.
|
|
15
17
|
* speaker.createStream(opts) — open a live PCM output stream (16-bit LE).
|
|
16
18
|
* Returns a SpeakerStreamWriter: write() PCM
|
|
17
19
|
* chunks as they arrive (e.g. from a WebSocket
|
|
@@ -35,7 +37,12 @@
|
|
|
35
37
|
*/
|
|
36
38
|
import { MiniappSession } from "../session";
|
|
37
39
|
import type { UnsubscribeFn } from "./events";
|
|
40
|
+
import { type SpeechProcessing } from "./speechProcessing";
|
|
38
41
|
export interface PlayAudioOptions {
|
|
42
|
+
/**
|
|
43
|
+
* An http(s) or `data:` URL, or the `file://` uri of one of this miniapp's
|
|
44
|
+
* blobs (`session.blob`). The host refuses any other file or scheme.
|
|
45
|
+
*/
|
|
39
46
|
audioUrl: string;
|
|
40
47
|
/** Start playback at this offset in milliseconds. Defaults to zero. */
|
|
41
48
|
startPositionMs?: number;
|
|
@@ -53,10 +60,17 @@ export interface SpeakOptions {
|
|
|
53
60
|
*/
|
|
54
61
|
enableSanitization?: boolean;
|
|
55
62
|
/**
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
63
|
+
* Where the speech is synthesized. Default `"preferCloud"`.
|
|
64
|
+
*
|
|
65
|
+
* - `"preferCloud"`: cloud TTS while the cloud is connected, otherwise the
|
|
66
|
+
* phone's on-device voice.
|
|
67
|
+
* - `"preferLocal"`: the on-device voice when its model is ready and can say
|
|
68
|
+
* it (an explicit cloud `voice_id` cannot), otherwise cloud TTS.
|
|
69
|
+
* - `"localOnly"`: the on-device voice only; never the cloud. Rejects with
|
|
70
|
+
* `TTS_LOCAL_UNAVAILABLE` when the on-device model isn't ready.
|
|
59
71
|
*/
|
|
72
|
+
processing?: SpeechProcessing;
|
|
73
|
+
/** @deprecated Use `processing: "localOnly"`. Removed in 4.0; ignored when `processing` is set. */
|
|
60
74
|
forceLocal?: boolean;
|
|
61
75
|
}
|
|
62
76
|
export interface SpeakResult {
|
|
@@ -69,6 +83,22 @@ export type SpeakerStreamSampleRate = 16000 | 24000 | 48000;
|
|
|
69
83
|
export interface SpeakerStreamOptions {
|
|
70
84
|
/** PCM sample rate in Hz. Default 16000. */
|
|
71
85
|
sampleRate?: SpeakerStreamSampleRate;
|
|
86
|
+
/**
|
|
87
|
+
* Open the native stream now and keep it idle until the first write, so a
|
|
88
|
+
* later sound only has to write samples. The speaker reports `idle` and other
|
|
89
|
+
* audio is left alone until then. If the audio route changes before the
|
|
90
|
+
* first write (Bluetooth or glasses connect/disconnect, a call, an audio
|
|
91
|
+
* interruption), the phone closes the stream and the next write fails with
|
|
92
|
+
* "not open"; open a fresh stream then.
|
|
93
|
+
*/
|
|
94
|
+
prewarm?: boolean;
|
|
95
|
+
/**
|
|
96
|
+
* How much audio (80–500 ms) the phone queues before playback starts, and
|
|
97
|
+
* the cushion against gaps after that. Default 500. A sound shorter than
|
|
98
|
+
* this still plays once you close the stream. Use a small value such as 80
|
|
99
|
+
* for short cues that should start immediately.
|
|
100
|
+
*/
|
|
101
|
+
jitterMs?: number;
|
|
72
102
|
/** Channel count. v1 is mono only. Default 1. */
|
|
73
103
|
channels?: 1;
|
|
74
104
|
/** Playback volume 0..1. Default 1. */
|
|
@@ -142,8 +172,9 @@ export declare class SpeakerModule {
|
|
|
142
172
|
/** Play a URL. Resolves when playback completes on the phone. */
|
|
143
173
|
play(options: PlayAudioOptions): Promise<void>;
|
|
144
174
|
/**
|
|
145
|
-
* Speak text through the phone
|
|
146
|
-
*
|
|
175
|
+
* Speak text through the phone, in the cloud or on-device as
|
|
176
|
+
* `options.processing` says (default: cloud TTS when connected, then the
|
|
177
|
+
* on-device voice).
|
|
147
178
|
*
|
|
148
179
|
* Rejects with a MiniappRequestError containing a `code` field on cloud-side
|
|
149
180
|
* TTS failures: `TTS_TEXT_TOO_LONG`, `TTS_INVALID_VOICE`, `TTS_UPSTREAM_ERROR`.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"speaker.d.ts","sourceRoot":"","sources":["../../src/modules/speaker.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"speaker.d.ts","sourceRoot":"","sources":["../../src/modules/speaker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAGH,OAAO,EAAC,cAAc,EAAC,MAAM,YAAY,CAAA;AAEzC,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,UAAU,CAAA;AAC3C,OAAO,EAA0B,KAAK,gBAAgB,EAAC,MAAM,oBAAoB,CAAA;AAEjF,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB,uEAAuE;IACvE,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAC7B,mGAAmG;IACnG,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,qEAAqE;IACrE,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAA;AAI/E,oDAAoD;AACpD,MAAM,MAAM,uBAAuB,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAA;AAE3D,MAAM,WAAW,oBAAoB;IACnC,4CAA4C;IAC5C,UAAU,CAAC,EAAE,uBAAuB,CAAA;IACpC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,iDAAiD;IACjD,QAAQ,CAAC,EAAE,CAAC,CAAA;IACZ,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,wEAAwE;IACxE,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,8EAA8E;AAC9E,eAAO,MAAM,yBAAyB,QAAa,CAAA;AAKnD;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,OAAO,CAAA;AAElD;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAK5B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM;IAL3B,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,UAAU,CAAmC;gBAGlC,OAAO,EAAE,cAAc,EAC/B,QAAQ,EAAE,MAAM;IAG3B;;;;;OAKG;IACG,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAc/E,sFAAsF;IAChF,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAgBjE,+EAA+E;IACzE,KAAK,IAAI,OAAO,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC;IAa7C,gEAAgE;IAC1D,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAS5B,OAAO,CAAC,UAAU;YAIJ,IAAI;IASlB,4EAA4E;IAC5E,OAAO,CAAC,YAAY;CAQrB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,YAAY,CAAA;IACnB,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,4EAA4E;IAC5E,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,qBAAa,aAAa;IAIZ,OAAO,CAAC,QAAQ,CAAC,OAAO;IAHpC,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,UAAU,CAAqC;gBAE1B,OAAO,EAAE,cAAc;IAEpD,sCAAsC;IACtC,IAAI,KAAK,IAAI,YAAY,CAExB;IAED,oCAAoC;IACpC,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED,iEAAiE;IAC3D,IAAI,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBpD;;;;;;;OAOG;IACG,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IACjE,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAoC9E;;;;;;;;;OASG;IACG,YAAY,CAAC,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAwBpF,wDAAwD;IACxD,IAAI,IAAI,IAAI;IAIZ;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,GAAG,aAAa;IAIzE,+EAA+E;IAC/E,WAAW,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAS3C,6BAA6B;IAC7B,aAAa,IAAI,iBAAiB;CAGnC"}
|
package/dist/modules/speaker.js
CHANGED
|
@@ -5,13 +5,15 @@
|
|
|
5
5
|
* audio chunks, VAD) lives on session.mic — the split is by I/O direction.
|
|
6
6
|
*
|
|
7
7
|
* Imperative surface:
|
|
8
|
-
* speaker.play({audioUrl}) — play an
|
|
8
|
+
* speaker.play({audioUrl}) — play an http(s) or data: URL, or one of this
|
|
9
|
+
* miniapp's blobs, via the phone's
|
|
9
10
|
* AudioPlaybackService.
|
|
10
|
-
* speaker.speak(text) — send a SPEAK request.
|
|
11
|
-
* TTS when connected and falls
|
|
12
|
-
*
|
|
11
|
+
* speaker.speak(text) — send a SPEAK request. By default the phone
|
|
12
|
+
* streams cloud TTS when connected and falls
|
|
13
|
+
* back to its on-device voice; the
|
|
14
|
+
* `processing` option picks the order.
|
|
13
15
|
* Resolves when playback completes; rejects
|
|
14
|
-
* with a TTS_* error code on
|
|
16
|
+
* with a TTS_* error code on failure.
|
|
15
17
|
* speaker.createStream(opts) — open a live PCM output stream (16-bit LE).
|
|
16
18
|
* Returns a SpeakerStreamWriter: write() PCM
|
|
17
19
|
* chunks as they arrive (e.g. from a WebSocket
|
|
@@ -35,6 +37,7 @@
|
|
|
35
37
|
*/
|
|
36
38
|
import { MiniappErrorCode, MiniappRequestType } from "../protocol";
|
|
37
39
|
import { bytesToBase64, toUint8Array } from "./base64";
|
|
40
|
+
import { resolveSpeechProcessing } from "./speechProcessing";
|
|
38
41
|
/** Raw bytes per bridge write. PCM chunks are small; keep messages snappy. */
|
|
39
42
|
export const SPEAKER_WRITE_CHUNK_BYTES = 256 * 1024;
|
|
40
43
|
// Every non-final base64 slice must decode to complete 16-bit samples. Six
|
|
@@ -176,6 +179,7 @@ export class SpeakerModule {
|
|
|
176
179
|
if ((Array.isArray(normalized) && normalized.length === 0) || normalized === "") {
|
|
177
180
|
throw { code: MiniappErrorCode.INTERNAL, message: "speak requires at least one non-empty sentence" };
|
|
178
181
|
}
|
|
182
|
+
const processing = resolveSpeechProcessing(options, "speaker.speak(options)");
|
|
179
183
|
try {
|
|
180
184
|
// Like play(): resolves only when TTS playback completes, so opt out of the
|
|
181
185
|
// default request timeout (long text can outlast it). Settled by the host
|
|
@@ -188,7 +192,9 @@ export class SpeakerModule {
|
|
|
188
192
|
volume: options.volume,
|
|
189
193
|
stopOtherAudio: options.stopOtherAudio ?? false,
|
|
190
194
|
enableSanitization: options.enableSanitization ?? true,
|
|
191
|
-
|
|
195
|
+
processing,
|
|
196
|
+
// Hosts before `processing` (Mentra App 3.4.0) read only this flag.
|
|
197
|
+
forceLocal: processing === "localOnly",
|
|
192
198
|
}, { timeoutMs: 0 });
|
|
193
199
|
return result ?? { completed: true };
|
|
194
200
|
}
|
|
@@ -215,9 +221,14 @@ export class SpeakerModule {
|
|
|
215
221
|
(!Number.isFinite(options.volume) || options.volume < 0 || options.volume > 1)) {
|
|
216
222
|
throw new RangeError("speaker stream volume must be between 0 and 1");
|
|
217
223
|
}
|
|
224
|
+
if (options.jitterMs !== undefined &&
|
|
225
|
+
(!Number.isFinite(options.jitterMs) || options.jitterMs < 80 || options.jitterMs > 500))
|
|
226
|
+
throw new RangeError("speaker stream jitterMs must be between 80 and 500");
|
|
218
227
|
const res = await this.session.sendRequest({
|
|
219
228
|
type: MiniappRequestType.SPEAKER_STREAM_OPEN,
|
|
220
229
|
sampleRate: options.sampleRate ?? 16000,
|
|
230
|
+
...(options.jitterMs === undefined ? {} : { jitterMs: options.jitterMs }),
|
|
231
|
+
...(options.prewarm === undefined ? {} : { prewarm: options.prewarm }),
|
|
221
232
|
channels: options.channels ?? 1,
|
|
222
233
|
volume: options.volume,
|
|
223
234
|
stopOtherAudio: options.stopOtherAudio ?? true,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"speaker.js","sourceRoot":"","sources":["../../src/modules/speaker.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"speaker.js","sourceRoot":"","sources":["../../src/modules/speaker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,OAAO,EAAC,gBAAgB,EAAE,kBAAkB,EAAC,MAAM,aAAa,CAAA;AAEhE,OAAO,EAAC,aAAa,EAAE,YAAY,EAAC,MAAM,UAAU,CAAA;AAEpD,OAAO,EAAC,uBAAuB,EAAwB,MAAM,oBAAoB,CAAA;AAmFjF,8EAA8E;AAC9E,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,GAAG,IAAI,CAAA;AACnD,2EAA2E;AAC3E,+EAA+E;AAC/E,MAAM,uBAAuB,GAAG,IAAI,CAAC,KAAK,CAAC,yBAAyB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;AAE7E;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,IAAI,CAAA;AAElD;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAmB;IAI9B,YACmB,OAAuB,EAC/B,QAAgB;QADR,YAAO,GAAP,OAAO,CAAgB;QAC/B,aAAQ,GAAR,QAAQ,CAAQ;QALnB,YAAO,GAAG,KAAK,CAAA;QACf,eAAU,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAA;IAKlD,CAAC;IAEJ;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,KAA+B;QACzC,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;QACjC,IAAI,KAAK,CAAC,UAAU,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QACxE,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QACjG,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,IAAI,GAA6B,EAAC,UAAU,EAAE,CAAC,EAAC,CAAA;YACpD,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,IAAI,yBAAyB,EAAE,CAAC;gBACvE,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,yBAAyB,CAAC,CAAC,CAAC,CAAA;YAC7F,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,sFAAsF;IACtF,KAAK,CAAC,WAAW,CAAC,GAAW;QAC3B,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;QACxG,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAClE,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO,CAAA;QACnD,IAAI,YAAY,GAAG,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;QAC9F,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,IAAI,GAA6B,EAAC,UAAU,EAAE,CAAC,EAAC,CAAA;YACpD,mEAAmE;YACnE,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,uBAAuB,EAAE,CAAC;gBACnE,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,uBAAuB,CAAC,CAAC,CAAA;YACvE,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,MAAM,IAAI,CAAC,UAAU,CAAA;QACrB,wEAAwE;QACxE,0CAA0C;QAC1C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CACxC,EAAC,IAAI,EAAE,kBAAkB,CAAC,oBAAoB,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAC,EACxE,EAAC,SAAS,EAAE,CAAC,EAAC,CACf,CAAA;QACD,OAAO,GAAG,IAAI,EAAE,CAAA;IAClB,CAAC;IAED,gEAAgE;IAChE,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO;YAAE,OAAM;QACxB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,oBAAoB;YAC7C,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC,CAAA;IACJ,CAAC;IAEO,UAAU;QAChB,IAAI,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;IACpF,CAAC;IAEO,KAAK,CAAC,IAAI,CAAC,MAAc;QAC/B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAkC;YAC1E,IAAI,EAAE,kBAAkB,CAAC,oBAAoB;YAC7C,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM;SACP,CAAC,CAAA;QACF,OAAO,GAAG,IAAI,EAAC,UAAU,EAAE,CAAC,EAAC,CAAA;IAC/B,CAAC;IAED,4EAA4E;IACpE,YAAY,CAAI,SAA2B;QACjD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC9C,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,IAAI,CAC3B,GAAG,EAAE,CAAC,SAAS,EACf,GAAG,EAAE,CAAC,SAAS,CAChB,CAAA;QACD,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAWD,MAAM,OAAO,aAAa;IAIxB,YAA6B,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;QAH5C,WAAM,GAAiB,MAAM,CAAA;QAC7B,eAAU,GAAsB,EAAC,KAAK,EAAE,MAAM,EAAC,CAAA;IAEA,CAAC;IAExD,sCAAsC;IACtC,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED,oCAAoC;IACpC,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,CAAA;IAClC,CAAC;IAED,iEAAiE;IACjE,KAAK,CAAC,IAAI,CAAC,OAAyB;QAClC,IACE,OAAO,CAAC,eAAe,KAAK,SAAS;YACrC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,OAAO,CAAC,eAAe,GAAG,CAAC,CAAC,EAC1E,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,uDAAuD,CAAC,CAAA;QAC/E,CAAC;QACD,0EAA0E;QAC1E,6EAA6E;QAC7E,8EAA8E;QAC9E,+EAA+E;QAC/E,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAC5B;YACE,IAAI,EAAE,kBAAkB,CAAC,UAAU;YACnC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,GAAG,CAAC,OAAO,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,EAAC,eAAe,EAAE,OAAO,CAAC,eAAe,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5F,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,KAAK;SAChD,EACD,EAAC,SAAS,EAAE,CAAC,EAAC,CACf,CAAA;IACH,CAAC;IAYD,KAAK,CAAC,KAAK,CAAC,IAAuB,EAAE,UAAwB,EAAE;QAC7D,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;QAC9G,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YAChF,MAAM,EAAC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,gDAAgD,EAAC,CAAA;QACpG,CAAC;QACD,MAAM,UAAU,GAAG,uBAAuB,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAA;QAC7E,IAAI,CAAC;YACH,4EAA4E;YAC5E,0EAA0E;YAC1E,mCAAmC;YACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAC3C;gBACE,IAAI,EAAE,kBAAkB,CAAC,KAAK;gBAC9B,IAAI,EAAE,UAAU;gBAChB,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,cAAc,EAAE,OAAO,CAAC,cAAc;gBACtC,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,KAAK;gBAC/C,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,IAAI,IAAI;gBACtD,UAAU;gBACV,oEAAoE;gBACpE,UAAU,EAAE,UAAU,KAAK,WAAW;aACvC,EACD,EAAC,SAAS,EAAE,CAAC,EAAC,CACf,CAAA;YACD,OAAO,MAAM,IAAI,EAAC,SAAS,EAAE,IAAI,EAAC,CAAA;QACpC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,iFAAiF;YACjF,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;gBACpD,MAAM,GAAG,CAAA;YACX,CAAC;YACD,MAAM,EAAC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,EAAC,CAAA;QAC/D,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,YAAY,CAAC,UAAgC,EAAE;QACnD,IACE,OAAO,CAAC,MAAM,KAAK,SAAS;YAC5B,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,EAC9E,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,+CAA+C,CAAC,CAAA;QACvE,CAAC;QACD,IACE,OAAO,CAAC,QAAQ,KAAK,SAAS;YAC9B,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,QAAQ,GAAG,EAAE,IAAI,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC;YAEvF,MAAM,IAAI,UAAU,CAAC,oDAAoD,CAAC,CAAA;QAC5E,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAqB;YAC7D,IAAI,EAAE,kBAAkB,CAAC,mBAAmB;YAC5C,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,KAAK;YACvC,GAAG,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAC,CAAC;YACvE,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAC,CAAC;YACpE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC;YAC/B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,IAAI;SAC/C,CAAC,CAAA;QACF,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;IAC5D,CAAC;IAED,wDAAwD;IACxD,IAAI;QACF,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAC,IAAI,EAAE,kBAAkB,CAAC,UAAU,EAAC,CAAC,CAAA;IACjE,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,OAA2C;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;IACjD,CAAC;IAED,+EAA+E;IAC/E,WAAW,CAAC,KAAwB;QAClC,sEAAsE;QACtE,sEAAsE;QACtE,uDAAuD;QACvD,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,KAAK,OAAO;YAAE,OAAM;QAClE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAA;QACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;IACzB,CAAC;IAED,6BAA6B;IAC7B,aAAa;QACX,OAAO,EAAC,GAAG,IAAI,CAAC,UAAU,EAAC,CAAA;IAC7B,CAAC;CACF"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Where speech is processed: on the phone or in the cloud.
|
|
3
|
+
*
|
|
4
|
+
* Transcription listeners (`session.transcription.on` / `forLanguage`) and
|
|
5
|
+
* speech requests (`session.speaker.speak`) take the same `processing` option.
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* Where speech is processed.
|
|
9
|
+
*
|
|
10
|
+
* - `"preferCloud"` (default): the cloud; the phone's on-device models only
|
|
11
|
+
* while the cloud is unreachable.
|
|
12
|
+
* - `"preferLocal"`: on-device when a model for the language is ready,
|
|
13
|
+
* otherwise the cloud.
|
|
14
|
+
* - `"localOnly"`: on-device only; never the cloud.
|
|
15
|
+
*/
|
|
16
|
+
export type SpeechProcessing = "preferCloud" | "preferLocal" | "localOnly";
|
|
17
|
+
/** The `processing` option, with the deprecated `forceLocal` it replaces. */
|
|
18
|
+
export interface SpeechProcessingOptions {
|
|
19
|
+
processing?: SpeechProcessing;
|
|
20
|
+
/** @deprecated Use `processing: "localOnly"`. Removed in 4.0. */
|
|
21
|
+
forceLocal?: boolean;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @internal The processing an options object asks for. `processing` wins;
|
|
25
|
+
* without it, the deprecated `forceLocal: true` means `"localOnly"`.
|
|
26
|
+
* Throws `MiniappValidationError` for an unknown `processing` value.
|
|
27
|
+
*/
|
|
28
|
+
export declare function resolveSpeechProcessing(options: SpeechProcessingOptions, where: string): SpeechProcessing;
|
|
29
|
+
//# sourceMappingURL=speechProcessing.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"speechProcessing.d.ts","sourceRoot":"","sources":["../../src/modules/speechProcessing.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG,aAAa,GAAG,WAAW,CAAA;AAI1E,6EAA6E;AAC7E,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAC7B,iEAAiE;IACjE,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,uBAAuB,EAAE,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAOzG"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Where speech is processed: on the phone or in the cloud.
|
|
3
|
+
*
|
|
4
|
+
* Transcription listeners (`session.transcription.on` / `forLanguage`) and
|
|
5
|
+
* speech requests (`session.speaker.speak`) take the same `processing` option.
|
|
6
|
+
*/
|
|
7
|
+
import { MiniappValidationError } from "./languages";
|
|
8
|
+
const SPEECH_PROCESSING = ["preferCloud", "preferLocal", "localOnly"];
|
|
9
|
+
/**
|
|
10
|
+
* @internal The processing an options object asks for. `processing` wins;
|
|
11
|
+
* without it, the deprecated `forceLocal: true` means `"localOnly"`.
|
|
12
|
+
* Throws `MiniappValidationError` for an unknown `processing` value.
|
|
13
|
+
*/
|
|
14
|
+
export function resolveSpeechProcessing(options, where) {
|
|
15
|
+
const { processing } = options;
|
|
16
|
+
if (processing === undefined)
|
|
17
|
+
return options.forceLocal === true ? "localOnly" : "preferCloud";
|
|
18
|
+
if (SPEECH_PROCESSING.includes(processing))
|
|
19
|
+
return processing;
|
|
20
|
+
throw new MiniappValidationError(`${where}: unknown processing ${JSON.stringify(processing)}. Use ${SPEECH_PROCESSING.map((value) => `"${value}"`).join(", ")}.`);
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=speechProcessing.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"speechProcessing.js","sourceRoot":"","sources":["../../src/modules/speechProcessing.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,sBAAsB,EAAC,MAAM,aAAa,CAAA;AAalD,MAAM,iBAAiB,GAAgC,CAAC,aAAa,EAAE,aAAa,EAAE,WAAW,CAAC,CAAA;AASlG;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAAgC,EAAE,KAAa;IACrF,MAAM,EAAC,UAAU,EAAC,GAAG,OAAO,CAAA;IAC5B,IAAI,UAAU,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAA;IAC9F,IAAI,iBAAiB,CAAC,QAAQ,CAAC,UAAU,CAAC;QAAE,OAAO,UAAU,CAAA;IAC7D,MAAM,IAAI,sBAAsB,CAC9B,GAAG,KAAK,wBAAwB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,iBAAiB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAChI,CAAA;AACH,CAAC"}
|
package/dist/modules/stream.d.ts
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
* to your own ingest URL with no relay.
|
|
9
9
|
*/
|
|
10
10
|
import { type PreviewErrorCode, type PreviewSource } from "../protocol";
|
|
11
|
+
import type { UnsubscribeFn } from "./events";
|
|
11
12
|
import { MiniappSession } from "../session";
|
|
12
13
|
export interface StreamVideoConfig {
|
|
13
14
|
width?: number;
|
|
@@ -115,13 +116,41 @@ export interface StreamLiveStats {
|
|
|
115
116
|
/** Device temperature in °C, if the hardware reports it. */
|
|
116
117
|
temperatureC?: number;
|
|
117
118
|
}
|
|
119
|
+
/** Who reported a {@link StreamStatus}. */
|
|
120
|
+
export type StreamStatusSource = "glasses" | "cloudflare" | "coordinator";
|
|
121
|
+
/**
|
|
122
|
+
* One stream status update. Statuses you can act on:
|
|
123
|
+
* - `source: "glasses"` — the glasses publisher: `streaming`, `reconnecting`,
|
|
124
|
+
* `reconnected`, `error`, `stopped`, ... with `kind`, `attempt`/`maxAttempts`
|
|
125
|
+
* on reconnects and `terminal: true` when the publisher gave up.
|
|
126
|
+
* - `source: "cloudflare"` — what the managed ingest sees, polled every 5s:
|
|
127
|
+
* `connected` / `disconnected`. Managed streams only.
|
|
128
|
+
* - `source: "coordinator"` — the phone: `connected`, `reconnecting` and
|
|
129
|
+
* `reconnected` for the WHIP phone relay (`transport: "softap_relay"`),
|
|
130
|
+
* `suspended` / `resumed` while Bluetooth to the glasses is down,
|
|
131
|
+
* `hls_ready` / `webrtc_ready` for playback, and `error` when the stream
|
|
132
|
+
* has ended and must be started again.
|
|
133
|
+
*/
|
|
118
134
|
export interface StreamStatus {
|
|
119
135
|
streamId: string;
|
|
120
136
|
status: string;
|
|
137
|
+
source?: StreamStatusSource;
|
|
138
|
+
/** Glasses status kind (`lifecycle`, `reconnect`, `error`, `snapshot`, ...). */
|
|
139
|
+
kind?: string;
|
|
140
|
+
/** Human-readable cause, when the reporter gave one. */
|
|
141
|
+
reason?: string;
|
|
121
142
|
errorDetails?: string;
|
|
143
|
+
/** The glasses publisher gave up; the stream will not recover by itself. */
|
|
144
|
+
terminal?: boolean;
|
|
145
|
+
willRetry?: boolean;
|
|
146
|
+
attempt?: number;
|
|
147
|
+
maxAttempts?: number;
|
|
148
|
+
/** `"softap_relay"` on WHIP relay statuses. */
|
|
149
|
+
transport?: string;
|
|
122
150
|
/** Negotiated encode config — forwarded once, on the first status ack. */
|
|
123
151
|
resolvedConfig?: StreamResolvedConfig;
|
|
124
152
|
stats?: StreamLiveStats;
|
|
153
|
+
[key: string]: unknown;
|
|
125
154
|
}
|
|
126
155
|
export interface StreamPreviewOptions {
|
|
127
156
|
/** Defaults to `"call"`. `"glasses"` is reserved and rejects with `unsupported`. */
|
|
@@ -182,6 +211,16 @@ export declare class StreamModule {
|
|
|
182
211
|
* and no playback URLs are returned.
|
|
183
212
|
*/
|
|
184
213
|
startStream(options?: StartStreamOptions): Promise<StreamResult>;
|
|
214
|
+
/**
|
|
215
|
+
* Listen for status updates on the stream this miniapp started or joined.
|
|
216
|
+
* Returns an unsubscribe function.
|
|
217
|
+
*
|
|
218
|
+
* A stream that is recovering on its own reports `reconnecting`, then
|
|
219
|
+
* `reconnected`, and keeps its `streamId` and playback URLs. A
|
|
220
|
+
* `source: "coordinator"` status of `error` means the stream has ended: call
|
|
221
|
+
* `startStream()` again, which returns new playback URLs.
|
|
222
|
+
*/
|
|
223
|
+
onStatus(handler: (status: StreamStatus) => void): UnsubscribeFn;
|
|
185
224
|
/** Stop the active stream, or a specific one by `streamId`. */
|
|
186
225
|
stop(streamId?: string): Promise<void>;
|
|
187
226
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../src/modules/stream.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,
|
|
1
|
+
{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../src/modules/stream.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAwC,KAAK,gBAAgB,EAAE,KAAK,aAAa,EAAC,MAAM,aAAa,CAAA;AAC5G,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,UAAU,CAAA;AAC3C,OAAO,EAAC,cAAc,EAAC,MAAM,YAAY,CAAA;AAEzC,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,mFAAmF;IACnF,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,oEAAoE;IACpE,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;IACnC,KAAK,CAAC,EAAE;QACN,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,OAAO,EAAE,MAAM,CAAA;QACf,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IACD,KAAK,CAAC,EAAE;QACN,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,gBAAgB,CAAC,EAAE,OAAO,CAAA;QAC1B,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAC3B,CAAA;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,mBAAmB,CAAC,CAAA;IAClD,KAAK,CAAC,EAAE,iBAAiB,CAAA;IACzB,KAAK,CAAC,EAAE,iBAAiB,CAAA;IACzB,oEAAoE;IACpE,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAA;IAChC,4FAA4F;IAC5F,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,CAAC,EAAE,oBAAoB,CAAA;IACrC,gFAAgF;IAChF,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;yCACqC;IACrC,IAAI,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAA;IACvB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,+CAA+C;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,4FAA4F;AAC5F,MAAM,WAAW,eAAe;IAC9B,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iCAAiC;IACjC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,2CAA2C;AAC3C,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,YAAY,GAAG,aAAa,CAAA;AAEzE;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,kBAAkB,CAAA;IAC3B,gFAAgF;IAChF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,0EAA0E;IAC1E,cAAc,CAAC,EAAE,oBAAoB,CAAA;IACrC,KAAK,CAAC,EAAE,eAAe,CAAA;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC,oFAAoF;IACpF,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB;AAED,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,OAAO,CAAA;AAEjD,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,kBAAkB,CAAA;IACzB,uFAAuF;IACvF,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,2GAA2G;AAC3G,qBAAa,YAAa,SAAQ,KAAK;IACrC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,GAAG,MAAM,CAAA;gBAE5B,IAAI,EAAE,gBAAgB,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;CAK9D;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAA;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,+EAA+E;IAC/E,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAA;IAClC,qCAAqC;IACrC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACrB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,GAAG,MAAM,IAAI,CAAA;CAChE;AAwDD,qBAAa,YAAY;IAGX,OAAO,CAAC,QAAQ,CAAC,OAAO;IAFpC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAuC;gBAEzC,OAAO,EAAE,cAAc;IAEpD;;;;;;OAMG;IACG,OAAO,CAAC,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;YAwB3D,cAAc;IAY5B,8EAA8E;IAC9E,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAS3D;;;;;;;;;OASG;IACG,WAAW,CAAC,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,YAAY,CAAC;IAuB1E;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,GAAG,aAAa;IAIhE,+DAA+D;IACzD,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAM7C"}
|
package/dist/modules/stream.js
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* stream and returns playback URLs (managed). Pass `direct` to publish straight
|
|
8
8
|
* to your own ingest URL with no relay.
|
|
9
9
|
*/
|
|
10
|
-
import { MiniappRequestType } from "../protocol";
|
|
10
|
+
import { MiniappRequestType, MiniappStreamType } from "../protocol";
|
|
11
11
|
/** A preview request or lease failed. `code` is one of {@link PreviewErrorCode} when the host sent one. */
|
|
12
12
|
export class PreviewError extends Error {
|
|
13
13
|
constructor(code, message) {
|
|
@@ -151,6 +151,18 @@ export class StreamModule {
|
|
|
151
151
|
...(typeof options.captureAudio === "boolean" ? { captureAudio: options.captureAudio } : {}),
|
|
152
152
|
});
|
|
153
153
|
}
|
|
154
|
+
/**
|
|
155
|
+
* Listen for status updates on the stream this miniapp started or joined.
|
|
156
|
+
* Returns an unsubscribe function.
|
|
157
|
+
*
|
|
158
|
+
* A stream that is recovering on its own reports `reconnecting`, then
|
|
159
|
+
* `reconnected`, and keeps its `streamId` and playback URLs. A
|
|
160
|
+
* `source: "coordinator"` status of `error` means the stream has ended: call
|
|
161
|
+
* `startStream()` again, which returns new playback URLs.
|
|
162
|
+
*/
|
|
163
|
+
onStatus(handler) {
|
|
164
|
+
return this.session._subscribe(MiniappStreamType.STREAM_STATUS, handler);
|
|
165
|
+
}
|
|
154
166
|
/** Stop the active stream, or a specific one by `streamId`. */
|
|
155
167
|
async stop(streamId) {
|
|
156
168
|
await this.session.sendRequest({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../src/modules/stream.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAC,kBAAkB,EAA4C,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../src/modules/stream.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAC,kBAAkB,EAAE,iBAAiB,EAA4C,MAAM,aAAa,CAAA;AAwK5G,2GAA2G;AAC3G,MAAM,OAAO,YAAa,SAAQ,KAAK;IAGrC,YAAY,IAA+B,EAAE,OAAgB;QAC3D,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,CAAA;QACtB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AA2BD,SAAS,cAAc,CAAC,KAAc;IACpC,IAAI,KAAK,YAAY,YAAY;QAAE,OAAO,KAAK,CAAA;IAC/C,MAAM,KAAK,GAAG,CAAC,KAAK,IAAI,EAAE,CAAwC,CAAA;IAClE,MAAM,IAAI,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAA;IACxE,MAAM,OAAO,GAAG,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAA;IAC7E,OAAO,IAAI,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;AACxC,CAAC;AAED,MAAM,iBAAiB;IAIrB,YACW,MAAqB,EACrB,QAAgB,EAChB,cAAsB,EACd,OAAqD;QAH7D,WAAM,GAAN,MAAM,CAAe;QACrB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,mBAAc,GAAd,cAAc,CAAQ;QACd,YAAO,GAAP,OAAO,CAA8C;QAPxE,UAAK,GAAuB,MAAM,CAAA;QACjB,cAAS,GAAG,IAAI,GAAG,EAAyC,CAAA;IAO1E,CAAC;IAEJ,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,KAAK,KAAK,OAAO;YAAE,OAAM;QAClC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QACnB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;IAED,QAAQ,CAAC,EAAyC;QAChD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QACtB,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IACxC,CAAC;IAED,gBAAgB;IAChB,GAAG,CAAC,MAAc;QAChB,IAAI,IAAI,CAAC,KAAK,KAAK,OAAO;YAAE,OAAM;QAClC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAA;QACpB,IAAI,CAAC,IAAI,CAAC,EAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAC,CAAC,CAAA;IACrC,CAAC;IAEO,IAAI,CAAC,MAA2B;QACtC,KAAK,MAAM,QAAQ,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC3C,IAAI,CAAC;gBACH,QAAQ,CAAC,MAAM,CAAC,CAAA;YAClB,CAAC;YAAC,MAAM,CAAC;gBACP,kFAAkF;YACpF,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAED,MAAM,OAAO,YAAY;IAGvB,YAA6B,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;QAFnC,mBAAc,GAAG,IAAI,GAAG,EAA6B,CAAA;IAEf,CAAC;IAExD;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAC,UAAgC,EAAE;QAC9C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAA;QACvC,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;YACtB,MAAM,IAAI,YAAY,CAAC,aAAa,EAAE,mBAAmB,MAAM,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAA;QAClG,CAAC;QACD,IAAI,MAA0B,CAAA;QAC9B,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAqB;gBAC1D,IAAI,EAAE,kBAAkB,CAAC,oBAAoB;gBAC7C,MAAM;aACP,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,cAAc,CAAC,KAAK,CAAC,CAAA;QAC7B,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAC1G,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CACvB,CAAA;QACD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QAChD,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,MAAM,CAAC,KAAK,KAAK,OAAO;gBAAE,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC3E,CAAC,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,MAAyB;QACpD,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC3C,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;gBACnC,IAAI,EAAE,kBAAkB,CAAC,mBAAmB;gBAC5C,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC1B,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,cAAc,CAAC,KAAK,CAAC,CAAA;QAC7B,CAAC;IACH,CAAC;IAED,8EAA8E;IAC9E,mBAAmB,CAAC,OAAgC;QAClD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ;YAAE,OAAM;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QACxD,IAAI,CAAC,MAAM;YAAE,OAAM;QACnB,IAAI,OAAO,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;YAC9B,MAAM,CAAC,GAAG,CAAC,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;QAC3E,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,WAAW,CAAC,UAA8B,EAAE;QAChD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAe;gBAC5C,IAAI,EAAE,kBAAkB,CAAC,YAAY;gBACrC,SAAS,EAAE,OAAO,CAAC,MAAM;gBACzB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI;gBAC5B,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAC,SAAS,EAAE,OAAO,CAAC,SAAS,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5D,GAAG,CAAC,OAAO,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAC,YAAY,EAAE,OAAO,CAAC,YAAY,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;aAC3F,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAe;YAC5C,IAAI,EAAE,kBAAkB,CAAC,oBAAoB;YAC7C,oBAAoB,EAAE,OAAO,CAAC,YAAY;YAC1C,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI;YAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,CAAC,OAAO,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAC,YAAY,EAAE,OAAO,CAAC,YAAY,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAC3F,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAuC;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,aAAa,EAAE,OAAkC,CAAC,CAAA;IACrG,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,IAAI,CAAC,QAAiB;QAC1B,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,WAAW;YACpC,QAAQ;SACT,CAAC,CAAA;IACJ,CAAC;CACF"}
|
package/dist/modules/system.d.ts
CHANGED
|
@@ -6,13 +6,17 @@
|
|
|
6
6
|
import { MiniappSession } from "../session";
|
|
7
7
|
export interface ShareOptions {
|
|
8
8
|
text?: string;
|
|
9
|
+
/**
|
|
10
|
+
* An http(s) link, or the `file://` uri of one of this miniapp's blobs
|
|
11
|
+
* (`session.blob`). The host refuses any other file or scheme.
|
|
12
|
+
*/
|
|
9
13
|
url?: string;
|
|
10
14
|
title?: string;
|
|
11
15
|
/** Base64-encoded file data for file sharing. */
|
|
12
16
|
base64?: string;
|
|
13
17
|
/** MIME type when sharing base64 data. */
|
|
14
18
|
mimeType?: string;
|
|
15
|
-
/**
|
|
19
|
+
/** File name when sharing base64 data: one name; path separators become `_`. */
|
|
16
20
|
filename?: string;
|
|
17
21
|
}
|
|
18
22
|
export interface ShareResult {
|
|
@@ -20,9 +24,10 @@ export interface ShareResult {
|
|
|
20
24
|
cancelled?: boolean;
|
|
21
25
|
}
|
|
22
26
|
export interface DownloadOptions {
|
|
23
|
-
/** URL to download from, OR base64 data. */
|
|
27
|
+
/** An http: or https: URL to download from, OR base64 data. */
|
|
24
28
|
url?: string;
|
|
25
29
|
base64?: string;
|
|
30
|
+
/** One file name; path separators become `_`. */
|
|
26
31
|
filename?: string;
|
|
27
32
|
mimeType?: string;
|
|
28
33
|
}
|
|
@@ -48,7 +53,7 @@ export declare class SystemModule {
|
|
|
48
53
|
constructor(session: MiniappSession);
|
|
49
54
|
/** Open the OS share sheet with the given content. */
|
|
50
55
|
share(options: ShareOptions): Promise<ShareResult>;
|
|
51
|
-
/** Open a URL in the system browser.
|
|
56
|
+
/** Open a URL in the system browser. Never opens local files or scripts (file:, content:, javascript:, data:). */
|
|
52
57
|
openUrl(url: string): void;
|
|
53
58
|
/** Copy text to the system clipboard. */
|
|
54
59
|
copyToClipboard(text: string): Promise<void>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"system.d.ts","sourceRoot":"","sources":["../../src/modules/system.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,
|
|
1
|
+
{"version":3,"file":"system.d.ts","sourceRoot":"","sources":["../../src/modules/system.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,gFAAgF;IAChF,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,+DAA+D;IAC/D,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,iDAAiD;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAA;IAChB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,iDAAiD;IACjD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,MAAM,YAAY,GAAG;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,KAAK,CAAA;CAAC,GAAG;IAAC,SAAS,EAAE,IAAI,CAAC;IAAC,IAAI,CAAC,EAAE,SAAS,CAAA;CAAC,CAAA;AAElG,qBAAa,YAAY;IACX,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,cAAc;IAEpD,sDAAsD;IAChD,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAQxD,kHAAkH;IAClH,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAO1B,yCAAyC;IACnC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlD,kFAAkF;IAC5E,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAQjE;;;;OAIG;IACG,MAAM,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;CAUjE"}
|
package/dist/modules/system.js
CHANGED
|
@@ -16,7 +16,7 @@ export class SystemModule {
|
|
|
16
16
|
});
|
|
17
17
|
return result ?? { success: false };
|
|
18
18
|
}
|
|
19
|
-
/** Open a URL in the system browser.
|
|
19
|
+
/** Open a URL in the system browser. Never opens local files or scripts (file:, content:, javascript:, data:). */
|
|
20
20
|
openUrl(url) {
|
|
21
21
|
this.session.sendOneShot({
|
|
22
22
|
type: MiniappRequestType.OPEN_URL,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"system.js","sourceRoot":"","sources":["../../src/modules/system.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"system.js","sourceRoot":"","sources":["../../src/modules/system.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AA+ChD,MAAM,OAAO,YAAY;IACvB,YAA6B,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;IAAG,CAAC;IAExD,sDAAsD;IACtD,KAAK,CAAC,KAAK,CAAC,OAAqB;QAC/B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAc;YACzD,IAAI,EAAE,kBAAkB,CAAC,KAAK;YAC9B,GAAG,OAAO;SACX,CAAC,CAAA;QACF,OAAO,MAAM,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;IACrC,CAAC;IAED,kHAAkH;IAClH,OAAO,CAAC,GAAW;QACjB,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;YACvB,IAAI,EAAE,kBAAkB,CAAC,QAAQ;YACjC,GAAG;SACJ,CAAC,CAAA;IACJ,CAAC;IAED,yCAAyC;IACzC,KAAK,CAAC,eAAe,CAAC,IAAY;QAChC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,cAAc;YACvC,IAAI;SACL,CAAC,CAAA;IACJ,CAAC;IAED,kFAAkF;IAClF,KAAK,CAAC,QAAQ,CAAC,OAAwB;QACrC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAiB;YAC5D,IAAI,EAAE,kBAAkB,CAAC,QAAQ;YACjC,GAAG,OAAO;SACX,CAAC,CAAA;QACF,OAAO,MAAM,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;IACrC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,UAAyB,EAAE;QACtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAC3C;YACE,IAAI,EAAE,kBAAkB,CAAC,OAAO;YAChC,GAAG,OAAO;SACX,EACD,EAAC,SAAS,EAAE,CAAC,EAAC,CACf,CAAA;QACD,OAAO,MAAM,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAA;IACtC,CAAC;CACF"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview TelemetryModule (`session.telemetry`): a miniapp's own analytics, shown in its organization's Fleet
|
|
3
|
+
* Management.
|
|
4
|
+
*
|
|
5
|
+
* `capture(event, properties?)` sends one fire-and-forget message to the Mentra App and returns nothing. It never throws
|
|
6
|
+
* and never waits. The SDK checks nothing: the Mentra App attributes the event to this miniapp and applies the limits
|
|
7
|
+
* (names, values, 25 properties, the rate), and on a Mentra App without the `telemetry` host feature it does nothing.
|
|
8
|
+
* Before the handshake says which, it holds the latest 100 captures and sends them once it knows.
|
|
9
|
+
*/
|
|
10
|
+
import type { MiniappSession } from "../session";
|
|
11
|
+
export type TelemetryValue = string | number | boolean;
|
|
12
|
+
export type TelemetryProperties = Record<string, TelemetryValue>;
|
|
13
|
+
export declare class TelemetryModule {
|
|
14
|
+
private readonly session;
|
|
15
|
+
private held;
|
|
16
|
+
private waiting;
|
|
17
|
+
constructor(session: MiniappSession);
|
|
18
|
+
/**
|
|
19
|
+
* Captures one event, in the style of PostHog: `session.telemetry.capture("call_ended", {platform: "teams",
|
|
20
|
+
* duration_s: 312})`. Names are lowercase letters, digits and underscores; values are flat. Never personal data: no
|
|
21
|
+
* names, emails, phone numbers, typed text or content.
|
|
22
|
+
*/
|
|
23
|
+
capture(event: string, properties?: TelemetryProperties): void;
|
|
24
|
+
}
|
|
25
|
+
//# sourceMappingURL=telemetry.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"telemetry.d.ts","sourceRoot":"","sources":["../../src/modules/telemetry.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,YAAY,CAAA;AAE9C,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;AACtD,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;AAKhE,qBAAa,eAAe;IAId,OAAO,CAAC,QAAQ,CAAC,OAAO;IAHpC,OAAO,CAAC,IAAI,CAAe;IAC3B,OAAO,CAAC,OAAO,CAAQ;gBAEM,OAAO,EAAE,cAAc;IAEpD;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,mBAAmB,GAAG,IAAI;CA+B/D"}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview TelemetryModule (`session.telemetry`): a miniapp's own analytics, shown in its organization's Fleet
|
|
3
|
+
* Management.
|
|
4
|
+
*
|
|
5
|
+
* `capture(event, properties?)` sends one fire-and-forget message to the Mentra App and returns nothing. It never throws
|
|
6
|
+
* and never waits. The SDK checks nothing: the Mentra App attributes the event to this miniapp and applies the limits
|
|
7
|
+
* (names, values, 25 properties, the rate), and on a Mentra App without the `telemetry` host feature it does nothing.
|
|
8
|
+
* Before the handshake says which, it holds the latest 100 captures and sends them once it knows.
|
|
9
|
+
*/
|
|
10
|
+
import { MiniappRequestType } from "../protocol";
|
|
11
|
+
/** Captures held until the handshake says whether the Mentra App takes them. */
|
|
12
|
+
const MAX_HELD = 100;
|
|
13
|
+
export class TelemetryModule {
|
|
14
|
+
constructor(session) {
|
|
15
|
+
this.session = session;
|
|
16
|
+
this.held = [];
|
|
17
|
+
this.waiting = false;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Captures one event, in the style of PostHog: `session.telemetry.capture("call_ended", {platform: "teams",
|
|
21
|
+
* duration_s: 312})`. Names are lowercase letters, digits and underscores; values are flat. Never personal data: no
|
|
22
|
+
* names, emails, phone numbers, typed text or content.
|
|
23
|
+
*/
|
|
24
|
+
capture(event, properties) {
|
|
25
|
+
try {
|
|
26
|
+
const message = { type: MiniappRequestType.TELEMETRY_CAPTURE, event, properties: properties ?? {} };
|
|
27
|
+
if (this.session.handshakeDone) {
|
|
28
|
+
if (this.session.hostFeatures?.telemetry === true)
|
|
29
|
+
this.session.sendOneShot(message);
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
if (this.held.length >= MAX_HELD)
|
|
33
|
+
this.held.shift();
|
|
34
|
+
this.held.push(message);
|
|
35
|
+
if (!this.waiting) {
|
|
36
|
+
this.waiting = true;
|
|
37
|
+
const off = this.session.on("ready", () => {
|
|
38
|
+
off();
|
|
39
|
+
this.waiting = false;
|
|
40
|
+
const held = this.held.splice(0);
|
|
41
|
+
if (this.session.hostFeatures?.telemetry !== true)
|
|
42
|
+
return;
|
|
43
|
+
for (const one of held) {
|
|
44
|
+
// Each on its own: one capture that cannot be sent never takes the others, or the session's other
|
|
45
|
+
// listeners, down with it.
|
|
46
|
+
try {
|
|
47
|
+
this.session.sendOneShot(one);
|
|
48
|
+
}
|
|
49
|
+
catch {
|
|
50
|
+
// Lost.
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
catch {
|
|
57
|
+
// Analytics never break the miniapp: a value that cannot be sent is lost.
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
//# sourceMappingURL=telemetry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"telemetry.js","sourceRoot":"","sources":["../../src/modules/telemetry.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAC,kBAAkB,EAAC,MAAM,aAAa,CAAA;AAM9C,gFAAgF;AAChF,MAAM,QAAQ,GAAG,GAAG,CAAA;AAEpB,MAAM,OAAO,eAAe;IAI1B,YAA6B,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;QAH5C,SAAI,GAAa,EAAE,CAAA;QACnB,YAAO,GAAG,KAAK,CAAA;IAEgC,CAAC;IAExD;;;;OAIG;IACH,OAAO,CAAC,KAAa,EAAE,UAAgC;QACrD,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,EAAC,IAAI,EAAE,kBAAkB,CAAC,iBAAiB,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,IAAI,EAAE,EAAC,CAAA;YACjG,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;gBAC/B,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,SAAS,KAAK,IAAI;oBAAE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;gBACpF,OAAM;YACR,CAAC;YACD,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,QAAQ;gBAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;YACnD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACvB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;gBACnB,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;oBACxC,GAAG,EAAE,CAAA;oBACL,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;oBACpB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;oBAChC,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,SAAS,KAAK,IAAI;wBAAE,OAAM;oBACzD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;wBACvB,kGAAkG;wBAClG,2BAA2B;wBAC3B,IAAI,CAAC;4BACH,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;wBAC/B,CAAC;wBAAC,MAAM,CAAC;4BACP,QAAQ;wBACV,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,0EAA0E;QAC5E,CAAC;IACH,CAAC;CACF"}
|