@avaturn-live/web-sdk 0.4.7 → 0.4.8
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/dist/main.cjs +16 -16
- package/dist/main.d.ts +4 -6
- package/dist/main.js +206 -189
- package/dist/type.d.ts +13 -3
- package/package.json +1 -1
package/dist/type.d.ts
CHANGED
|
@@ -47,6 +47,12 @@ export interface AvaturnHeadConfig {
|
|
|
47
47
|
* @type {boolean}
|
|
48
48
|
*/
|
|
49
49
|
audioSource?: boolean;
|
|
50
|
+
/**
|
|
51
|
+
* Optional flag to start with microphone muted when joining.
|
|
52
|
+
* Defaults to `!audioSource` — if audioSource is enabled, mic starts on; otherwise mic starts off.
|
|
53
|
+
* @type {boolean}
|
|
54
|
+
*/
|
|
55
|
+
startAudioOff?: boolean;
|
|
50
56
|
/**
|
|
51
57
|
* Optional flag to immediately connect to the session
|
|
52
58
|
* @type {boolean}
|
|
@@ -70,10 +76,14 @@ export interface IAvaturnHead {
|
|
|
70
76
|
*/
|
|
71
77
|
session_id: string;
|
|
72
78
|
/**
|
|
73
|
-
* Initializes the object.
|
|
74
|
-
*
|
|
79
|
+
* Initializes the object: creates call object, registers event handlers, fetches session data.
|
|
80
|
+
* If `immediatelyJoin` is true (default), automatically calls `join()`.
|
|
81
|
+
*
|
|
82
|
+
* The promise resolves once the avatar video track is ready.
|
|
83
|
+
*
|
|
84
|
+
* @returns {Promise<void>} A promise that resolves after initialization is complete and avatar is ready to use.
|
|
75
85
|
*/
|
|
76
|
-
init(): Promise<
|
|
86
|
+
init(): Promise<void>;
|
|
77
87
|
join(opts?: {
|
|
78
88
|
startAudioOff?: boolean;
|
|
79
89
|
}): Promise<void>;
|