Configure View: Cordova/Ionic SDK – Video API

Table of Contents

Hide & Unhide Local View

Use window.EnxRtc.hideSelfView() method to hide and unhide local stream view in the running conference.

Method: hideSelfView( hide, successCallback, errorCallback )

Parameters:

  • @param {boolean} hide – true to hide and false to unhide
  • @param {CallableFunction} successCallback
  • @param {CallableFunction} errorCallback
// To hide local view
window.EnxRtc.hideSelfView(true,function (data) {
console.log('Excelsior succuss! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

// To unhide local view
window.EnxRtc.hideSelfView(false,function (data) {
console.log('Excelsior succuss! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

Hide & Unhide Remote View

Use window.EnxRtc.hideRemoteView() method to hide and unhide remote stream view in the running conference.

Method: hideRemoteView( hide, successCallback, errorCallback )

Parameters:

  • @param {boolean} hide – true to hide and false to unhide
  • @param {CallableFunction} successCallback
  • @param {CallableFunction} errorCallback
// To hide Remote view
window.EnxRtc.hideRemoteView(true,function (data) {
console.log('Excelsior succuss! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

// To unhide Remote view
window.EnxRtc.hideRemoteView(false,function (data) {
console.log('Excelsior succuss! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

Hide & Unhide Screenshare View

Use window.EnxRtc.hideScreenShareView() method to hide and unhide screen share view in the running conference.

Methods: hideScreenShareView( hide, successCallback, errorCallback )

Parameters:

  • @param {boolean} hide – true to hide and false to unhide
  • @param {CallableFunction} successCallback
  • @param {CallableFunction} errorCallback
// To hide screen share view
window.EnxRtc.hideScreenShareView(true,function (data) {
console.log('Excelsior succuss! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

// To unhide screen share view
window.EnxRtc.hideScreenShareView(false,function (data) {
console.log('Excelsior succuss! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

Hide & Unhide Canvas View

Use window.EnxRtc.hideCanvasScreen() method to hide and unhide canvas view in the running conference.

Method: hideCanvasScreen( hide, successCallback, errorCallback )

Parameters:

  • @param {boolean} hide – true to hide and false to unhide
  • @param {CallableFunction} successCallback
  • @param {CallableFunction} errorCallback
// To hide Canvas view
window.EnxRtc.hideCanvasScreen(true,function (data) {
console.log('Excelsior succuss! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

// To unhide Canvas view
window.EnxRtc.hideCanvasScreen(false,function (data) {
console.log('Excelsior succuss! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

Resize Local View

Use window.EnxRtc.resizeLocalView() method to resize the local view in the running conference.

Method: resizeLocalView( resizeOptions, successCallback, errorCallback )

Parameters:

  • @param {JSON} resizeOptions – Consists of Display attributes as given below:
    • height
    • width
    • margin_top
    • margin_left
    • margin_right
    • margin_bottom
    • position
  • @param {CallableFunction} successCallback
  • @param {CallableFunction} errorCallback
var options = {
height: 130,
width: 100,
margin_top: 50,
margin_left: 0,
margin_right: 15,
margin_bottom: 10,
position: "top"
};

window.EnxRtc.resizeLocalView(options ,function (data) {
console.log('Excelsior succuss! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

Resize Remote View

Use window.EnxRtc.resizeRemoteView() method to resize the remote view in the running conference.

Method: resizeRemoteView( resizeOptions, successCallback, errorCallback )

Parameters:

  • @param {JSON} resizeOptions – Contains display attributes as given below:
    • height
    • width
    • margin_top
    • margin_left
    • margin_right
    • margin_bottom
    • position
  • @param {CallableFunction} successCallback
  • @param {CallableFunction} errorCallback
var options = {
height: 130,
width: 100,
margin_top: 50,
margin_left: 0,
margin_right: 15,
margin_bottom: 10,
position: "center"
};

window.EnxRtc.resizeRemoteView(options ,function (data) {
console.log('Excelsior succuss! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

Receive Desired Video Quality

The Client End Point may opt to receive the desired video quality for available bandwidth. You may create UI based on the enumerated values of video quality as explained below.

Method: To set the desired video quality

setReceiveVideoQuality( videoQualityOptions, successCallback, errorCallback )

Parameters: 

  • @param {JSON} videoQualityOptions – JSON Object consisting of the following keys:
    • videoQuality: Enumerated Values: Auto, HD, SD, LD. Set it to Auto if you want EnableX to decide optimum quality for you dynamically.
    • streamType: Enumerated Values: talker, canvas
  • @param {CallableFunction} successCallback
  • @param {CallableFunction} errorCallback

var videoQualityOptions = {
streamType: “Auto”,
videoQuality: “talker”
};
window.EnxRtc.setReceiveVideoQuality(videoQualityOptions ,function (data)
{
console.log('Excelsior success! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

Method: To get currently selected video quality

getReceiveVideoQuality( streamType, successCallback, errorCallback )

Parameters:

  • @param {String} streamType - It should be talker or canvas
  • @param {CallableFunction} successCallback
  • @param {CallableFunction} errorCallback
window.EnxRtc.getReceiveVideoQuality(“talker” ,function (data) {
console.log('Excelsior success! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

Adjust Player Layout

The window.EnxRtc.adjustLayout() helps to adjust Video Player Layout in case you have received complete Active Talker View. If the user rotates Screen, this method will help Video layout to re-
adjust to fit within its Parent View.

Method: adjustLayout( successCallback, errorCallback )

Parameters:

  • @param {CallableFunction} successCallback
  • @param {CallableFunction} errorCallback
window.EnxRtc.adjustLayout(function (data) {
console.log('Excelsior success! ' + JSON.stringify(data.data));
}, function (err) {
console.log('Uh oh… error' + JSON.stringify(err));
});

← Lecture Mode

Index

Get Live Media Statistics →