Project

General

Profile

Edit History

WebRTC » History » Version 5

Saúl Ibarra Corretgé, 07/30/2015 04:21 PM

1 1 Saúl Ibarra Corretgé 
h1. SylkServer WebRTC gateway application
2 





    3
    2
    Saúl  Ibarra Corretgé
    
Starting with version 3.0.0 SylkServer includes a WebRTC gateway application. The application implements a WebSocket protocol which WebRTC endpoints can use in order to interact with the SIP world.





    4
    
    
    





    5
    
    
    





    6
    
    
    
h2. Architecture





    7
    
    
    





    8
    1
    Saúl  Ibarra Corretgé
    
TODO





    9
    2
    Saúl  Ibarra Corretgé
    





    10
    
    
    
h2. WebSocket API





    11
    
    
    





    12
    5
    Saúl  Ibarra Corretgé
    
SylkServer offers the WebSocket API in order to interact with the WebRTC gateway in the @ws(s)://hostname:port/webrtcgateway/ws@ endpoint. Both WebSocket and Secure WebSocket are supported, depending on how SylkServer was configured, check the configuration section.





    13
    1
    Saúl  Ibarra Corretgé
    





    14
    5
    Saúl  Ibarra Corretgé
    
The following API is modeled around 2 concepts: requests and events.





    15
    
    
    





    16
    
    
    
A request represents an action which SylkServer should perform, and it's identified with a transaction ID which the user must provide. SylkServer will reply with either an 'ack' or an 'error' response, with the associated transaction ID. An example transaction is that of adding an account.





    17
    
    
    





    18
    
    
    
Events are notifications sent by SylkServer to the client. They are the result of some change triggered by a user action, but they don't have a transaction ID associated with them. An example event would be the connection state changed event.





    19
    
    
    





    20
    
    
    





    21
    
    
    
h3. Establishing the connection





    22
    
    
    





    23
    
    
    
TODO





    24
    
    
    





    25
    
    
    
h3. Account management





    26
    
    
    





    27
    
    
    
TODO





    28
    
    
    





    29
    
    
    
h3. Calling





    30
    
    
    





    31
    
    
    
TODO





    32
    
    
    





    33
    
    
    





    34
    2
    Saúl  Ibarra Corretgé
    





    35
    4
    Saúl  Ibarra Corretgé
    
h2. Configuration





    36
    
    
    





    37
    
    
    
TODO





    38
    
    
    





    39
    2
    Saúl  Ibarra Corretgé
    
h2. Client libraries





    40
    
    
    





    41
    
    
    
In order to interact with SylkServer's WebRTC gateway, we provide the "sylkrtc.js":http://projects.ag-projects.com/projects/sylkrtc JavaScript library. It implements the API described in this document in an easy to use manner. Check the README file in the project for the JavaScript API documentation.