VideoRTC.js

Module: VideoRTC

Methods

connect(onEvents)

It creates a new session from the Browser and the VideoGateway

Parameters:
Name Type Description
onEvents object

Connection Events: onEvents
Returns:

VideoRTC Usecases

Type
Promise.<VideoRTC>
Example
var connection = myVideoApp.connect({
    onError: cause => {},
    onDestroyed: () => {}
})
    .then(usecases => {
        // Usecases
        ...
    })
    .catch(cause => {
        console.log(cause || 'Error connecting to the VideoRTC Gateway');
    })

disconnect()

To disconnect to the VideoGateway by destroying the Connection

Returns:
Type
nothing
Example
myVideoApp.disconnect()

getBrowser()

Detects the current browser name

Returns:

Browser name: ("chrome"|"firefox",|"safari"|"opera"|"IE")

Type
string
Example
var browserName = myVideoApp.getBrowser();
console.log('Browser: ' + browserName);

getDeviceInfo()

Gets information of the current browser (type and version)

Returns:

[mobile|web] Name Version

Type
string
Example
var deviceInfo = myVideoApp.getDeviceInfo();
console.log('Device Info: ' + deviceInfo);

isConnected()

It checks if the Browser is either properly connected or not to the VideoGateway

Returns:

Returns true if it is properly connected

Type
Boolean
Example
var status = myVideoApp.isConnected();
console.log('Status: ' + status);

isMobile()

Detects if the client is either using a mobile device or not

Returns:

Mobile device

Type
Boolean
Example
var isMobile = myVideoApp.isMobile();
console.log('Is mobile: ' + isMobile);