app
framewise_meet_client.app
App
WebSocket client app with decorator-based event handlers.
Source code in framewise_meet_client/app.py
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 |
|
__init__(api_key=None, host='localhost', port=8000)
Initialize the app with connection details.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
meeting_id
|
ID of the meeting to join |
required | |
api_key
|
Optional[str]
|
Optional API key for authentication |
None
|
host
|
str
|
Server hostname |
'localhost'
|
port
|
int
|
Server port |
8000
|
Source code in framewise_meet_client/app.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
|
on(event_type)
Decorator to register an event handler for a specific message type.
Resolves event aliases to standard event types.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
event_type
|
str
|
Type of event to handle (e.g., "transcript", "join") Or a UI element type (e.g., "mcq_question", "info_card") |
required |
Returns:
Type | Description |
---|---|
Decorator function |
Source code in framewise_meet_client/app.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
|
on_transcript(func=None)
Register a handler for transcript events.
Source code in framewise_meet_client/app.py
129 130 131 132 133 134 135 136 |
|
on_join(func=None)
Register a handler for user join events.
Source code in framewise_meet_client/app.py
138 139 140 141 142 143 |
|
on_exit(func=None)
Register a handler for user exit events.
Source code in framewise_meet_client/app.py
145 146 147 148 149 150 |
|
on_custom_ui_response(func=None)
Register a handler for custom UI element response events.
Source code in framewise_meet_client/app.py
152 153 154 155 156 157 |
|
on_invoke(func=None)
Register a handler for invoke events (triggered by final transcripts).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
func
|
Callable[[TranscriptMessage], Any]
|
Function that takes a TranscriptMessage and processes the event |
None
|
Source code in framewise_meet_client/app.py
159 160 161 162 163 164 165 166 167 168 |
|
invoke(func=None)
Alias for on_invoke for convenience.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
func
|
Callable[[TranscriptMessage], Any]
|
Function that takes a TranscriptMessage and processes the event |
None
|
Source code in framewise_meet_client/app.py
170 171 172 173 174 175 176 |
|
send_generated_text(text, is_generation_end=False)
Send generated text to the server.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text
|
str
|
The generated text |
required |
is_generation_end
|
bool
|
Whether this is the end of generation |
False
|
Source code in framewise_meet_client/app.py
178 179 180 181 182 183 184 185 186 187 188 189 |
|
send_custom_ui_element(ui_type, data)
Send a custom UI element to the server.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ui_type
|
str
|
Type of UI element (e.g., 'mcq_question') |
required |
data
|
Dict[str, Any]
|
Element-specific data |
required |
Source code in framewise_meet_client/app.py
191 192 193 194 195 196 197 198 199 200 201 202 |
|
send_mcq_question(question_id, question, options)
Send an MCQ question as a custom UI element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
question_id
|
str
|
Unique identifier for the question |
required |
question
|
str
|
The question text |
required |
options
|
List[str]
|
List of answer options |
required |
Source code in framewise_meet_client/app.py
204 205 206 207 208 209 210 211 212 213 214 215 216 |
|
run(auto_reconnect=True, reconnect_delay=5, log_level=None)
Run the application (blocking).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
auto_reconnect
|
bool
|
Whether to automatically reconnect on disconnect |
True
|
reconnect_delay
|
int
|
Delay between reconnection attempts in seconds |
5
|
log_level
|
str
|
Optional log level to set (DEBUG, INFO, WARNING, ERROR, CRITICAL) |
None
|
Source code in framewise_meet_client/app.py
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
|
_register_default_handlers()
Register default handlers for important system events if not already registered.
Source code in framewise_meet_client/app.py
263 264 265 266 267 268 269 270 271 272 273 |
|
stop()
Stop the application.
Source code in framewise_meet_client/app.py
275 276 277 278 279 280 281 |
|
create_meeting(meeting_id, start_time=None, end_time=None)
Create a meeting with the given parameters.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
meeting_id
|
str
|
Unique identifier for the meeting |
required |
start_time
|
Start time of the meeting as datetime object (defaults to current time) |
None
|
|
end_time
|
End time of the meeting as datetime object (defaults to 1 hour from start) |
None
|
Source code in framewise_meet_client/app.py
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 |
|
on_ui_type(ui_type)
Register a handler for a specific UI element type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ui_type
|
str
|
UI element type to handle (e.g., 'mcq_question', 'info_card') |
required |
Returns:
Type | Description |
---|---|
Decorator function |
Source code in framewise_meet_client/app.py
327 328 329 330 331 332 333 334 335 336 337 |
|
send_notification(message, level='info', duration=8000)
Send a notification to all users in the meeting.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
message
|
str
|
The notification message to display |
required |
level
|
str
|
The notification level (info, warning, error, success) |
'info'
|
duration
|
int
|
How long the notification should display (in milliseconds) |
8000
|
Source code in framewise_meet_client/app.py
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 |
|
on_connection_rejected(func=None)
Register a handler for connection rejection events.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
func
|
Callable[[ConnectionRejectedMessage], Any]
|
Function that takes a ConnectionRejectedMessage and processes it |
None
|
Source code in framewise_meet_client/app.py
357 358 359 360 361 362 363 364 365 366 |
|