Give us feedback
vonage-videoexpress
Reactive icon

Vonage Video

Stable version 2.0.0 (Compatible with OutSystems 11)
Published on 9 May by 
5.0
 (1 rating)
vonage-videoexpress

Vonage Video

Documentation
2.0.0

VONAGE VIDEO

Topics:

  • Vonage
  • Getting started
  • Vonage_Video_Plug
  • Authorization
  • VideoBlock
  • Webblocks
  • BottomBar
  • Chat
  • Controls
  • LeaveSession
  • Participants
  • Screensharing
  • Settings
  • TopBar


VONAGE – GETTING STARTED

To use the LINKIT Vonage components, you’ll need to create a Vonage account: https://www.tokbox.com/account/user/signup

Creating an account will give you some credits as well as a personal API Key and API Secret.

You need these to get your application up and running.


VONAGE VIDEO – AUTHORIZATION

Inside the Vonage_Video_Plug module, we have created two site properties; one for the API Key and one for the API Secret.

Both are needed for proper authorization.


VONAGE VIDEO – VIDEO BLOCK

This is an umbrella block for all the granular webblocks. The video block is responsible for creating the Vonage Room Object which is very important for the initialization of the Room.

All the associated block features work with the Room Object. Basic room configuration can be set with the available input parameters.

The block checks the availability of the media devices before the room creation. Managing the room object and the participant object at the global scope is taken care of by the implementation defined in the VideoBlock scope. This block also exposes few events to have a communication with the parent Screen on certain event invocations.

In the screen scope this is the only important block which needs to be referenced to make the workflow possible.

The block references the underlying VideoExpress and Vonage JS libraries from the local directory to make the functionality run.


VONAGE VIDEO - WEBBLOCKS

To create your own Vonage Video application, you can use and choose from the several webblocks we’ve created. Each one comes with its own client actions.


VONAGE VIDEO – BOTTOM BAR

The BottomBar webblock has been created to give you an idea of how to build your own Vonage Video application.

The BottomBar webblock has no logic in itself, except for some Events, but contains of five other webblocks.

It needs three input parameters to be assigned from the screen level, based on the user preferences. Based on the input, the control icons will be displayed.


VONAGE VIDEO – CHAT

The Chat webblock is optional. It can add a basic (1 to 1 and 1 to many) chat functionality to your application.

The two mandatory input parameters are to be assigned from the videoblock. The chat section contains a dynamic user dropdown.




VONAGE VIDEO – CONTROLS

There are three webblocks for adjusting Controls. The Recording webblock is optional.

Each control webblock has an input parameter which is to be assigned from the videoblock.


VONAGE VIDEO – LEAVE SESSION

The LeaveSession webblock just invokes the event to leave the session for the end user.


VONAGE VIDEO – PARTICIPANTS

The Participant webblock is optional. It is used to display the list of joined participants. It will show a count of participants.

It has two input parameters to be assigned from the VideoBlock. They are the same as for the Chat webblock.


VONAGE VIDEO – SCREENSHARING

The Screensharing webblock is optional. It can enhance your application with a functionality to share your screen.



VONAGE VIDEO – SETTINGS

The Settings webblock gives the end user the possibility to select the in use media devices.

It also has an option to set a notification tone for joining participants.


VONAGE VIDEO – TOPBAR

The TopBar webblock has an option to change the layout mode; Gallery (grid) or Dominant (active speaker) view.