@coze/realtime-api 0.0.1 → 0.0.2
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 +2 -49
- package/assets/api-overview.png +0 -0
- package/package.json +1 -1
- package/assets/realtime-console.png +0 -0
package/README.md
CHANGED
|
@@ -85,52 +85,5 @@ function setupEventListeners() {
|
|
|
85
85
|
}
|
|
86
86
|
```
|
|
87
87
|
|
|
88
|
-
##
|
|
89
|
-
|
|
90
|
-
### Prerequisites
|
|
91
|
-
1. Set up your development environment following the [coze-js](../../README.md#development-guide) guide
|
|
92
|
-
2. Ensure you have Node.js (v14+) installed
|
|
93
|
-
|
|
94
|
-
### Running the Demo
|
|
95
|
-
|
|
96
|
-
1. Navigate to the example directory:
|
|
97
|
-
|
|
98
|
-
```bash
|
|
99
|
-
rush update
|
|
100
|
-
cd examples/realtime-console
|
|
101
|
-
npm run start
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
2. Access the demo interface:
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
### Demo Features
|
|
108
|
-
1. Visit [http://localhost:3000](http://localhost:3000)
|
|
109
|
-
2. Configure your credentials in the settings panel:
|
|
110
|
-
- Access Token
|
|
111
|
-
- Bot ID
|
|
112
|
-
- Voice ID
|
|
113
|
-
- API Base URL
|
|
114
|
-
3. Optional: Use browser extensions for custom headers during testing
|
|
115
|
-
4. Grant microphone permissions when prompted
|
|
116
|
-
5. Initialize connection via the "Connect" button
|
|
117
|
-
|
|
118
|
-
### Available Operations
|
|
119
|
-
- Microphone control (toggle on/off)
|
|
120
|
-
- Bot interaction interruption
|
|
121
|
-
- Connection management
|
|
122
|
-
- Audio debugging tools:
|
|
123
|
-
- Playback device monitoring
|
|
124
|
-
- Device status logging
|
|
125
|
-
- Diagnostic features
|
|
126
|
-
|
|
127
|
-
### Monitoring
|
|
128
|
-
- Real-time event logging in the upper console
|
|
129
|
-
- Bot response display in the lower panel
|
|
130
|
-
- Detailed console logs for debugging
|
|
131
|
-
|
|
132
|
-
## Run Unit Tests
|
|
133
|
-
|
|
134
|
-
```bash
|
|
135
|
-
npm run test
|
|
136
|
-
```
|
|
88
|
+
## Example
|
|
89
|
+
For a complete working example, check out our [realtime console demo](../../examples/realtime-console).
|
package/assets/api-overview.png
CHANGED
|
Binary file
|
package/package.json
CHANGED
|
Binary file
|