Specification of OpenAPI
Belows are descriptions of SDK specification.
Software Architecture
![](images/sdk-swdiagram.png)
- PTTClient : Main controller of client library
- PTTChannel : PTT channel instance to manage a channel
- Group : Group instance to manage user's buddies
Model Diagram
![](images/sdk-modeldiagram.png)
- Profile : Added user. This is actually user account.
- PTTClient : Main controller of client library
- PTTChannel : PTT channel(1:1, 1:N)
- VideoChannel : Video channel to be shared in PTT channel
- Group : Buddy Group
- Organization : Company has structures of users.
- Member : User's profile link in a channel
- Buddy : User's profile link in a buddy group
- User : User's profile link in an organization
Structure
![](images/basic-structure.png)
First SDK is provisioned by a provision server. And then connect to PTT server with authentication token issued by a provision server.
Connect method has several steps to connect to server.
Authentication : through ID and password
Provision :
- Server allocation
- Version information
- Support video channel
- Homepage and FAQ URL
- Security level
Sequence Diagram
Connect/Login
![](images/connection-flow.png)
Join/Leave/Lock/Unlock Channel
![](images/ptt-flow2.png)
Subcsribe/Unsubcsribe Channel
![](images/subscribe-flow.png)
Invite Channel
![](images/invite-flow.png)
Share Video
![](images/vodeo-flow.png)