@vapi-ai/web 3.0.1 → 3.1.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 +11 -1
- package/api.ts +6195 -5230
- package/dist/api.d.ts +3430 -2788
- package/dist/api.js +94 -5
- package/dist/vapi.d.ts +41 -3
- package/dist/vapi.js +100 -81
- package/package.json +1 -1
- package/vapi.ts +164 -111
package/README.md
CHANGED
|
@@ -148,7 +148,17 @@ vapi.on('error', (e) => {
|
|
|
148
148
|
|
|
149
149
|
## Recording
|
|
150
150
|
|
|
151
|
-
When video recording is enabled on the call's artifact plan, Vapi starts
|
|
151
|
+
When video recording is enabled on the call's artifact plan, Vapi starts the recording automatically when the user joins the call.
|
|
152
|
+
|
|
153
|
+
By default, the recording is started by the client. To have Vapi start the recording from the server, pass `videoRecordingStartMode: 'server'`. This may be more reliable on weak connections.
|
|
154
|
+
|
|
155
|
+
```javascript
|
|
156
|
+
vapi.start(assistantId, undefined, undefined, undefined, undefined, {
|
|
157
|
+
videoRecordingStartMode: 'server',
|
|
158
|
+
});
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
Recording start is asynchronous: success is signaled by the `recording-started` event and failure by the `recording-error` event.
|
|
152
162
|
|
|
153
163
|
A failed recording start is not retried automatically. Use `startRecording()` and `stopRecording()` to control the recording yourself. For example, to retry after a failure:
|
|
154
164
|
|