Expand description
JSON wire envelopes and signaling payloads
this facade contains the serialized protocol contract exchanged over the WebSocket browser and native hosts should share these types instead of duplicating envelope names or request payload shapes
Structs§
- Auth
Payload - Available
Features - room capabilities advertised to a newly connected browser client
- Client
Broadcast Payload - Download
States - receiver intent for which streams to download from one peer
- Envelope
- Negotiation
Upload Encoding - Negotiation
Upload Slot - Peer
Info Payload - Peer
Left Payload - Peer
Snapshot - full peer entry sent when a client needs the current room membership view
- Recording
Action Result - Recording
Options - recording modes requested by a user
- Recording
State - current room recording state as shown to call participants
- Recording
State Update - recording state update emitted to clients and observers
- Request
Id - Server
Broadcast Payload - Session
Description Payload - Source
Descriptor - Source
Encoding Descriptor - Stream
Intent Payload - Subscribe
Payload - Track
Binding - User
Info - presence and call UI state associated with one room participant
- User
Permissions - user-level permissions supplied by the Odoo authentication path
- Welcome
Payload
Enums§
- Client
Envelope - Client
Message - Client
Request - Client
Response - Envelope
Batch Decode Error - Envelope
Decode Error - Server
Envelope - Server
Message - Server
Request - Server
Response - Stop
Code - business reason attached to a recording stop update
- Stream
Type - stream category exposed to Odoo clients
- Upload
Layer Policy Role - UserId
- user identity as accepted by the Odoo-facing call contract
- Video
Layout Intent - receiver-side layout role for a video stream
- WebSocket
Close Code - websocket close code vocabulary shared by server and browser protocol code
Constants§
Functions§
- decode_
envelope_ batch - Decode a websocket envelope batch while preserving route validation errors and checking a caller-provided batch limit before route conversion.
Type Aliases§
- Envelope
Batch - Json
Payload - opaque compatibility payload carried through legacy broadcast paths