⌘
K
Overview
Hosted Experience
Sequence Diagram
Getting Started
Securing your experience
Configuration Options
Events
Methods
Migration Guide
MiniPrem
Custom Voice
Synapse
Synapse BYO Conversation Endpoint - Specification
Frequently Asked Questions
Announcements
Push to Talk Deprecation Notice
Feature: Enhanced Speech Recognition
Docs powered by
Archbee
Hosted Experience
Sequence Diagram
1min
1
sequenceDiagram
2
participant Client
3
participant SDK
4
participant API_Server
5
participant Socket_Server
6
participant Renderer
7
participant TURN_Server
8
9
Client -> SDK: Click Button / Initiate Function
10
activate SDK
11
SDK -> API_Server: HTTP Request (Start Session)
12
activate API_Server
13
API_Server -> Socket_Server: Check Renderer Availability
14
activate Socket_Server
15
Socket_Server -> API_Server: Renderer Ready
16
deactivate Socket_Server
17
API_Server -> SDK: Session Details (Renderer Info)
18
deactivate API_Server
19
SDK -> Renderer: Initiate WebRTC Connection
20
activate Renderer
21
22
alt Direct Connection Possible
23
Client
<
--
>
Renderer: WebRTC Media Stream (P2P)
24
else NAT/Firewall Detected
25
Client
<
--
>
TURN_Server: WebRTC Media Stream (TURN)
26
TURN_Server
<
--
>
Renderer: WebRTC Media Stream (TURN)
27
end
28
29
SDK
<
--
>
Socket_Server: Secure Socket Connection (Control Messages)
sequenceDiagram participant Client participant SDK participant API_Server participant Socket_Server participant Renderer participant TURN_Server Client -> SDK: Click Button / Initiate Function activate SDK SDK -> API_Server: HTTP Request (Start Session) activate API_Server API_Server -> Socket_Server: Check Renderer Availability activate Socket_Server Socket_Server -> API_Server: Renderer Ready deactivate Socket_Server API_Server -> SDK: Session Details (Renderer Info) deactivate API_Server SDK -> Renderer: Initiate WebRTC Connection activate Renderer alt Direct Connection Possible Client <--> Renderer: WebRTC Media Stream (P2P) else NAT/Firewall Detected Client <--> TURN_Server: WebRTC Media Stream (TURN) TURN_Server <--> Renderer: WebRTC Media Stream (TURN) end SDK <--> Socket_Server: Secure Socket Connection (Control Messages)
Renderer can be a separate server or a process managed by the API/Socket Server.
PREVIOUS
Hosted Experience
NEXT
Getting Started
Docs powered by
Archbee
Docs powered by
Archbee