@pipecat-ai/daily-transport 0.3.4-rc.4 → 0.3.4
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 +77 -12
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,31 +1,96 @@
|
|
|
1
1
|
# Pipecat's Real-Time Voice Inference - Daily Transport
|
|
2
2
|
|
|
3
|
-
[](https://docs.pipecat.ai/client/
|
|
3
|
+
[](https://docs.pipecat.ai/client/js/transports/daily)
|
|
4
4
|
|
|
5
|
+
[](https://github.com/pipecat-ai/pipecat/tree/main/examples/simple-chatbot)
|
|
5
6
|
|
|
6
7
|
Daily transport package for use with `@pipecat-ai/client-js`.
|
|
7
8
|
|
|
8
|
-
##
|
|
9
|
+
## Installation
|
|
9
10
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
```bash copy
|
|
12
|
+
npm install \
|
|
13
|
+
@pipecat-ai/client-js \
|
|
14
|
+
@pipecat-ai/daily-transport
|
|
14
15
|
```
|
|
15
16
|
|
|
16
|
-
|
|
17
|
-
|
|
17
|
+
## Overview
|
|
18
|
+
|
|
19
|
+
The DailyTransport class provides a WebRTC transport layer using [Daily.co's](https://daily.co) infrastructure. It handles audio/video device management, WebRTC connections, and real-time communication between clients and bots.
|
|
20
|
+
|
|
21
|
+
## Features
|
|
22
|
+
|
|
23
|
+
- 🎥 Complete camera device management
|
|
24
|
+
- 🎤 Microphone input handling
|
|
25
|
+
- 🔊 Speaker output control
|
|
26
|
+
- 📡 WebRTC connection management
|
|
27
|
+
- 🤖 Bot participant tracking
|
|
28
|
+
- 📊 Audio level monitoring
|
|
29
|
+
- 💬 Real-time messaging
|
|
30
|
+
|
|
31
|
+
## Usage
|
|
32
|
+
|
|
33
|
+
### Basic Setup
|
|
34
|
+
|
|
35
|
+
```javascript
|
|
18
36
|
import { RTVIClient } from "@pipecat-ai/client-js";
|
|
19
37
|
import { DailyTransport } from "@pipecat-ai/daily-transport";
|
|
20
38
|
|
|
39
|
+
const transport = new DailyTransport({
|
|
40
|
+
dailyFactoryOptions: {
|
|
41
|
+
// Daily.co specific configuration
|
|
42
|
+
}
|
|
43
|
+
});
|
|
44
|
+
|
|
21
45
|
const rtviClient = new RTVIClient({
|
|
22
|
-
transport
|
|
23
|
-
//
|
|
46
|
+
transport,
|
|
47
|
+
enableCam: false, // Default camera off
|
|
48
|
+
enableMic: true, // Default microphone on
|
|
49
|
+
callbacks: {
|
|
50
|
+
// Event handlers
|
|
51
|
+
},
|
|
52
|
+
params: {
|
|
53
|
+
baseUrl,
|
|
54
|
+
endpoints
|
|
55
|
+
}
|
|
56
|
+
// ...
|
|
24
57
|
});
|
|
25
58
|
|
|
26
59
|
await rtviClient.connect();
|
|
27
60
|
```
|
|
28
61
|
|
|
29
|
-
|
|
62
|
+
## API Reference
|
|
63
|
+
|
|
64
|
+
### Constructor Options
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
interface DailyTransportConstructorOptions {
|
|
68
|
+
dailyFactoryOptions?: DailyFactoryOptions; // Daily.co specific configuration
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### States
|
|
73
|
+
|
|
74
|
+
The transport can be in one of these states:
|
|
75
|
+
- "initializing"
|
|
76
|
+
- "initialized"
|
|
77
|
+
- "connecting"
|
|
78
|
+
- "connected"
|
|
79
|
+
- "ready"
|
|
80
|
+
- "disconnecting"
|
|
81
|
+
- "error"
|
|
82
|
+
|
|
83
|
+
## Events
|
|
84
|
+
|
|
85
|
+
The transport implements the various [RTVI event handlers](https://docs.pipecat.ai/client/js/api-reference/callbacks). Check out the docs or samples for more info.
|
|
86
|
+
|
|
87
|
+
## Error Handling
|
|
88
|
+
|
|
89
|
+
The transport includes error handling for:
|
|
90
|
+
- Connection failures
|
|
91
|
+
- Device errors
|
|
92
|
+
- Authentication issues
|
|
93
|
+
- Message transmission problems
|
|
30
94
|
|
|
31
|
-
|
|
95
|
+
## License
|
|
96
|
+
BSD-2 Clause
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pipecat-ai/daily-transport",
|
|
3
|
-
"version": "0.3.4
|
|
3
|
+
"version": "0.3.4",
|
|
4
4
|
"license": "BSD-2-Clause",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.module.js",
|
|
@@ -21,13 +21,13 @@
|
|
|
21
21
|
"lint": "eslint . --ext ts --report-unused-disable-directives --max-warnings 0"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
24
|
-
"@pipecat-ai/client-js": "~0.3.2
|
|
24
|
+
"@pipecat-ai/client-js": "~0.3.2",
|
|
25
25
|
"eslint": "9.11.1",
|
|
26
26
|
"eslint-config-prettier": "^9.1.0",
|
|
27
27
|
"eslint-plugin-simple-import-sort": "^12.1.1"
|
|
28
28
|
},
|
|
29
29
|
"peerDependencies": {
|
|
30
|
-
"@pipecat-ai/client-js": "~0.3.2
|
|
30
|
+
"@pipecat-ai/client-js": "~0.3.2"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
33
|
"@daily-co/daily-js": "^0.73.0"
|