Skip to content

OVI Framework Getting Started

Getting started

To start developing with the OVI, you can aquire the synergysky_ovi.js header file which you can include at the top of your WebApp. 

<script 
    src="https://synergysky.github.io/ovi/sdk/synergysky_ovi.js">
</script>
The header file will act as a off-line MOCK that allows you to simulate the CONNECT interface.

A video platform WebApp example can be viewed and copied here https://synergysky.github.io/ovi/example/example.html

Warning

Remember to remove the synergysky_ovi.js script before deploying your application for testing on the CONNECT platform. If you fail to remove the script, your web app will not work correctly.

How does it work?

First you have to provision your application URL to the OVI CONNECT API and retrive your SIP-URI. Second you will dial the given SIP-URI from your video conference endpoint.

Once the call reaches Synergy SKY CONNECT, our system opens a new browser session that loads your web app. This browser environment exposes the OVI JavaScript framework/API. You can verify the environment by querying for the synergysky JavaScript interface, confirming that the framework is available and ready for use.

From now on Synergy SKY CONNECT expect your WebApp to follow the implementation defined by OVI. Most WebApp needs minimal modification to work with OVI due to the fact that we behave like a normal user. 

---
config:
  layout: elk
  look: classic
  theme: 'forest'
---
sequenceDiagram
    autonumber
    participant vc as Video Conference Device
    participant connect as CONNECT
    participant web as WebApp implementing OVI
    vc->>+connect: Calling the SIP-URI (from OVI CONNECT API)
    connect->>-web: Launch your WebApp with OVI Framework injected

    vc-->>+connect: Interact with DTMF during call
    connect-->>-web: send CallerInteraction event to WebApp

    vc-->>+connect: Start sharing presentation on second stream
    connect-->>+web: send GetDisplayMedia event to WebApp
    web-->>-web: WebApp calls navigator.mediaDevices.getDisplayMedia()

    web-->>+connect: execute from WebApp: synergysky.endSession()
    connect-->>-vc: Send SIP BYE