@touchcastllc/napster-companion-api-dev 1.0.0-alpha.55 → 1.0.0-alpha.57
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 +84 -0
- package/lib/index.esm.js +1 -1
- package/lib/index.js +1 -1
- package/lib/index.standalone.js +1 -1
- package/lib/types/index.d.ts +19 -0
- package/package.json +1 -1
package/lib/types/index.d.ts
CHANGED
|
@@ -146,6 +146,13 @@ export interface FeatureConfig {
|
|
|
146
146
|
screenShare?: {
|
|
147
147
|
enabled: boolean;
|
|
148
148
|
};
|
|
149
|
+
/** Built-in controls block (mute/volume/screen-share/end buttons) rendered over
|
|
150
|
+
* the avatar. Disable when the embedding app provides its own UI for these
|
|
151
|
+
* actions (e.g. via `muteMic`/`unmuteMic`, `stopAvatarTalking`, etc.).
|
|
152
|
+
* Defaults to `enabled: true`. */
|
|
153
|
+
controls?: {
|
|
154
|
+
enabled: boolean;
|
|
155
|
+
};
|
|
149
156
|
/** Face tracking feature. When enabled, opens the user's camera and runs
|
|
150
157
|
* real-time face mesh detection via TensorFlow.js + MediaPipe. */
|
|
151
158
|
faceTracking?: {
|
|
@@ -365,6 +372,18 @@ export interface NapsterCompanionApiInstance {
|
|
|
365
372
|
setAudioVolume: (volume: number) => void;
|
|
366
373
|
/** Get the current avatar audio output volume in the range 0..1. */
|
|
367
374
|
getAudioVolume: () => number;
|
|
375
|
+
/** Mute the user's microphone input. */
|
|
376
|
+
muteMic: () => void;
|
|
377
|
+
/** Unmute the user's microphone input. */
|
|
378
|
+
unmuteMic: () => void;
|
|
379
|
+
/** Whether the user's microphone is currently muted. */
|
|
380
|
+
readonly isMicMuted: boolean;
|
|
381
|
+
/** Interrupt the avatar's current response so it stops talking. */
|
|
382
|
+
stopAvatarTalking: () => void;
|
|
383
|
+
/** Whether the avatar is currently speaking. */
|
|
384
|
+
readonly isAvatarSpeaking: boolean;
|
|
385
|
+
/** Whether the user is currently talking (detected from microphone input). */
|
|
386
|
+
readonly isUserTalking: boolean;
|
|
368
387
|
}
|
|
369
388
|
/**
|
|
370
389
|
* Top-level SDK object exposed by the package. Call `init(token, config)` to
|